CLI tool

Use the CLI tool to interact with data, export, drive tasks and automate activity. The CLI tool is available as native binaries for various platforms, as well as packages for some OSs, and Docker images.

Binaries are made available for Linux, FreeBSD, Darwin (Mac) and Windows, on amd64/x86_64 and arm64; published to Github, alongside release notes for each update.

The CLI tool is packaged for Arch Linux and available through the AUR, it can be installed with yay or pacman:

yay -S aur/awts-cli-bin

Post-install

Once installed, run it from the command line with the awts command. Running with no parameters will display help information, including a list of available commands:

❯ awts
AWTS CLI interface - Command line tool for interacting with AWTS environments

Usage:
  cli [command]

Available Commands:
  admin       Administrative outputs, including license status/details
  book        Interact with books (see subcommands)
...

Configuration

The most important piece of information for the CLI tool is telling it where your local AWTS environment is running, by specifying a DSN to the mux service.

In standard installs the DSN is just a host:port and the correct value to use will be specified in the installation instructions provided by the Configurator:

❯ awts --mux=localhost:35000 mux
┌────────────┬─────────────────┬───────────┬──────────┬─────────┐
│ INSTANCEID │ HOST            │ SERVICES  │ PREFIXES │  STATUS │
├────────────┼─────────────────┼───────────┼──────────┼─────────┤
│ webdash    │ localhost:35399 │ [dash]    │ []       │  Online │
└────────────┴─────────────────┴───────────┴──────────┴─────────┘

Show a list of all configuration arguments by using --help. The --help argument can also be used on specific commands to show information specific to that command; e.g. exporting market data takes additional arguments such as start/end dates, timeframe/resolution, etc.

Configuration may be provided as command line arguments as shown above, but can also be driven from a configuration file and/or environment variables. See the CLI tool documentation for more.