Skip to content

CLI Reference

The package installs one command-line entrypoint:

acs-refresh

acs-refresh refresh

Generate or update cached completion artifacts.

acs-refresh refresh \
  --factory mypackage.cli:build_parser \
  --cli-name mycli \
  --distribution mycli

Arguments

  • --factory: import path in module:callable form
  • --cli-name: logical CLI name used in cache layout and generated shell symbols
  • --distribution: distribution name recorded in the snapshot metadata
  • --cache-root: cache base directory, default ~/.cache
  • --entrypoint: executable name to inspect at runtime
  • --fallback-command: explicit dynamic resolver fallback command
  • --package-version: override package version metadata
  • --force: rebuild artifacts even if the cache looks current

Output

The command prints a JSON object describing the refresh result, including:

  • cli_name
  • distribution
  • package_version
  • fingerprint
  • refreshed
  • cache_dir

acs-refresh print-activation

Render the Bash activation snippet without writing shell startup files directly.

acs-refresh print-activation \
  --factory mypackage.cli:build_parser \
  --cli-name mycli \
  --distribution mycli

Arguments

This subcommand accepts the shared arguments:

  • --factory
  • --cli-name
  • --distribution
  • --cache-root
  • --entrypoint
  • --fallback-command

Factory requirements

--factory must point to a callable that returns an argparse.ArgumentParser. If the separator is missing, the CLI raises a ValueError.