DocsReference

Help

Reference

Command-line flags, environment variables, the files zeroterm keeps, and where to read the code.

Command line

CommandWhat it does
zerotermThe full-screen terminal (the default).
zeroterm --webThe same terminal in your browser, on 127.0.0.1.
zeroterm --web --port 8080Browser mode on another port (default 7979).
zeroterm --hostsEvery host zeroterm talks to with your settings, and why.
zeroterm --helpA short summary of the above.
zeroterm --versionThe version.

Without the alias from Install, use pnpm start -- <flags> from the zeroterm folder, or node apps/cli/dist/main.js <flags>.

Environment variables

VariableDefaultEffect
ZEROTERM_HOME~/.zerotermWhere the vault, settings and receipts live.
ZEROTERM_RPC_URLfrom settingsUse this RPC for this run, without saving it.
ZEROTERM_WS_URLfrom settingsUse this websocket for this run, without saving it.
ZEROTERM_JUPITER_API_KEYfrom settingsUse this Jupiter key for this run, without saving it.
ZEROTERM_PORT7979Browser mode's port, when --port is not given.

Files

Everything zeroterm keeps is in ~/.zeroterm/ (or ZEROTERM_HOME). The folder is readable only by you (mode 700), and so is each file (mode 600).

FileWhat is in it
vault.jsonThe scrypt parameters and salt, a check value, and every wallet's secret key under AES-256-GCM. Public keys and wallet names are in the clear. The wallet menu (W) shows a key after the passphrase.
config.jsonYour settings: RPC and extra RPCs, routes and their keys, each speed's priority fee, tip and tip route, trade presets, and the comparison terminal.
trades.jsonlOne receipt per line, newest last.

The code

PathWhat it is
packages/engineThe venues and the router that finds where a coin trades, transaction building, the multi-route send, receipts, the vault and the coin feeds.
apps/cliThe zeroterm command: the full-screen terminal, and the local server for browser mode.
apps/webThe browser mode's page.
apps/siteThis website.

ARCHITECTURE.md walks through one trade step by step and lists the local server's API. DECISIONS.md records what was decided and why, and ROADMAP.md what comes next.

Contributing

See CONTRIBUTING.md. In short: no fee anywhere, nothing leaves the machine that does not have to, few dependencies, and every decision written down.

↑ ↓ to move · ⏎ to open