mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00

Files

Henrique Joaquim c2f5f7a3e6 [Feature] Styling adjustments (#6408 )

* styling adjustments

* auto completion for main menu commands; cached results style

* move platform settings above

* don't check if obbject.results - we want to have the error message if smt goes wrong with the to_df()

* register only if there are results

* minor style change

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>

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

openbb_cli

[Feature] Styling adjustments (#6408 )

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

tests

[Feature] - Rename terminal folder (#6349 )

2024-04-30 12:42:31 +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"
  }
}