jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
6381b2ae7def272da3df3b544ba91c6bf5362ad1
OpenBB/website/content/terminal/guides/advanced/customizing-the-terminal.md
andrewkenreich 6381b2ae7d Doc updates and fixes (#3609) 
* fixing a url

* moving around menus

* Grammar Update

* many fixes to links and some added pics to install

* Add improvements

* fix: tabs

* Move support/feedback window to FAQ

* Forgot to save

* MVC moved around

* change installation Source -> Python

* fix: tabs

* guides to basics

* Add new README LINKS

* Change links

* Change forecasting to forecast

* fix: details

* more fixes

* Change markdown file so it is ready for pypi

Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
2022-11-28 12:13:47 -05:00

2.8 KiB
Vendored
Raw Blame History

sidebar_position, title
sidebar_position title
4 Customizing the Terminal

To adjust the lay-out and settings of the OpenBB Terminal you can access the settings menu. This menu allows you to tweak how the terminal behaves. This includes the following:

  • dt adds or removes the datetime from the flair (which is next to the emoji).
  • flair allows you to change the emoji that is used.
  • lang gives the ability to change the terminal language. At this moment, the terminal is only available in English.
  • export defines the folder you wish to export data you acquire from the terminal. Use quotes for custom locations.
  • tz allows you to change the timezone if this is incorrectly displayed for you.
  • autoscaling automatically scales plots for you if enabled (when green).
  • pheight sets the percentage height of the plot (graphs) displayed (if autoscaling is enabled).
  • pwidth sets the percentage width of the plot (graphs) displayed (if autoscaling is enabled).
  • height sets the height of the plot (graphs) displayed (if autoscaling is disabled).
  • width sets the width of the plot (graphs) displayed (if autoscaling is disabled).
  • dpi refers to the resolution that is used for the plot (graphs)
  • backend allows you to change the backend that is used for the graphs
  • monitor choose which monitors to scale the plot (graphs) to if applicable
  • source allows you to select a different source file in which the default data sources are written down

Next to that, to enable or disable certain functionalities of the terminal you can use the featflags menu which includes the following:

  • retryload whenever you misspell commands, try to use the load command with it first (default is no).
  • tab whether to use tabulate to print DataFrames, to prettify these DataFrames (default is yes).
  • cls whether to clear the command window after each command (default is no).
  • color whether to use colors within the terminal (default is yes).
  • promptkit whether you wish to enable autocomplete and history (default is yes).
  • thoughts whether to receive a thought of the day (default is no).
  • reporthtml whether to open reports as HTML instead of Jupyter Notebooks (default is yes).
  • exithelp whether to automatically print the help message when you use q (default is yes).
  • rcontext whether to remember loaded tickers and similar while switching menus (default is yes).
  • rich whether to apply a colorful rich terminal (default is yes).
  • richpanel whether to apply a colorful rich terminal panel (default is yes).
  • ion whether to enable interactive mode of MATPLOTLIB (default is yes).
  • watermark whether to include the watermark of OpenBB Terminal in figures (default is yes).
  • cmdloc whether the location of the command is displayed in figures (default is yes).
  • tbhint whether usage hints are displayed in the bottom toolbar (default is yes).