Customization
The OpenBB Terminal contains two menus for altering the behaviour and presentation of the Terminal, Settings and Feature Flags, both of which are accessed from the main menu.
Settings Menu
The /settings
menu provides methods for customizing the look of the Terminal.
Setting | Description |
---|---|
chart | Select the chart style. |
colors | Sets the color scheme for Terminal fonts. |
dt | Add or remove date and time from the Terminal command line. |
flair | Sets the flair emoji to be used. |
height | Set the default plot height. |
lang | Select the language for the Terminal menus and commands. |
source | Use an alternate data sources file. (Not recommended to change.) |
table | Select the table style. |
tz | Select a timezone. |
userdata | Change the local path to the OpenBBUserData folder. |
width | Set the default plot width. |
Style example
Set charts and tables styles as light or dark mode.
/settings/table -s light
/settings/chart -s dark
Timezone example
Set the local timezone for the Terminal
/settings/tz Africa/Johannesburg
Feature Flags Menu
The /featflags
menu provides methods for altering the behaviour and responses with environment variables. These configurations are on/off, and the status is indicated by the red/green text of each. Each parameter is listed below.
Feature | Description |
---|---|
cls | Clear the screen after each command. Default state is off. |
exithelp | Automatically print the screen after navigating back one menu. Default state is off. |
interactive | Enable/disable interactive tables. Disabling prints the table directly on the Terminal screen. |
overwrite | Automatically overwrite exported files with the same name. Default state is off. |
promptkit | Enable auto complete and history. Default state is on. |
rcontext | Remember loaded tickers while switching menus. Default state is on. |
retryload | Retries misspelled commands with the load function first. Default state is off. |
reporthtml | Generate reports as HTML files. 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. |
version | Displays the currently installed version number in the bottom right corner. |
Interactive example
When it is off, the Terminal displays all tables directly on the screen instead of opening a window.
/stocks/quote spy
SPY | |
---|---|
day_low | 434.87 |
day_high | 438.09 |
symbol | SPY |
name | SPDR S&P 500 ETF Trust |
price | 437.25 |
changes_percentage | 0.0732 |
change | 0.32 |
year_high | 459.44 |
year_low | 373.61 |
market_cap | 401300183873.0 |
price_avg50 | 433.4872 |
price_avg200 | 424 |
volume | 56366265 |
avg_volume | 83194937 |
exchange | AMEX |
open | 437.55 |
previous_close | 436.93 |
eps | 19.851322 |
pe | 22.03 |
shares_outstanding | 917782010 |
date | 2023-11-08 21:00 |
Overwrite
Enable this feature flag to remove the prompt when exporting a file with the same name. This will only overwrite an existing XLSX
file if the --sheet-name
is not defined.
Exithelp
Enabling this prints the parent menu on the screen when navigating back from a sub-menu.