mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 20:42:26 +00:00

Files

Henrique Joaquim 8d060dc071 [Feature] CLI docs (#6362 )

* cli docs website

* changes

* remove unused feat flags

* typo

* yeet stuff that can't be used

* some progress

* Add home screenshot

* screenshots.md

* fix links

* new cards for cli pages

* start config page

* more updates

* Add screenshots

* flatten some things.

* fix link

* some more updates

* some routine stuff

* codespell

* cli color

* results in the global commands

* increase codeBlock line-height

* remove platform warning, obb is a class

* minor change, danger warning

* typo?

* Data processing commands

---------

Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

2024-05-14 15:44:07 +00:00

openbb_cli

[Feature] CLI docs (#6362 )

2024-05-14 15:44:07 +00:00

tests

[Feature] - OpenBB Platform CLI Unit tests (#6397 )

2024-05-14 15:38:06 +00:00

poetry.lock

[Feature] Update CLI dependencies (#6389 )

2024-05-13 07:51:16 +00:00

pyproject.toml

[Feature] Update CLI dependencies (#6389 )

2024-05-13 07:51:16 +00:00

README.md

[Feature] CLI README (#6402 )

2024-05-13 17:14:18 +00:00

README.md

OpenBB Platform CLI

OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere.

Check our website at openbb.co

Overview

The OpenBB CLI is a command line interface that wraps OpenBB Platform.

It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts.

Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI here.

Installation

The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list here.

pip install openbb-cli

Note: Find the most complete installation hints and tips here.

After the installation is complete, you can deploy the OpenBB CLI by running the following command:

openbb

Which should result in the following output:

API keys

To fully leverage the OpenBB Platform you need to get some API keys to connect with data providers. Here are the 3 options on where to set them:

OpenBB Hub
Local file

1. OpenBB Hub

Set your keys at OpenBB Hub and get your personal access token from https://my.openbb.co/app/platform/pat to connect with your account.

Once you log in, on the Platform CLI (through the /account menu, all your credentials will be in sync with the OpenBB Hub.)

2. Local file

You can specify the keys directly in the ~/.openbb_platform/user_settings.json file.

Populate this file with the following template and replace the values with your keys:

{
  "credentials": {
    "fmp_api_key": "REPLACE_ME",
    "polygon_api_key": "REPLACE_ME",
    "benzinga_api_key": "REPLACE_ME",
    "fred_api_key": "REPLACE_ME"
  }
}