Getting started
Apps and Commands
Everything before this page is about the Terminal itself. The Terminal is the browser; the apps (also called modules) are what you browse. Each app does one thing: a scanner, a chart, a table.
Every pane has two parts, like a page in a web browser:
- The command bar, like the URL bar: the command that configures the app.
- The app body, like the website itself.
You do not have to type
Click the ⚙️ at the right of the command bar. It opens the control panel, where every parameter of the app is a field. What you set there is written into the command bar, and what you type in the bar shows in the panel. Use whichever you like.
Commands are still worth knowing: a command is the whole configuration in one line, so you can copy it, share it and paste it.
How a command is written
app [SYMBOL] [PARAMETER] [name=value ...]
- The first word is the app:
joy. - Then what the app requires, in order. Most apps need a symbol (
aapl). Some also need the option parameter to show (oi). Scanners such asflowneed neither. - Then the options, in any order, each as
name=valuewith no spaces around the=:exp=1-5,rng=10.
The words are separated by single spaces. Upper or lower case does not matter for symbols: joy aapl oi and joy AAPL oi are the same.
Kinds of values
| Kind | How to write it | Example |
|---|---|---|
| On or off | The name alone turns it on. name=f turns it off. |
flip, curve=f |
| A number | A whole number, no decimals. | limit=20 |
| A list | Values separated by commas, no spaces. | cols=value,price,change |
| Expirations | Numbers counted from the nearest (1), ranges, or both. |
exp=1, exp=1-5, exp=1-5,10 |
| Filters | Conditions separated by commas: a column, then >, < or =, then a number. |
filters=value>1000000,volm>100 |
When a value is not valid, the pane says so and lists the valid ones.
The global symbol
Write @ in place of the symbol and the pane follows the global symbol:
The apps
Each app has a page with its command, every parameter and examples to copy: see the list of apps. The names of the columns and option parameters are on the Data Parameters page.
The first app: flow