Skip to main content
The tplus command-line interface is installed automatically when you pip install tpluspy. It gives you full shell access to every T+ service — from managing local signing accounts and placing orders to streaming live market data and executing on-chain deposits and withdrawals. Run tplus --help at any time to see the top-level command tree.

Global options

Every tplus subcommand accepts the following flags and respects the corresponding environment variables. You can set environment variables in your shell profile or in a .env file to avoid repeating them on every invocation.
FlagEnvironment variableDescription
--account <alias>TPLUS_ACCOUNTDefault local account alias used by signing, OMS, and settle commands.
--orderbook-base-url <url>TPLUS_ORDERBOOK_BASE_URLOrderbook / OMS service base URL. Also used by settle and withdraw commands.
--clearing-base-url <url>TPLUS_CLEARING_BASE_URLClearing engine base URL, used by admin, registry, and vault commands.
--market-data-base-url <url>TPLUS_MARKET_DATA_BASE_URLMarket-data service base URL. Used by markets depth, markets klines, and the stream subcommands.
--ignore-sslTPLUS_IGNORE_SSLSkip TLS certificate verification. Useful for local development with self-signed certificates.
--output-format <fmt>TPLUS_OUTPUT_FORMATOutput format for list and address commands. See Output formats below.
(flag not supported)TPLUS_PASSWORDPassword used to encrypt and decrypt local keyfiles, bypassing the interactive getpass prompt. Intended for automation — avoid using in shared shells.

Output formats

The --output-format flag (or TPLUS_OUTPUT_FORMAT env var) controls how results are rendered. Three values are accepted:
ValueBehaviour
tableHuman-readable table. This is the default.
jsonStructured JSON output, suitable for programmatic consumption.
rawPrints the underlying chain address string (<address>@<chain>) one per line, useful for piping into scripts.
# Print asset list as JSON
tplus assets list --output-format json

# Inspect env-var state as JSON
tplus env --output-format json
Set TPLUS_OUTPUT_FORMAT=json in CI or automation scripts to get machine-readable output without passing the flag on every command.

Log file

The CLI writes rotating logs to ~/.tplus/cli/logs/tplus.log. The log rotates at 1 MB and keeps up to three historical files. Check this file first when you encounter unexpected behaviour.

Inspecting environment variables

Run tplus env to see which CLI-relevant environment variables are currently set and what values they hold:
tplus env
tplus env --output-format json
tplus env is especially handy after sourcing a .env file — it confirms that the CLI has picked up the correct base URLs and account alias before you run any live commands.

CLI pages

Accounts

Create and manage local Ed25519 signing accounts, and sign arbitrary payloads.

Orders

Place limit and market orders, cancel, replace, transfer inventory, and view balances.

Markets

Create markets, query order book depth, and fetch OHLCV klines.

Deposits & Withdrawals

Deposit tokens on-chain and initiate or execute withdrawals through the OMS.

Streaming

Subscribe to live WebSocket feeds for orders, trades, depth, and klines.