jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-31 06:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'develop' into feature/plotly-react

Browse Source
This commit is contained in:
teh_coderer
2023-05-10 18:56:04 -05:00
committed by GitHub
parent 0b58968335 678544914a
commit 9707388363
1 changed files with 29 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
KEYBOARD_HOTKEY_MACROS.md → website/content/terminal/usage/guides/keyboard-hotkey-macros.md vendored
View File

@@ -1,4 +1,23 @@
# Keyboard Hotkey Macros
---
title: Keyboard Hotkey Macros
sidebar_position: 6
description: Create keyboard hotkey macros to run a sequence of commands
keywords:
[
keyboard,
macros,
commands,
pipeline,
excel,
customizable,
hotkey,
remap,
]
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Keyboard Hotkey Macros - Terminal | OpenBB Docs" />
This document will explain how you can set hotkeys macros on your customizable keyboard which allow you to perform investment research in a few seconds.
@@ -14,13 +33,13 @@ One of the concepts that OpenBB introduced early on was the concept of script ro
E.g. by running `exe script.openbb` the following sequence could be executed
```shell
```console
stocks/load AAPL/candle --ma 20/fa/epsfc/pt/est
```
which would lead to:
![image](https://user-images.githubusercontent.com/25267873/236659876-e119c820-b9ed-40e7-bb8d-5510fe862149.png)
<img width="1441" alt="image" src="https://user-images.githubusercontent.com/25267873/236659876-e119c820-b9ed-40e7-bb8d-5510fe862149.png" />
This allows to automate the process of investment research, and can improve user's experience by a significant margin.
@@ -41,29 +60,29 @@ For the purpose of this example, the command pipeline we are creating has the fo
1. Try VIA [here](https://usevia.app/). The following screen should popup
<img width="1436" alt="Screenshot 2023-05-06 at 11 10 51 PM" src="https://user-images.githubusercontent.com/25267873/236660856-f92ac602-cde9-48e6-8029-c083fbb75ff9.png">
![VIA](https://user-images.githubusercontent.com/25267873/236660856-f92ac602-cde9-48e6-8029-c083fbb75ff9.png)
2. Select the Layer you are interested in altering. As we're not looking forward to remap any of the existing main keys, we need to go to layer 2, 3 or 4. In my case, with a Keychron Q2, I know that Layer 4 can be accessed by pressing on "Fn2". Thus, I select that layer.
<img width="1445" alt="Screenshot 2023-05-06 at 11 10 06 PM" src="https://user-images.githubusercontent.com/25267873/236660841-09203874-8a8e-4393-8674-357aad67a22b.png">
![Layer](https://user-images.githubusercontent.com/25267873/236660841-09203874-8a8e-4393-8674-357aad67a22b.png)
3. Most keys should have a triangle upside down which simbolizes that they don't have any functionality. You want to select one of those keys to contain your hotkey routine. After that selection you want to remap the key functionality, hence in the **KEYMAP settings** below you click on MACROS tab and select "MO". Now the screen should look like this:
<img width="1454" alt="Screenshot 2023-05-06 at 11 13 43 PM" src="https://user-images.githubusercontent.com/25267873/236660948-a148582e-f928-4f12-ae54-9bdd3adfd020.png">
![Layer](https://user-images.githubusercontent.com/25267873/236660948-a148582e-f928-4f12-ae54-9bdd3adfd020.png)
4. Now we want to change what "MO" does and for that we select the **MACROS settings** below. Then we can select "M0" and insert `dps/psi/../fa/pt/income/..{KC_ENT}`. The screen should look like this:
<img width="1453" alt="Screenshot 2023-05-06 at 11 17 52 PM" src="https://user-images.githubusercontent.com/25267873/236661126-eeb5dc7c-2c01-4a43-ab64-12c470e864ce.png">
![Macro](https://user-images.githubusercontent.com/25267873/236661126-eeb5dc7c-2c01-4a43-ab64-12c470e864ce.png)
Note that the `{KC_ENT}` will ensure that the command is run on the terminal.
Note that the `{KC_ENT}` will ensure that the command is run on the terminal.
5. Save. To ensure that everything is correct you can go into the **KEYMAP settings** and click on the hotkey that you just created to see if it contains the sequence of commands, the following sequence should appear:
<img width="1434" alt="Screenshot 2023-05-06 at 11 20 24 PM" src="https://user-images.githubusercontent.com/25267873/236661232-4f9119de-af37-49a2-948d-cfd6d650ed92.png">
![Save](https://user-images.githubusercontent.com/25267873/236661232-4f9119de-af37-49a2-948d-cfd6d650ed92.png)
6. Finally, we are ready to test it on the [OpenBB Terminal](https://my.openbb.co/app/terminal). After going into `stocks` and doing `load AAPL`, I pressed "Fn2'+Z which lead to:
<img width="1784" alt="Screenshot 2023-05-06 at 10 53 49 PM" src="https://user-images.githubusercontent.com/25267873/236660272-290fe586-7663-4cd6-bfc0-80b7f8f2efd1.png">
![Test](https://user-images.githubusercontent.com/25267873/236660272-290fe586-7663-4cd6-bfc0-80b7f8f2efd1.png)
PS: If you prefer to see this in video format, you can do so by checking the following video.