Skip to main content

Deputy CLI

Command-Line-Interface (CLI) program, that acts as a client for the Deputy Package Server repository.

Usage​

deputy <SUBCOMMAND>

Options​

-h, --help - Print help information
-v, --version - Print version information

Subcommands​

Checksum​

Download package checksum.

Usage:

  • deputy checksum [OPTIONS] <PACKAGE_NAME>

Arguments:

  • <PACKAGE_NAME>

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for package fetching [default: main-registry]
  • -v, --version-requirement <VERSION_REQUIREMENT> - Version of the package to fetch [default: *]

Create​

Create a new package.

Usage:

  • deputy create [OPTIONS]

Options:

  • -h, --help - Print help information
  • -p, --package-path <PACKAGE_PATH> - Path for the package [default: .]
  • -v, --version <VERSION> - Initial version for the package.toml [default: 0.1.0]

Fetch​

Download package.

Usage:

  • deputy fetch [OPTIONS] <PACKAGE_NAME>

Arguments:

  • <PACKAGE_NAME>

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for package fetching [default: main-registry]
  • -s, --save-path <SAVE_PATH> - Save path for the package [default: .]
  • -u, --unpack-level <UNPACK_LEVEL> - [default: regular][possible values: raw, uncompressed, regular]
  • -v, --version-requirement <VERSION_REQUIREMENT> - Version of the package to fetch [default: *]

By default the command deputy fetch uses semver syntax, which can be unclear when using the command.

For example, assuming there are versions 1.0.0, 1.0.5, 1.0.10 and 1.3.10 on the server of a package called Cowboy. The command deputy fetch --version-requirement 1.0.5 Cowboy will always download the latest patch version of the package, in this case 1.0.10. This is because 1.0.5 is equal to ^1.0.5. To download the correct patch version it needs to be typed as deputy fetch --version-requirement =1.0.5 Cowboy.

Help​

Print this message or the help of the given subcommand(s).

Info​

Get detailed information of a package.

Usage:

  • deputy info [OPTIONS] <SEARCH_TERM>

Arguments:

  • <SEARCH_TERM> - show package details

Options:

  • -a - Show all versions of the package. By default, only the latest version is shown
  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for versioning [default: main-registry]

Inspect​

Validate local package.toml file and prints the package.toml file contents.

Usage:

  • deputy inspect [OPTIONS]

Options:

  • -h, --help - Print help information
  • -p, --package-path <PACKAGE_PATH> - Path for the package [default: .]
  • --pretty - Formats the print output

List​

List all packages.

Usage:

  • deputy list [OPTIONS] <SEARCH_TERM>

Arguments:

  • <SEARCH_TERM> - List packages matching the search term. If no search term is provided, all packages are listed.

Options:

  • -c, --category <CATEGORY> - Filter packages by category. Supports multiple categories separated by commas
  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for versioning [default: main-registry]
  • -t, --type <PACKAGE_TYPE> - Filter packages by type

Login​

Login to registry

Usage:

  • deputy login [OPTIONS]

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for publishing [default: main-registry]
  • -T, --token <TOKEN> - Set the login token as parameter

Normalize-version​

Return latest version of a package.

Usage:

  • deputy normalize-version [OPTIONS] <PACKAGE_NAME>

Arguments:

  • <PACKAGE_NAME>

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for versioning [default: main-registry]
  • -v, --version-requirement <VERSION_REQUIREMENT> - Version of the package to fetch [default: *]

Owner​

Manage the owners of a package on the registry.

Usage:

  • deputy owner [OPTIONS] [SUBCOMMAND]

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for versioning [default: main-registry]

Subcommands:

  • help - Print this message or the help of the given subcommand(s)
  • add - Add given user as an owner
  • remove - Remove given user as an owner
  • list - List owners

Publish​

Upload package.

Usage:

  • deputy publish [OPTIONS]

Options:

  • c, --compression <COMPRESSION> - Compression rate before upload [default: 0]
  • -h, --help - Print help information
  • -p, --path <PATH> - Path to the package to publish
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for publishing [default: main-registry]
  • -t, --timeout <TIMEOUT> - Timeout before publish fails [default: 300]
  • -T, --token <TOKEN> - Override the login token

Executing the command deputy publish will upload the package to the server only if you're located in a folder, where the package.toml file is, or in any of its parent folders, as the search for the package.toml file is executed top-to-bottom.

Yank​

Remove previously published package's version from the registry.

Usage:

  • deputy yank [OPTIONS] <PACKAGE_NAME> <VERSION_REQUIREMENT>

Arguments:

  • <PACKAGE_NAME>
  • <VERSION_REQUIREMENT> - Version of the package to yank

Options:

  • -h, --help - Print help information
  • -r, --registry-name <REGISTRY_NAME> - Registry to use for version yanking [default: main-registry]
  • -T, --token <TOKEN> - Override the login token
  • -u, --undo - Undo yank