Skip to content

CLI Reference

This reference is organized around the two executable roles in Tidal:

  • tidal: the API-backed CLI client
  • tidal-server: the server operator CLI

Both commands read the same home-based runtime layout by default:

  • ~/.tidal/config.yaml
  • ~/.tidal/.env
  • ~/.tidal/auction_pricing_policy.yaml

Run tidal init once on a machine before using either command.

How To Use This Section

Start with the overview page for your role, then use the command-specific pages for exact workflows and flags.

Role Start here Command groups
CLI client CLI Client Overview tidal init, tidal kick, tidal auction, tidal logs
Server operator Server Operator CLI Overview tidal-server db, tidal-server scan, tidal-server api, tidal-server auth, tidal-server kick, tidal-server auction, tidal-server logs

Shared Patterns

Preview first

Mutating transaction commands default to preview mode. Add --broadcast to actually sign and send a transaction.

Local signing

Broadcasting commands share the same wallet surface:

  • --sender
  • --account
  • --keystore
  • --password-file

The private key stays with the machine running the CLI.

Machine-readable output

Most read and write commands accept --json for scripting and automation.

Config overrides

Both executables support path overrides such as --config and the TIDAL_* environment variables documented in Configuration.

Choose The Right CLI

Use tidal when:

  • you are a remote operator calling the hosted or self-hosted API
  • you want the server to own shared state and audit history
  • you want wallet signing to stay local to your workstation

Use tidal-server when:

  • you are operating the host that owns the shared database
  • you are running the scanner, API, or auth management
  • you intentionally want transactions to execute from the server itself