⭐ If you find Zipline useful, please consider giving it a star on Github! ⭐
GuidesCTL

ziplinectl

Manage specific parts of your Zipline instance with the ziplinectl command line utility

Zipline provides a command line utility called ziplinectl to manage specific parts of your Zipline instance.

Accessing ziplinectl

In the documentation, this value will be referred to as ziplinectl.

docker compose exec zipline ziplinectl <...>

or

docker compose exec zipline pnpm ctl <...>
pnpm ctl <...>

Help Screen (-h, --help)

Output the help screen for ziplinectl

~/zipline $ ziplinectl -h

Usage: ziplinectl [options] [command]

control utility for zipline

Options:
  -V, --version                          output the version number
  -h, --help                             display help for command

Commands:
  read-config [options]                  output the configuration as json, exactly how Zipline sees it
  export-config [options]                output the configuration as environment variables
  list-users [options]                   list all users
  set-user [options] <property> <value>
  import-dir [options] <directory>
  help [command]                         display help for command

Version (-V, --version)

Output the version of zipline

ziplinectl -V

Commands