启动 OpenBB CLI

  1. 打开终端，激活安装 openbb-cli 的 Python 环境。
  2. 在命令行输入：
    1. openbb

CLI 主页

登录

登录到 OpenBB Hub 账户 以在会话中添加存储的 API 密钥。

  1. /account/login --pat REPLACE_WITH_YOUR_PAT

提示
使用 --remember-me 选项可以保持登录状态，直到手动登出。

也可以使用电子邮件和密码登录：

  1. /account/login --email my@emailaddress.com --password n0Ts3CuR3L!kEPAT

所有数据提供商可在 这里 查看，API 密钥管理可在 OpenBB Hub 进行。

菜单导航

信息
菜单项在屏幕左侧显示 > 符号，输入菜单名称并回车即可进入该菜单。例如：

  1. economy

经济菜单

返回上一级菜单

输入以下命令返回父级菜单：

  1. ..

或

  1. q

返回主页

输入以下命令返回主菜单：

  1. /

或

  1. home

直接跳转到指定菜单

使用绝对路径导航，例如：

从：

  1. /equity/calendar/earnings

跳转到：

  1. /economy/calendar

使用命令

命令与菜单的区别在于，它们不会带有 > 符号，且显示颜色较浅。

不同功能的命令参数各不相同，可使用 --help 选项查看详细信息。例如：

  1. calendar --help

传递参数

参数格式为 --argument value，布尔参数（true/false）无需赋值，仅输入 --argument 即可切换状态。

错误示例（不支持位置参数）：

  1. ❌ historical AAPL --start_date 2024-01-01

正确示例：

  1. ✅ historical --symbol AAPL --start_date 2024-01-01

命令自动补全

在命令或参数后按 space 触发自动补全。例如：

  1. historical --symbol AAPL --start_date 2024-01-01 --

自动补全

数据处理命令

某些扩展（如 openbb-technical）接受 --data 作为输入。

提示
命令输出会被缓存，可使用 results 命令查看，并用 --data 选择数据。

  1. # 获取股票历史价格数据
  2. /equity/price/historical --symbol SPY --start_date 2024-01-01 --provider yfinance
  4. # 查看缓存的结果
  5. results
  7. # 使用缓存数据计算 RSI 并绘图
  8. /technical/rsi --data OBB0 --chart

快速开始 - 图4

获取帮助信息

在命令后加 --help 或 -h 可查看详细帮助。例如：

  1. calendar --help

示例：

  1. usage: calendar [--start_date START_DATE] [--end_date END_DATE] [--provider {fmp,nasdaq,tradingeconomics}]
  2.                 [--country COUNTRY] [--importance {Low,Medium,High}] [-h]

如果使用 --provider nasdaq，则 --importance 和 --group 参数将被忽略。

示例：

  1. /economy/calendar --provider nasdaq --country united_states

数据导出

数据可以导出为 CSV、JSON 或 XLSX，并可从交互式表格和图表中导出。

指定文件名导出

  1. /equity/search --provider nasdaq --export nasdaq_directory.csv

输出：

  1. Saved file: /Users/myusername/OpenBBUserData/nasdaq_directory.csv

未指定文件名导出

如果仅指定格式，则文件名将以时间戳命名。

  1. /equity/search --provider nasdaq --export csv

输出：

  1. Saved file: /Users/myusername/OpenBBUserData/20240508_145308_controllers_search.csv

指定 Excel 工作表名称

多个导出可以存储在同一个 .xlsx 文件的不同 Sheet 中。

  1. /equity/search --provider nasdaq --export directory.xlsx --sheet-name nasdaq

运行多个命令

使用 / 连接多个命令，使其在一行中执行。例如：

  1. /equity/price/historical --symbol AAPL,MSFT,GOOGL,AMZN,META,NVDA,NFLX,TSLA,QQQ --start_date 2022-01-01 --provider yfinance --chart
  2. /performance --symbol AAPL,MSFT,GOOGL,AMZN,META,NVDA,NFLX,TSLA,QQQ --provider finviz --chart

运行示例 Routine 脚本

  1. /exe --example