The fastboxex command¶
The one command a student needs. It is installed with the SDK.
| Command | What it does |
|---|---|
fastboxex setup |
Save your login and password centrally |
fastboxex doctor |
Check the installation and measure the connection |
fastboxex run SCRIPT [OPTIONS] |
Run a Python script with the SDK's interpreter |
fastboxex tui [OPTIONS] |
Start the terminal UI |
fastboxex where |
Print paths, versions and the TUI location |
setup¶
fastboxex setup # asks for login and password
fastboxex setup --user alice # asks only for the password
fastboxex setup --host 10.0.0.5 # use this one server instead of the default list
fastboxex setup --force # replace an existing Config.toml with the default
It writes .env (credentials, readable only by you) and, unless one exists,
Config.toml (servers). The password is never a command-line argument, so it stays
out of your shell history. Without a terminal, set FASTBOXEX_USER and
FASTBOXEX_PASS first.
doctor¶
fastboxex doctor # log in to the exchange
fastboxex doctor --runtime arena # log in to the arena runtime
fastboxex doctor --seconds 20 # sample the market feed for longer
| Line | Meaning | If it is wrong |
|---|---|---|
config, credentials |
The files in use | none found: run fastboxex setup |
server |
One line per server. One reachable is enough |
All unreachable: check your network |
runtimes |
What your account may log in to | authentication failed: check your password |
login |
User id and login time | login failed: the reason follows |
feed |
Books received and their delay | no market data received: the port may be blocked |
arena |
Arenas in use and traders allowed | 0 traders allowed: ask your teacher for arena access |
It ends with done, done, with warnings or failed, and exits non-zero only on
failed. Send the whole output when you ask for help: it holds no password.
run¶
Options after the script go to the script. It always uses the Python that holds the SDK, whichever environment is active.
tui¶
fastboxex tui # the login screen, or straight in with saved settings
fastboxex tui --runtime arena # go straight to the arena runtime
Options go to fastboxex-tui. See Terminal UI.