mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
3b6ec24108
* fix README.md * fix README.md * fix examples.md * fix CONTRIBUTING.md * Update README.md
68 lines
2.7 KiB
Markdown
Vendored
68 lines
2.7 KiB
Markdown
Vendored
# OpenBB Platform CLI
|
|
|
|
[](https://pepy.tech/project/openbb)
|
|
[](https://github.com/OpenBB-finance/OpenBB)
|
|
|
|
| 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](www.openbb.co) |
|
|
|
|
## Overview
|
|
|
|
The OpenBB Platform CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform).
|
|
|
|
It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automated data collection via OpenBB Routine Scripts.
|
|
|
|
Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://docs.openbb.co/cli).
|
|
|
|
## Installation
|
|
|
|
The command below provides access to all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions).
|
|
|
|
```bash
|
|
pip install openbb-cli
|
|
```
|
|
|
|
> Note: Find the most complete installation hints and tips [here](https://docs.openbb.co/cli/installation).
|
|
|
|
After the installation is complete, you can deploy the OpenBB Platform CLI by running the following command:
|
|
|
|
```bash
|
|
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:
|
|
|
|
1. OpenBB Hub
|
|
2. Local file
|
|
|
|
### 1. OpenBB Hub
|
|
|
|
Set your keys at [OpenBB Hub](https://my.openbb.co/app/platform/credentials) 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:
|
|
|
|
```json
|
|
{
|
|
"credentials": {
|
|
"fmp_api_key": "REPLACE_ME",
|
|
"polygon_api_key": "REPLACE_ME",
|
|
"benzinga_api_key": "REPLACE_ME",
|
|
"fred_api_key": "REPLACE_ME"
|
|
}
|
|
}
|
|
```
|