From 8d060dc0717e2ce9cde06ffc7523ea465c920a0e Mon Sep 17 00:00:00 2001 From: Henrique Joaquim Date: Tue, 14 May 2024 16:44:07 +0100 Subject: [PATCH] [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 --- .../controllers/settings_controller.py | 3 - website/content/cli/_category_.json | 4 + website/content/cli/commands-and-arguments.md | 76 ++++++ website/content/cli/configuration.md | 66 +++++ website/content/cli/data-sources.md | 113 ++++++++ website/content/cli/hub.md | 111 ++++++++ website/content/cli/index.md | 78 ++++++ website/content/cli/installation.md | 76 ++++++ website/content/cli/interactive-charts.md | 109 ++++++++ website/content/cli/interactive-tables.md | 75 ++++++ website/content/cli/openbbuserdata.md | 59 +++++ website/content/cli/quickstart.md | 243 ++++++++++++++++++ website/content/cli/routines/_category_.json | 4 + .../content/cli/routines/advanced-routines.md | 119 +++++++++ .../cli/routines/community-routines.md | 52 ++++ website/content/cli/routines/index.mdx | 31 +++ .../cli/routines/introduction-to-routines.md | 130 ++++++++++ .../cli/routines/routine-macro-recorder.md | 46 ++++ .../content/cli/structure-and-navigation.md | 42 +++ website/content/platform/installation.md | 9 - website/package-lock.json | 7 +- website/sidebars.js | 5 + .../components/General/NewReferenceCard.tsx | 5 +- .../theme/CodeBlock/Content/styles.module.css | 1 + .../theme/DocSidebarItem/Category/index.js | 1 + website/src/theme/Navbar/Layout/index.js | 12 + 26 files changed, 1458 insertions(+), 19 deletions(-) create mode 100644 website/content/cli/_category_.json create mode 100644 website/content/cli/commands-and-arguments.md create mode 100644 website/content/cli/configuration.md create mode 100644 website/content/cli/data-sources.md create mode 100644 website/content/cli/hub.md create mode 100644 website/content/cli/index.md create mode 100644 website/content/cli/installation.md create mode 100644 website/content/cli/interactive-charts.md create mode 100644 website/content/cli/interactive-tables.md create mode 100644 website/content/cli/openbbuserdata.md create mode 100644 website/content/cli/quickstart.md create mode 100644 website/content/cli/routines/_category_.json create mode 100644 website/content/cli/routines/advanced-routines.md create mode 100644 website/content/cli/routines/community-routines.md create mode 100644 website/content/cli/routines/index.mdx create mode 100644 website/content/cli/routines/introduction-to-routines.md create mode 100644 website/content/cli/routines/routine-macro-recorder.md create mode 100644 website/content/cli/structure-and-navigation.md diff --git a/cli/openbb_cli/controllers/settings_controller.py b/cli/openbb_cli/controllers/settings_controller.py index 8783ef47e1b7..f93501a5063f 100644 --- a/cli/openbb_cli/controllers/settings_controller.py +++ b/cli/openbb_cli/controllers/settings_controller.py @@ -21,10 +21,7 @@ class SettingsController(BaseController): CHOICES_COMMANDS: List[str] = [ "interactive", "cls", - "watermark", "promptkit", - "thoughts", - "reporthtml", "exithelp", "rcontext", "richpanel", diff --git a/website/content/cli/_category_.json b/website/content/cli/_category_.json new file mode 100644 index 000000000000..a68e9f9ff3b4 --- /dev/null +++ b/website/content/cli/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "OpenBB CLI", + "position": 2 +} diff --git a/website/content/cli/commands-and-arguments.md b/website/content/cli/commands-and-arguments.md new file mode 100644 index 000000000000..709b73f3bc95 --- /dev/null +++ b/website/content/cli/commands-and-arguments.md @@ -0,0 +1,76 @@ +--- +title: Commands And Arguments +sidebar_position: 4 +description: This page explains how to enter commands and arguments into the OpenBB CLI. +keywords: +- help arguments +- auto-complete +- global commands +- support command +- reset command +- command line interface +- metadata +- cli +- parameters +- functions +- commands +- options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Commands are displayed on-screen in a lighter colour, compared with menu items, and they will not be prefaced with, `>`. + +Functions have a variety of parameters that differ by endpoint and provider. The --help dialogue will provide guidance on nuances of any particular command. + +The available data sources for each command are displayed on the right side of the screen, and are selected with the `--provider` argument. + +## Help arguments + +The `help` command shows the current menu. The screen will display all the commands and menus that exist, including a short description for each of these. + +Adding `--help`, or `-h`, to any command will display the description and parameters for that particular function. + +## Entering Parameters + +Parameters are all defined through the same pattern, --argument, followed by a space, and then the value. + +If the parameter is a boolean (true/false), there is no value to enter. Adding the --argument flags the parameter to be the opposite of its default state. + +Use the auto-complete to prompt choices and reduce the amount of keystrokes required to run a complex function. + +## Auto-complete + +The OpenBB CLI is equipped with an auto completion engine that presents choices based on the current menu and command. Whenever you start typing, suggestion prompts will appear for existing commands and menus. When the command contains arguments, pressing the `space bar` after typing the command will present the list of available arguments. + +This functionality dramatically reduces the number of key strokes required to perform tasks and, in many cases, eliminates the need to consult the help dialogue for reminders. Choices - where they are bound by a defined list - are scrollable with the up and down arrow keys. + +## Global commands + +These are commands that can be used throughout the CLI and will work regardless of the menu where they belong. + +### Help + +`--help`, or `-h` can be attached to any command, as described above. + +### CLS + +The `cls` command clears the entire CLI screen. + +### Quit + +The `quit` command (can also use `q` or `..`) allows to leave the current menu to go one menu above. If the user is on the root, that will mean leaving the CLI. + +### Exit + +The `exit` command allows the user to exit the CLI. + +### Reset + +The `reset` command will reset the CLI to its default state. This is specially useful for development so you can refresh the CLI without having to close and open it again. + +### Results + +The `results` command will display the stack of `OBBjects` that have been generated during the session, which can be later injected on the data processing commands. diff --git a/website/content/cli/configuration.md b/website/content/cli/configuration.md new file mode 100644 index 000000000000..360aebae253f --- /dev/null +++ b/website/content/cli/configuration.md @@ -0,0 +1,66 @@ +--- +title: Configuration & Settings +sidebar_position: 5 +description: This documentation page details the various settings and feature flags used to customize the OpenBB CLI. +keywords: +- Settings Menu +- Feature Flags Menu +- customize CLI +- alter CLI behaviour +- environment variables +- Documentation +- OpenBB Platform CLI +- preferences +- user +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +In addition to the OpenBB Platform's `user_settings.json` file, described [here](/platform/usage/settings_and_environment_variables), there are settings and environment variables affecting the CLI only. + +:::important +API credentials are defined in the `user_settings.json` file. + +Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). + +Define default data sources by following the pattern outlined [here](data-sources) +::: + +## Settings Menu + +The `/settings` menu provides methods for customizing the look and feel of the CLI. The menu is divided into two sections: + +- Feature Flags + - On/Off status is reflected by red/green text. + - Status is toggled by entering the item as a command. +- Preferences + - Choices and options will be presented as a typical function. + +### Feature Flags + +| Feature Flags | Description | +| :----------- | :--------------------------------------------------------------- | +| `interactive` | Enable/disable interactive tables. Disabling prints the table directly on the CLI screen. | +| `cls` | Clear the screen after each command. Default state is off. | +| `promptkit` | Enable auto complete and history. Default state is on. | +| `richpanel` | Displays a border around menus. Default state is on. | +| `tbhint` | Display usage hints in the bottom toolbar. Default state is on. | +| `exithelp` | Automatically print the screen after navigating back one menu. Default state is off. | +| `overwrite` | Automatically overwrite exported files with the same name. Default state is off. | +| `obbject_msg` | Displays a message whenever a new result is added to the registry. Default state is off. | +| `version` | Displays the currently installed version number in the bottom right corner. | + +### Preferences + +| Preferences | Description | +| :----------- | :--------------------------------------------------------------- | +| `console_style` | apply a custom rich style to the CLI | +| `flair` | choose flair icon | +| `timezone` | pick timezone | +| `language` | translation language | +| `n_rows` | number of rows to show on non interactive tables | +| `n_cols` | number of columns to show on non interactive tables | +| `obbject_res` | define the maximum number of obbjects allowed in the registry | +| `obbject_display` | define the maximum number of cached results to display on the help menu | diff --git a/website/content/cli/data-sources.md b/website/content/cli/data-sources.md new file mode 100644 index 000000000000..f6bd3a0d7626 --- /dev/null +++ b/website/content/cli/data-sources.md @@ -0,0 +1,113 @@ +--- +title: Data Sources +sidebar_position: 7 +description: This page explains how to select a provider for any specific command, and set a default source for a route. +keywords: +- Terminal +- CLI +- provider +- API keys +- FinancialModelingPrep +- Polygon +- AlphaVantage +- Intrinio +- YahooFinance +- source +- data +- default +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Many commands have multiple data sources associated with it. This page describes how to select from multiple providers. + +:::important +API credentials are defined in the `user_settings.json` file. + +Find all data providers [here](/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). +::: + +## Data Source In-Command + +To specify the data vendor for that particular command, use the `--provider` argument. + +Parameter choices can be viewed from the help dialogue, `-h` or `--help`. + +```console +/equity/price/historical -h +``` + +```console +usage: historical --symbol SYMBOL [SYMBOL ...] [--interval INTERVAL] [--start_date START_DATE] [--end_date END_DATE] [--chart] + [--provider {fmp,intrinio,polygon,tiingo,yfinance}] [--start_time START_TIME] [--end_time END_TIME] [--timezone TIMEZONE] + [--source {realtime,delayed,nasdaq_basic}] [--sort {asc,desc}] [--limit LIMIT] [--extended_hours] [--include_actions] + [--adjustment {splits_and_dividends,unadjusted,splits_only}] [--adjusted] [--prepost] [-h] [--export EXPORT] + [--sheet-name SHEET_NAME [SHEET_NAME ...]] + +Get historical price data for a given stock. This includes open, high, low, close, and volume. + +options: + --interval INTERVAL Time interval of the data to return. + --start_date START_DATE + Start date of the data, in YYYY-MM-DD format. + --end_date END_DATE End date of the data, in YYYY-MM-DD format. + --chart Whether to create a chart or not, by default False. + --provider {fmp,intrinio,polygon,tiingo,yfinance} + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'fmp' if there is + no default. + --extended_hours Include Pre and Post market data. (provider: polygon, yfinance) + --adjustment {splits_and_dividends,unadjusted,splits_only} + The adjustment factor to apply. Default is splits only. (provider: polygon, yfinance) + -h, --help show this help message + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. + +required arguments: + --symbol SYMBOL [SYMBOL ...] + Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, polygon, tiingo, yfinance. + +intrinio: + --start_time START_TIME + Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. + --end_time END_TIME Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. + --timezone TIMEZONE Timezone of the data, in the IANA format (Continent/City). + --source {realtime,delayed,nasdaq_basic} + The source of the data. + +polygon: + --sort {asc,desc} Sort order of the data. This impacts the results in combination with the 'limit' parameter. The results are always returned in ascending order by date. + --limit LIMIT The number of data entries to return. + +yfinance: + --include_actions Include dividends and stock splits in results. +``` + +:::note +Provider-specific parameters are listed at the bottom of the print out. They are ignored when entered, if it is not supported by the selected provider. +::: + +## Setting The Default Source + +The default data source for each command (where multiple sources are available) can be defined within the user configuration file: `/home/your-user/.openbb_platform/user_settings.json`. + +Set the default data provider for the `/equity/price/historical` command by adding the following line to your `user_settings.json` file: + +```json +{ + "defaults": { + "routes": { + "/equity/price/historical": { + "provider": "fmp" + }, + "/equity/fundamental/balance": { + "provider": "polygon" + }, + ... + } + } +} +``` diff --git a/website/content/cli/hub.md b/website/content/cli/hub.md new file mode 100644 index 000000000000..d7e77fd9e63c --- /dev/null +++ b/website/content/cli/hub.md @@ -0,0 +1,111 @@ +--- +title: Hub Synchronization +sidebar_position: 6 +description: This page outlines the `/account` menu within the OpenBB CLI, and integrations with the OpenBB Hub. +keywords: +- OpenBB Platform CLI +- OpenBB Hub +- Registration +- Login process +- API Keys management +- Theme +- Style +- Dark +- Light +- Script Routines +- Personal Access Tokens +- PAT +- Credentials +- Customization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This page outlines the `/account` menu within the OpenBB CLI and integrations with the OpenBB Hub. + +## Registration + +To get started, you'll need to create an account on the OpenBB Hub by visiting [https://my.openbb.co](https://my.openbb.co) + +By registering with the OpenBB Hub, you can easily access our products on multiple devices and maintain consistent settings for an improved user experience. + +## Login + +Once you're successfully registered on the OpenBB Hub, you can log in to access all the benefits it has to offer. + +:::tip +OpenBB recommends logging in via the Personal Access Token (PAT) method. This revokable token allows users to login without transmitting any personally identifiable information, like an email address, which makes it an ideal solution for shared machines and public network connections. +::: + +To login, enter the `/account` menu and then use the `login` command with your choice of login method. + +### PAT + +```console +/account +login --pat REPLACE_WITH_PAT +``` + +### Email & Password + +```console +/account +login --email my@emailaddress.com --password totallysecurepassword +``` + +## API Keys + +The OpenBB Platform acts as a mediator between users and data providers. + +With an OpenBB Hub account, you can manage your API keys on [this page](https://my.openbb.co/app/platform/credentials). + +Upon logging in, the CLI will automatically retrieve the API keys associated with your account. + +If you have not saved them on the OpenBB Hub, they will be loaded from your local environment by default. + +:::danger +If an API key is saved on the OpenBB Hub, it will take precedence over the local environment key. +::: + +The CLI will need to be restarted, or refreshed, when changes are made on the Hub. + +## Theme Styles + +Theme styles correspond to the ability to change the terminal "skin" (i.e. coloring of the `menu`, `commands`, `data source`, `parameters`, `information` and `help`), as well as the chart and table styles. + +In the OpenBB Hub, you can select the text colours for the CLI. After customizing: +- Download the theme to your styles directory (`/home/your-user/OpenBBUserData/styles/user`). +- Apply it by selecting the style from the `/settings` menu. + +```console +/settings +console_style -s openbb_config +``` + +Replace `openbb_config` with the name of the downloaded (JSON) file. + +## Script Routines + +The OpenBB Hub allows users to create, edit, manage, and share their script routines that can be run in the OpenBB Platform CLI. + +The "Download" button will save the file locally. Add it to `/home/your-user/OpenBBUserData/routines`, for the script to populate as a choice for the `exe` command on next launch. + +## Refresh + +The `refresh` command will update any changes without the need to logout and login. + +```console +/account +refresh +``` + +## Logout + +Logging out will restore any local credentials and preferences defined in the `user_settings.json` file. + +```console +/account +logout +``` diff --git a/website/content/cli/index.md b/website/content/cli/index.md new file mode 100644 index 000000000000..8097697a0884 --- /dev/null +++ b/website/content/cli/index.md @@ -0,0 +1,78 @@ +--- +title: Introduction +sidebar_position: 0 +description: The OpenBB CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. No experience with Python, or other programming languages, is required. +keywords: +- OpenBB +- CLI +- Platform +- data connectors +- data access +- data processing +- third-party data providers +- introduction +--- + + + +import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Overview + +The OpenBB CLI is a command line interface wrapping the OpenBB Platform. It offers a convenient way to interact with the Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. + +The CLI is the next iteration of the [OpenBB Terminal](/terminal), and leverages the extendability of the OpenBB Platform architecture in an easy-to-consume and script format. + +![CLI Home](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d1617c3b-c83d-4491-a7bc-986321fd7230) + +## Guides & Documentation + +
    + + + + + + + + +
+ +--- + +Want to contribute? Check out our [Development section](/platform/development). diff --git a/website/content/cli/installation.md b/website/content/cli/installation.md new file mode 100644 index 000000000000..51c1819538ab --- /dev/null +++ b/website/content/cli/installation.md @@ -0,0 +1,76 @@ +--- +title: Installation +sidebar_position: 2 +description: This page provides installation instructions for the OpenBB CLI. +keywords: +- OpenBB Platform +- Python +- CLI +- installation +- pip +- pypi + +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Pre-Requisites + +The OpenBB CLI is a wrapper around the [Platform](/platform), and should be installed along side an existing OpenBB installation. + +- A Python virtual environment with a version between 3.9 and 3.11, inclusive, is required. + +Please refer to the [OpenBB Platform install documentation](/platform/installation) for instructions and more information. + +:::info +If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components. +::: + +## PyPI + +Within your existing OpenBB environment, install `openbb-cli` with: + +```console +pip install openbb-cli +``` + + +The installation script adds `openbb` to the PATH within your Python environment. The application can be launched from any path, as long as the environment is active. + +```console +openbb + +Welcome to OpenBB Platform CLI v1.0.0 +``` + +## Source + +Follow the instructions [here](/platform/installation#source) to clone the GitHub repo and install the OpenBB Platform from the source code. + +Next, navigate into the folder: `~/OpenBBTerminal/cli` + +:::tip +The Python environment should have `toml` and `poetry` installed. + +```bash +pip install toml poetry +``` +::: + +Finally, enter: + +```console +poetry install +``` + +Alternatively, install locally with `pip`: + +```bash +pip install -e . +``` + +## Installing New Modules + +New extensions, or removals, are automatically added (removed) to the CLI on the next launch. diff --git a/website/content/cli/interactive-charts.md b/website/content/cli/interactive-charts.md new file mode 100644 index 000000000000..efd7438808e1 --- /dev/null +++ b/website/content/cli/interactive-charts.md @@ -0,0 +1,109 @@ +--- +title: Interactive Charts +sidebar_position: 9 +description: This page provides a detailed explanation of the OpenBB Interactive Charts. Understand various capabilities including annotation, color modification, drawing tools, data export, and supplementary data overlay. +keywords: +- interactive charts +- PyWry +- annotation +- drawing +- lines +- modebar +- plotly +- data export +- data overlay +- editing chart title +- Toolbar +- Text Tools +- Draw Tools +- Export Tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Interactive charts open in a separate window ([PyWry](https://github.com/OpenBB-finance/pywry)). The OpenBB charting library provides interactive and highly customizable charts. + +:::tip +Not all commands have a charting output, the ones that do, will display a chart argument (`--chart`), which will trigger the charting output instead of the default table output. + +Example: `equity/price/historical --symbol AAPL --chart` +::: + +
+Charting cheat sheet + +![Group 653](https://user-images.githubusercontent.com/85772166/234313541-3d725e1c-ce48-4413-9267-b03571e0eccd.png) + +
+ +## Toolbar + +![Chart Tools](https://user-images.githubusercontent.com/85772166/233247997-55c03cbd-9ca9-4f5e-b3fb-3e5a9c63b6eb.png) + +The toolbar is located at the bottom of the window, and provides methods for: + +- Panning and zooming. +- Modifying the title and axis labels. +- Adjusting the hover read out. +- Toggling light/dark mode. +- Annotating and drawing. +- Exporting raw data. +- Saving the chart as an image. +- Adding supplementary external data as an overlay. + +The label for each tool is displayed by holding the mouse over it. + +The toolbar's visibility can be toggled utilizing the `ctrl + h` shortcut. + +## Text Tools + +Annotate a chart by clicking on the `Add Text` button, or with the keyboard, `ctrl + t`. + +![Annotate Charts](https://user-images.githubusercontent.com/85772166/233248056-d459d7a0-ba2d-4533-896a-79406ded859e.png) + +Enter some text, make any adjustments to the options, then `submit`. Place the crosshairs over the desired data point and click to place the text. + +![Place Text](https://user-images.githubusercontent.com/85772166/233728645-74734241-4da2-4cff-af17-b68a62e95113.png) + +After placement, the text can be updated or deleted by clicking on it again. + +![Delete Annotation](https://user-images.githubusercontent.com/85772166/233728428-55d2a8e5-a68a-4cd1-9dbf-4c1cd697187e.png) + +## Change Titles + +The title of the chart is edited by clicking the button, `Change Titles`, near the middle center of the toolbar, immediately to the right of the `Add Text` button. + +## Draw Tools + +![Edit Colors](https://user-images.githubusercontent.com/85772166/233729318-8af947fa-ce2a-43e2-85ab-657e583ac8b1.png) + +The fourth group of icons on the toolbar are for drawing lines and shapes. + +- Edit the colors. +- Draw a straight line. +- Draw a freeform line. +- Draw a circle. +- Draw a rectangle. +- Erase a shape. + +To draw on the chart, select one of the four drawing buttons and drag the mouse over the desired area. Click on any existing shape to modify it by dragging with the mouse and editing the color, or remove it by clicking the toolbar button, `Erase Active Shape`. The edit colors button will pop up as a floating icon, and clicking on that will display the color palette. + +## Export Tools + +The two buttons at the far-right of the toolbar are for saving the raw data or, to save an image file of the chart at the current panned and zoomed view. + +![Export Tools](https://user-images.githubusercontent.com/85772166/233248436-08a2a463-403b-4b1b-b7d8-80cd5af7bee3.png) + +## Overlay + +The button, `Overlay chart from CSV`, provides an easy import method for supplementing a chart with additional data. Clicking on the button opens a pop-up dialogue to select the file, column, and whether the overlay should be a bar, candlestick, or line chart. As a candlestick, the CSV file must contain OHLC data. The import window can also be opened with the keyboard, `ctrl-o`. + +![Overlay CSV](https://user-images.githubusercontent.com/85772166/233248522-16b539f4-b0ae-4c30-8c72-dfa59d0c0cfb.png) + +After choosing the file to overlay, select what to show and then click on `Submit`. + +![Overlay Options](https://user-images.githubusercontent.com/85772166/233250634-44864da0-0936-4d3c-8de2-c8374d26c1d2.png) + +![Overlay Chart](https://user-images.githubusercontent.com/85772166/233248639-6d12b16d-471f-4550-a8ab-8d8c18eeabb3.png) diff --git a/website/content/cli/interactive-tables.md b/website/content/cli/interactive-tables.md new file mode 100644 index 000000000000..1399576b3606 --- /dev/null +++ b/website/content/cli/interactive-tables.md @@ -0,0 +1,75 @@ +--- +title: Interactive Tables +sidebar_position: 10 +description: This page explains how to navigate and utilize OpenBB's interactive tables. Understand how to sort and filter columns, hide or remove columns, select number of rows per page, freeze index and column headers, and export the data. +keywords: +- interactive tables +- PyWry technology +- sorting columns +- filtering columns +- hiding columns +- rows per page +- freeze index +- freeze column headers +- exporting data +- data visualization +- customizing tables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +Interactive tables open in a separate window ([PyWry](https://github.com/OpenBB-finance/pywry)). These provide methods for searching, sorting, filtering, exporting and even adapting settings directly on the table. + +:::tip +All OpenBB CLI results are displayed in interactive tables by default, unless the interactive model is disabled from the `/settings` menu. +::: + +
+Table cheat sheet + +![Chart Intro (5)](https://user-images.githubusercontent.com/85772166/234315026-de098953-111b-4b69-9124-31530c01407a.png) + +
+ +## Sorting + +Columns can be sorted ascending/descending/unsorted, by clicking the controls to the right of each header title. The status of the filtering is shown as a blue indicator. + +![Sort Columns](https://user-images.githubusercontent.com/85772166/233248754-20c18390-a7af-490c-9571-876447b1b0ae.png) + +## Filtering + +The settings button, at the lower-left corner, displays choices for customizing the table. By selecting the `Type` to be `Advanced`, columns become filterable. + +![Table Settings](https://user-images.githubusercontent.com/85772166/233248876-0d788ff4-974d-4d92-8186-56864469870a.png) + +The columns can be filtered with min/max values or by letters, depending on the content of each column. + +![Filtered Tables](https://user-images.githubusercontent.com/85772166/233248923-45873bf1-de6b-40f8-a4aa-05e7c3d21ab0.png) + +## Hiding columns + +The table will scroll to the right as far as there are columns. Columns can be removed from the table by clicking the icon to the right of the settings button and unchecking it from the list. + +![Select Columns](https://user-images.githubusercontent.com/85772166/233248976-849791a6-c126-437c-bb54-454ba6ea4fa2.png) + +## Select rows per page + +The number of rows per page is defined in the drop down selection near the center, at the bottom. + +![Rows per Page](https://user-images.githubusercontent.com/85772166/233249018-8269896d-72f7-4e72-a4d4-2715d1f11b96.png) + +## Freeze the Index and Column Headers + +Right-click on the index name to enable/disable freezing when scrolling to the right. Column headers are frozen by default. + +![Index Freeze](https://user-images.githubusercontent.com/85772166/234103702-0965dfbd-24ca-4a66-8c76-9fac28abcff8.png) + +## Exporting Data + +At the bottom-right corner of the table window, there is a button for exporting the data. To the left, the drop down selection for `Type` can be defined as a CSV, XLSX, or PNG file. Exporting the table as a PNG file will create a screenshot of the table at its current view, and data that is not visible will not be captured. + +![Export Data](https://user-images.githubusercontent.com/85772166/233249065-60728dd1-612e-4684-b196-892f3604c0f4.png) diff --git a/website/content/cli/openbbuserdata.md b/website/content/cli/openbbuserdata.md new file mode 100644 index 000000000000..036731b19365 --- /dev/null +++ b/website/content/cli/openbbuserdata.md @@ -0,0 +1,59 @@ +--- +title: OpenBBUserData Folder +sidebar_position: 8 +description: The OpenBBUserData folder is where exports, routines, and other user-related content is saved and stored. Its default location is the home of the system user account. +keywords: +- OpenBBUserData folder +- settings +- data +- preferences +- exports +- CLI +- save +- routines +- xlsx +- csv +- user_settings.json +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBBUserData folder is where exports, routines, and other user-related content is saved and stored. + +:::info +If a new file is placed in the folder (like a Routine) the CLI will need to be reset before auto complete will recognize it. +::: + +## Default Location + +Its default location is the home of the system user account, similar to the following paths: +- macOS: `Macintosh HD/Users//OpenBBUserData` +- Windows: `C:/Users//OpenBBUserData` + +This folder contains all things user-created. For example: + +- Exported files +- Styles and themes +- Routines +- Logs + +:::note +**Note:** With a WSL-enabled Windows installation, this folder will be under the Linux partition +::: + +## Update Folder Location + +The location of this folder can be set by the user by changing the user configuration file: `/home/your-user/.openbb_platform/user_settings.json`. + +```json +{ +... +"preferences": { + "data_directory": "/path/to/NewOpenBBUserData", + "export_directory": "/path/to/NewOpenBBUserData" +}, +... +} +``` diff --git a/website/content/cli/quickstart.md b/website/content/cli/quickstart.md new file mode 100644 index 000000000000..ef9841087311 --- /dev/null +++ b/website/content/cli/quickstart.md @@ -0,0 +1,243 @@ +--- +title: Quick Start +sidebar_position: 2 +description: This page is a quick start guide for the OpenBB CLI. +keywords: +- quickstart +- quick start +- tutorial +- getting started +- cli +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Launch + +- Open a Terminal and activate the environment where the `openbb-cli` package was installed. +- On the command line, enter: `openbb` + +![CLI Home](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d1617c3b-c83d-4491-a7bc-986321fd7230) + +## Login + +Login to your [OpenBB Hub account](https://my.openbb.co) to add stored keys to the session. + +```console +/account/login --pat REPLACE_WITH_YOUR_PAT +``` + +:::tip +Add `--remember-me` to the command to persist the login until actively logging out. +::: + +Login by email & password is also possible. + +```console +/account/login --email my@emailaddress.com --password n0Ts3CuR3L!kEPAT +``` + +Find all data providers [here](https://docs.openbb.co/platform/extensions/data_extensions), and manage all your credentials directly on the [OpenBB Hub](https://my.openbb.co/app/platform/credentials). + +## Menus + +:::info +Menus are distinguishable from commands by the character, `>`, on the left of the screen. +::: + +Enter a menu by typing it out and pressing return. + +```console +economy +``` + +![Economy Menu](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b68491fc-d6c3-42a7-80db-bfe2aa848a5a) + +### Go Back One Level + +Return to the parent menu by entering either: + +- `..` +- `q` + +### Go Back To Home + +Return to the base menu by entering either: + +- `/` +- `home` + +### Jump Between Menus + +Use absolute paths to navigate from anywhere, to anywhere. + +From: + +```console +/equity/calendar/earnings +``` + +To: + +```console +/economy/calendar +``` + +## Commands + +Commands are displayed on-screen in a lighter colour, compared with menu items, and they will not have, `>`. + +Functions have a variety of parameters that differ by endpoint and provider. Use the `--help` dialogue to understand the nuances of any particular command. + +### How To Enter Parameters + +Parameters are all defined through the same pattern, `--argument`, followed by a space, and then the value. + +If the parameter is a boolean (true/false), there is no value to enter. Adding the `--argument` flags the parameter to be the opposite of its default state. + +:::danger +The use of positional arguments is not supported. + +❌ `historical AAPL --start_date 2024-01-01` + +✅ `historical --symbol AAPL --start_date 2024-01-01` +::: + +### Use Auto Complete + +The auto completion engine is triggered when the spacebar is pressed following any command, or parameter with a defined set of choices. + +After the first parameter has been set, remaining parameters will be triggered by entering `--`. + +```console +historical --symbol AAPL --start_date 2024-01-01 -- +``` + +![Auto Complete](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/78e68bbd-094e-4558-bce0-92b8d556fcaf) + +### Data Processing Commands + +Data processing extensions, like `openbb-technical` accept `--data` as an input. + +:::info +Command outputs are cached. These can be check using the `results` command and are selected with the `--data` parameter. +::: + +```console +# Store the command output +/equity/price/historical --symbol SPY --start_date 2024-01-01 --provider yfinance + +# Check results content +results + +# Use the results +/technical/rsi --data OBB0 --chart +``` + +![SPY RSI](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b480da04-92e6-48e2-bccf-cebc16fb083a) + +## Help Dialogues + +Display the help dialogue by attaching, `--help` or `-h`, to any command. + +:::info +Use this to identify the providers compatible with each parameter, if applicable. +::: + +```console +calendar --help +``` + +```console +usage: calendar [--start_date START_DATE] [--end_date END_DATE] [--provider {fmp,nasdaq,tradingeconomics}] [--country COUNTRY] [--importance {Low,Medium,High}] + [--group {interest rate,inflation,bonds,consumer,gdp,government,housing,labour,markets,money,prices,trade,business}] [-h] [--export EXPORT] + [--sheet-name SHEET_NAME [SHEET_NAME ...]] + +Get the upcoming, or historical, economic calendar of global events. + +options: + --start_date START_DATE + Start date of the data, in YYYY-MM-DD format. + --end_date END_DATE End date of the data, in YYYY-MM-DD format. + --provider {fmp,nasdaq,tradingeconomics} + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'fmp' if there is + no default. + --country COUNTRY Country of the event. (provider: nasdaq, tradingeconomics) + -h, --help show this help message + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. + +tradingeconomics: + --importance {Low,Medium,High} + Importance of the event. + --group {interest rate,inflation,bonds,consumer,gdp,government,housing,labour,markets,money,prices,trade,business} + Grouping of events + +``` + +If the source selected was Nasdaq, `--provider nasdaq`, the `--importance` and `--group` parameters will be ignored. + +```console +/economy/calendar --provider nasdaq --country united_states +``` + +| date | country | event | actual | previous | consensus | description | +|:--------------------|:--------------|:-------------------------|:---------|:-----------|:------------|:--------------| +| 2024-05-08 13:30:00 | United States | Fed Governor Cook Speaks | - | - | - | | +| cont... | | | | | | | + +## Export Data + +Data can be exported as a CSV, JSON, or XLSX file, and can also be exported directly from the interactive tables and charts. + +### Named File + +This command exports the Nasdaq directory as a specific CSV file. The path to the file is displayed on-screen. + +```console +/equity/search --provider nasdaq --export nasdaq_directory.csv +``` + +```console +Saved file: /Users/myusername/OpenBBUserData/nasdaq_directory.csv +``` + +### Unnamed File + +If only supplied with the file type, the export will be given a generic name beginning with the date and time. + +```console +/equity/search --provider nasdaq --export csv +``` + +``` +Saved file: /Users/myusername/OpenBBUserData/20240508_145308_controllers_search.csv +``` + +### Specify Sheet Name + +Exports can share the same `.xlsx` file by providing a `--sheet-name`. + +```console +/equity/search --provider nasdaq --export directory.xlsx --sheet-name nasdaq +``` + +## Run Multiple Commands + +A chain of commands can be run from a single line, separate each process with `/`. The example below will draw two charts and can be pasted as a single line. + +```console +/equity/price/historical --symbol AAPL,MSFT,GOOGL,AMZN,META,NVDA,NFLX,TSLA,QQQ --start_date 2022-01-01 --provider yfinance --chart/performance --symbol AAPL,MSFT,GOOGL,AMZN,META,NVDA,NFLX,TSLA,QQQ --provider finviz --chart +``` + +## Example Routine + +To demonstrate how multiple commands are sequenced as a script, try running the example Routine. + +```console +/exe --example +``` diff --git a/website/content/cli/routines/_category_.json b/website/content/cli/routines/_category_.json new file mode 100644 index 000000000000..baa94ff89038 --- /dev/null +++ b/website/content/cli/routines/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Routines", + "position": 11 +} diff --git a/website/content/cli/routines/advanced-routines.md b/website/content/cli/routines/advanced-routines.md new file mode 100644 index 000000000000..deb5988eb0ef --- /dev/null +++ b/website/content/cli/routines/advanced-routines.md @@ -0,0 +1,119 @@ +--- +title: Advanced Routines +sidebar_position: 5 +description: This page provides guidance on creating and running advanced workflows in the OpenBB CLI by + introducing variables and arguments for routines. It explains input variables, + relative time keyword variables, internal script variables and creating loops for + batch execution. +keywords: +- automated workflows +- routines +- arguments +- variables +- relative time keywords +- internal script variables +- loops +- batch execution +- Tutorial +- Running Scripts +- Executing Commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Input Variables + +Arguments are variables referenced within the `.openbb` script as `$ARGV` or `$ARGV[0]`, `$ARGV[1]`, and so on. They are provided in the CLI when running `exe` by adding the `--input` flag, followed by the variables separated by commas. + +### Example + +```text +# This script requires you to use arguments. This can be done with the following: +# exe --file routines_template_with_input.openbb -i TSLA +# Replace the name of the file with your file. + +# Navigate to the menu +/equity/price + +# Load the data and display a chart +historical --symbol $ARGV --chart +``` + +## Set Variables + +In addition to external variables using the keyword, `ARGV`, internal variables can be defined with the, `$`, character. + +Note that the variable can have a single element or can be constituted by an array where elements are separated using a comma “,”. + +### Internal Variables Example + +```text +# Example routine with internal variables. + +$TICKERS = XLE,XOP,XLB,XLI,XLP,XLY,XHE,XLV,XLF,KRE,XLK,XLC,XLU,XLRE + +/equity + +price + +historical --symbol $TICKERS --provider yfinance --start_date 2024-01-01 --chart + +home +``` + +## Relative Time Keyword Variables + +In addition to the powerful variables discussed earlier, OpenBB also supports the usage of relative keywords, particularly for working with dates. These relative keywords provide flexibility when specifying dates about the current day. There are four types of relative keywords: + +1. **AGO**: Denotes a time in the past relative to the present day. Valid examples include `$365DAYSAGO`, `$12MONTHSAGO`, `$1YEARSAGO`. + +2. **FROMNOW**: Denotes a time in the future relative to the present day. Valid examples include `$365DAYSFROMNOW`, `$12MONTHSFROMNOW`, `$1YEARSFROMNOW`. + +3. **LAST**: Refers to the last specific day of the week or month that has occurred. Valid examples include `$LASTMONDAY`, `$LASTJUNE`. + +4. **NEXT**: Refers to the next specific day of the week or month that will occur. Valid examples include `$NEXTFRIDAY`, `$NEXTNOVEMBER`. + +The result will be a date with the conventional date associated with OpenBB, i.e. `YYYY-MM-DD`. + +### Relative Time Example + +```text +$TICKERS = XLE,XOP,XLB,XLI,XLP,XLY,XHE,XLV,XLF,KRE,XLK,XLC,XLU,XLRE + +/equity + +price + +historical --symbol $TICKERS --provider yfinance --start_date $3MONTHSAGO --chart + +.. + +calendar + +earnings --start_date $NEXTMONDAY --end_date $NEXTFRIDAY --provider nasdaq + +home +``` + +## Foreach Loop + +Finally, what scripting language would this be if there were no loops? For this, we were inspired by MatLab. The loops in OpenBB utilize the foreach and end convention, allowing for iteration through a list of variables or arguments to execute a sequence of commands. + +To create a foreach loop, you need to follow these steps: + +1. Create the loop header using the syntax: `foreach $$VAR in X` where `X` represents either an argument or a list of variables. It's worth noting that you can choose alternative names for the `$$VAR` variable, as long as the `$$` convention is maintained. + +2. Insert the commands you wish to repeat on the subsequent lines. + +3. Conclude the loop with the keyword `end`. + +### Loop Example + +```text +# Iterates through ARGV elements. +foreach $$VAR in $ARGV[1:] + /equity/fundamental/filings --symbol $$VAR --provider sec +end +``` diff --git a/website/content/cli/routines/community-routines.md b/website/content/cli/routines/community-routines.md new file mode 100644 index 000000000000..1fa10fcdd048 --- /dev/null +++ b/website/content/cli/routines/community-routines.md @@ -0,0 +1,52 @@ +--- +title: Community Routines +sidebar_position: 3 +description: Page provides a detailed overview of OpenBB's Community + Routines. It explains how users can create, modify, share, vote, download, and search for investment + research scripts. +keywords: +- Community Routines +- Investment Research +- Investment Scripts +- Upvotes +- Share Scripts +- Advanced Search +- CLI +- automation +- Hub +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Overview + +Community Routines are a feature of the [OpenBB Hub](https://my.openbb.co) that provides methods for creating, editing and sharing OpenBB CLI scripts in the cloud. + +Users can create routines that are private or public, with public routines able to run directly from a URL. + +## Create Routines + +- From the sidebar, click on "My Routines". +- Scroll down and click the button, "Create New". +- Enter a name for the routine. +- Select the "public" check box to make it runnable via URL. +- Add tags (optional). +- Add a short description. +- Enter your workflow into the Script box. +- Click the "Create" button. + +## Run From URL + +To run a routine with a URL, it must be made public. Existing routines can be modified by clicking on the item under, "My Routines". Check the "Public" box to activate. + +The URL will follow the pattern, `https://my.openbb.co/u/{username}/routine/{routine-name}`, which can be executed from the CLI with: + +```console +/exe --url {URL} +``` + +## Download + +Alternatively, click the "Download" button at the bottom of the routine editor to manually download the file to the machine. Place the file in the `OpenBBUserData/routines` folder and open the CLI. The script will be presented as a choice by auto-complete. diff --git a/website/content/cli/routines/index.mdx b/website/content/cli/routines/index.mdx new file mode 100644 index 000000000000..cf5947ef80a0 --- /dev/null +++ b/website/content/cli/routines/index.mdx @@ -0,0 +1,31 @@ +--- +title: Routines +--- + +import NewReferenceCard from "@site/src/components/General/NewReferenceCard"; +import HeadTitle from "@site/src/components/General/HeadTitle.tsx"; + + + +
    + + + + +
\ No newline at end of file diff --git a/website/content/cli/routines/introduction-to-routines.md b/website/content/cli/routines/introduction-to-routines.md new file mode 100644 index 000000000000..7eaf8ecd9734 --- /dev/null +++ b/website/content/cli/routines/introduction-to-routines.md @@ -0,0 +1,130 @@ +--- +title: Introduction to Routines +sidebar_position: 1 +description: The page provides a detailed introduction to OpenBB Routines, which allow + users to automate processes and repetitive tasks in financial analysis and data + collection. It explains conventions, basic scripts, routine execution, and guides users on getting + started with an example. +keywords: +- OpenBB Routines +- automated processes +- repetitive tasks +- data collection +- basic script +- routine execution +- automation +- routines +- cli +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Overview + +OpenBB Routines allows users to capture and write simple scripts for automating processes and repetitive tasks. In essence, these are text plain-text files that can be created or modified in any basic text editor with the only difference being the `.openbb` extension. + +Other software like STATA, SPSS, and R-Studio share similar functionality in the area of Econometrics and the OpenBB routine scripts venture into the area of financial analysis and data collection to speed up the process. + +Routines make it easy to automate a series of processes, and this includes mining and dumping large amounts of data to organized spreadsheets. Making use of `--export` and `--sheet-name`, data collection is more efficient and reliable, with results that are easily replicable. + +A pipeline of commands is difficult to share, so to encourage users to share ideas and processes, we created [Community Routines](community-routines.md) for the [OpenBB Hub](https://my.openbb.co/). Routines can be created, stored, and shared - executable in any OpenBB CLI installation, by URL. + +## Pipeline of Commands + +One of the main objectives of the OpenBB Platform CLI is to automate a user's investment research workflow - not just a single command, but the complete process. This is where the pipeline of commands comes in, running a sequence of commands. + +An example of a pipeline of commands is: + +```console +/equity/price/historical --symbol AAPL/../../technical/ema --data OBB0 --length 50 +``` + +Which will perform a exponential moving average (`ema`) on the historical price of Apple (`AAPL`). + +### Step-by-Step Explanation + +This will do the following: + +1. `equity` - Go into `equity` menu. + +2. `price` - Go into `price` sub-menu. + +3. `historical --symbol AAPL` - Load historical price data for Apple. + +4. `..` (X2) will walk back to the root menu. + +5. `technical` - Go into Technical Analysis (`technical`) menu. + +6. `ema --data OBB0 --length 50` - Run the exponential moving average indicator with windows of length 50 (`--length 50`) on the last cached result (`--data OBB0`) + +## Routine execution + +Run a routine file from the main menu, with the `exe` command. Try, `exe --example`, to get a sense of what this functionality does. Below, the `--help` dialogue is displayed. + +```console +/exe -h +``` + +```console +usage: exe [--file FILE [FILE ...]] [-i ROUTINE_ARGS] [-e] [--url URL] [-h] + +Execute automated routine script. For an example, please use `exe --example` and for documentation and to learn how create your own script type `about exe`. + +optional arguments: + --file FILE [FILE ...], -f FILE [FILE ...] + The path or .openbb file to run. (default: None) + -i ROUTINE_ARGS, --input ROUTINE_ARGS + Select multiple inputs to be replaced in the routine and separated by commas. E.g. GME,AMC,BTC-USD (default: None) + -e, --example Run an example script to understand how routines can be used. (default: False) + --url URL URL to run openbb script from. (default: None) + -h, --help show this help message (default: False) + +For more information and examples, use 'about exe' to access the related guide. +``` + +## Basic Script + +The most basic script style contains 2 main elements: + +- **Comments**: any text after a hashtag (`#`) is referred to as a comment. This is used to explain what is happening within the line below and is ignored when the file is executed. +- **Commands**: any text *without* a hashtag is being run inside the CLI as if the user had prompted that line in the terminal. Note that this means that you are able to create a pipeline of commands in a single line, i.e. `equity/price/historical --symbol AAPL --provider fmp` is a valid line for the script. + +For instance, the text below corresponds to the example file that OpenBB provides. + +```console +# Navigate into the price sub-menu of the equity module. +equity/price + +# Load a company ticker, e.g. Apple +historical --symbol AAPL --provider yfinance + +# Show a candle chart with a 20 day Moving Average +/technical/ema --data OBB0 --length 20 + +# Switch over to the Fundamental Analysis menu +/equity/fundamental + +# Show balance sheet +balance --symbol aapl --provider yfinance + +# Show cash flow statement +cash --symbol aapl --provider yfinance + +# Show income statement +income --symbol aapl --provider yfinance + +# Return to home +home +``` + +## Getting started + +As a starting point, let's use the example above. + +1. Create a new text file with the name `routines_template.openbb` and copy and paste the routine above. + +2. Move the file inside the `routines` folder within the [OpenBBUserData](openbbuserdata) folder and, optionally, adjust the name to your liking. + +3. Open up the CLI, and type `exe --file routines_template`. If you changed the name of the file, then replace, `routines_template`, with that. As long as the file remains in the `~/OpenBBUserData/routines` folder, the CLI's auto-completer will provide it as a choice. diff --git a/website/content/cli/routines/routine-macro-recorder.md b/website/content/cli/routines/routine-macro-recorder.md new file mode 100644 index 000000000000..2221b7d8d342 --- /dev/null +++ b/website/content/cli/routines/routine-macro-recorder.md @@ -0,0 +1,46 @@ +--- +title: Routine Macro Recorder +sidebar_position: 4 +description: Learn how to use the macro recorder in OpenBB to start saving commands + and automate common tasks with scripts. This page guides you through the process + of recording, saving, and accessing your recorded routines. +keywords: +- macro recorder +- script routines +- global commands +- command recording +- routine script +- terminal main menu +- exe --file +- OpenBBUserData +- routines folder +- cli +- record +- stop +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB script routines can be captured with the macro recorder, controlled with global commands. Enter, `record`, to start saving commands, and then, `stop`, terminates the recording. This means that any command you run will be captured in the script; and on `stop`, it will be saved to the `~/OpenBBUserData/routines/` folder. + +For example: + +```console +record -n sample + +/equity/price/historical --symbol SPY --provider cboe --interval 1m/home/derivatives/options/chains --symbol SPY --provider cboe/home/stop/r +``` + +The final command after `stop`, `r`, resets the CLI so that the routine is presented as a choice in the `exe` command. + +It can now be played back by entering: + +```console +/exe --file sample.openbb +``` + +:::tip +The routine can be edited to replace parameter values with input variables - e.g, `$ARGV[0]`, `$ARGV[1]`, etc. +::: diff --git a/website/content/cli/structure-and-navigation.md b/website/content/cli/structure-and-navigation.md new file mode 100644 index 000000000000..bcb6f6d840e0 --- /dev/null +++ b/website/content/cli/structure-and-navigation.md @@ -0,0 +1,42 @@ +--- +title: Structure and Navigation +sidebar_position: 3 +description: This page describes the layout and structure of the OpenBB CLI, as well as how to navigate it. +keywords: +- CLI application +- OpenBB Platform CLI +- structure +- navigation +- Command Line Interface +- navigating +- Home +- commands +- menus +- OpenBB Hub Theme Style +- Absolute paths +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Structure + +The OpenBB Platform CLI is a Command Line Interface (CLI) application. Functions (commands) are called through the keyboard with results returned as charts, tables, or text. Charts and tables (if enabled) are displayed in a new window, and are fully interactive, while text prints directly to the Terminal screen. + +A menu is a collection of commands (and sub-menus). A menu can be distinguished from a command because the former has a `>` on the left. The color of a command and a menu also differ, but these can be changed in OpenBB Hub's theme style. + +## Navigation + +Navigating through the CLI menus is similar to traversing folders from any operating system's command line prompt. The `/home` screen is the main directory where everything begins, and the menus are paths branched from the main. Instead of `C:\Users\OpenBB\Documents`, you'll have something like `/equity/price`. Instead of `cd ..`, you can do `..` to return the menu right above. To go back to the root menu you can do `/`. + +### Absolute Paths + +Absolute paths are also valid to-and-from any point. From the `/equity/price` menu, you can go directly to `crypto` menu with: `/crypto`. Note the forward slash at the start to denote the "absolute" path. + +### Home + +Return to the Home screen from anywhere by entering any of the following: + +- `/` +- `home` diff --git a/website/content/platform/installation.md b/website/content/platform/installation.md index 2db5639e2f68..9ef0a060ce44 100644 --- a/website/content/platform/installation.md +++ b/website/content/platform/installation.md @@ -123,15 +123,6 @@ From your python interpreter, import the OpenBB Platform: from openbb import obb ``` -:::warning -This import statement is required due to the statefulness of the obb package. There is currently no support for imports such as - -```console -from openbb.obb.equity import * -``` - -::: - When the package is imported, any installed extensions will be discovered, imported and available for use. :::note diff --git a/website/package-lock.json b/website/package-lock.json index ddcb2300e626..d4355a0b3d57 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -13952,12 +13952,6 @@ "url": "https://opencollective.com/webpack" } }, - "node_modules/search-insights": { - "version": "2.13.0", - "resolved": "https://registry.npmjs.org/search-insights/-/search-insights-2.13.0.tgz", - "integrity": "sha512-Orrsjf9trHHxFRuo9/rzm0KIWmgzE8RMlZMzuhZOJ01Rnz3D0YBAe+V6473t6/H6c7irs6Lt48brULAiRWb3Vw==", - "peer": true - }, "node_modules/section-matter": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/section-matter/-/section-matter-1.0.0.tgz", @@ -15149,6 +15143,7 @@ "version": "5.4.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", + "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" diff --git a/website/sidebars.js b/website/sidebars.js index 17d5b5dccbc3..f2ebf8ea6ea5 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -36,6 +36,11 @@ export default { label: "OpenBB Platform", items: [{ type: "autogenerated", dirName: "platform" }], }, + { + type: "category", + label: "OpenBB CLI", + items: [{ type: "autogenerated", dirName: "cli" }], + }, { type: "category", label: "OpenBB Bot", diff --git a/website/src/components/General/NewReferenceCard.tsx b/website/src/components/General/NewReferenceCard.tsx index f40993a99090..d75bb780f193 100644 --- a/website/src/components/General/NewReferenceCard.tsx +++ b/website/src/components/General/NewReferenceCard.tsx @@ -40,13 +40,16 @@ export default function NewReferenceCard({ cleanedPath.startsWith("/platform"), "hover:bg-[#16A34A] border-[#16A34A] dark:hover:bg-[#14532D] dark:border-[#14532D]": cleanedPath.startsWith("/excel"), + "hover:bg-[#D3D3D3] border-[#D3D3D3] dark:hover:bg-[#5c5c5c] dark:border-[#5c5c5c]": + cleanedPath.startsWith("/cli"), header_docs: !cleanedPath.startsWith("/terminal") && !cleanedPath.startsWith("/pro") && !cleanedPath.startsWith("/excel") && !cleanedPath.startsWith("/sdk") && !cleanedPath.startsWith("/platform") && - !cleanedPath.startsWith("/bot"), + !cleanedPath.startsWith("/bot") && + !cleanedPath.startsWith("/cli"), }, )} to={url} diff --git a/website/src/theme/CodeBlock/Content/styles.module.css b/website/src/theme/CodeBlock/Content/styles.module.css index c1b10cde049a..1cc776c2fbfa 100644 --- a/website/src/theme/CodeBlock/Content/styles.module.css +++ b/website/src/theme/CodeBlock/Content/styles.module.css @@ -35,6 +35,7 @@ float: left; min-width: 100%; padding: var(--ifm-pre-padding); + line-height: 18px; } .codeBlockLinesWithNumbering { diff --git a/website/src/theme/DocSidebarItem/Category/index.js b/website/src/theme/DocSidebarItem/Category/index.js index 4ddec60bf68c..a374570c15c4 100644 --- a/website/src/theme/DocSidebarItem/Category/index.js +++ b/website/src/theme/DocSidebarItem/Category/index.js @@ -85,6 +85,7 @@ export default function DocSidebarItemCategory({ "OpenBB Bot": "/bot", "OpenBB Terminal Pro": "/pro", "OpenBB Add-in for Excel": "/excel", + "OpenBB CLI": "/cli", }; const newHref = labelToHrefMap[label] || href; const { diff --git a/website/src/theme/Navbar/Layout/index.js b/website/src/theme/Navbar/Layout/index.js index 8a767c3f6200..65e2a425e6e4 100644 --- a/website/src/theme/Navbar/Layout/index.js +++ b/website/src/theme/Navbar/Layout/index.js @@ -80,6 +80,18 @@ export default function NavbarLayout({ children }) { "#3a204f" ); } + } else if (cleanedPath.startsWith("/cli")) { + if (document.documentElement.getAttribute("data-theme") === "dark") { + document.documentElement.style.setProperty( + "--ifm-color-primary", + "#d3d3d3" + ); + } else { + document.documentElement.style.setProperty( + "--ifm-color-primary", + "#d3d3d3" + ); + } } else { } }, [pathname]);