# Command Line Reference ## pyaptly Show basic command group. ### Usage ``` Usage: pyaptly [OPTIONS] COMMAND [ARGS]... ``` ### Options * `version`: * Type: BOOL * Default: `false` * Usage: `--version` Show the version and exit. * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly [OPTIONS] COMMAND [ARGS]... Show basic command group. Options: --version Show the version and exit. --help Show this message and exit. Commands: legacy run legacy command parser mirror Manage aptly mirrors. publish Manage aptly publishs. repo Create aptly repos. snapshot Manage aptly snapshots. toml-to-toml Convert pyaptly config files from toml to toml. yaml-to-toml Convert pyaptly config files from yaml to toml. ``` ## pyaptly legacy run legacy command parser ### Usage ``` Usage: pyaptly legacy [OPTIONS] [PASSTHROUGH]... ``` ### Options * `passthrough`: * Type: STRING * Default: `none` * Usage: `passthrough` * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly legacy [OPTIONS] [PASSTHROUGH]... run legacy command parser Options: --help Show this message and exit. ``` ## pyaptly mirror Manage aptly mirrors. ### Usage ``` Usage: pyaptly mirror [OPTIONS] CONFIG [create|update] ``` ### Options * `info`: * Type: BOOL * Default: `false` * Usage: `--info -i` * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `pretend`: * Type: BOOL * Default: `false` * Usage: `--pretend -p` Do not change anything * `config` (REQUIRED): * Type: * Default: `none` * Usage: `config` * `task` (REQUIRED): * Type: Choice('['create', 'update']') * Default: `none` * Usage: `task` * `mirror_name`: * Type: STRING * Default: `all` * Usage: `--mirror-name -n` default: "all" * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly mirror [OPTIONS] CONFIG [create|update] Manage aptly mirrors. Options: -i, --info / -ni, --no-info -d, --debug / -nd, --no-debug -p, --pretend / -np, --no-pretend Do not change anything -n, --mirror-name TEXT default: "all" --help Show this message and exit. ``` ## pyaptly publish Manage aptly publishs. ### Usage ``` Usage: pyaptly publish [OPTIONS] CONFIG [create|update] ``` ### Options * `info`: * Type: BOOL * Default: `false` * Usage: `--info -i` * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `pretend`: * Type: BOOL * Default: `false` * Usage: `--pretend -p` Do not change anything * `config` (REQUIRED): * Type: * Default: `none` * Usage: `config` * `task` (REQUIRED): * Type: Choice('['create', 'update']') * Default: `none` * Usage: `task` * `publish_name`: * Type: STRING * Default: `all` * Usage: `--publish-name -n` default: "all" * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly publish [OPTIONS] CONFIG [create|update] Manage aptly publishs. Options: -i, --info / -ni, --no-info -d, --debug / -nd, --no-debug -p, --pretend / -np, --no-pretend Do not change anything -n, --publish-name TEXT default: "all" --help Show this message and exit. ``` ## pyaptly repo Create aptly repos. ### Usage ``` Usage: pyaptly repo [OPTIONS] CONFIG [create] ``` ### Options * `info`: * Type: BOOL * Default: `false` * Usage: `--info -i` * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `pretend`: * Type: BOOL * Default: `false` * Usage: `--pretend -p` Do not change anything * `config` (REQUIRED): * Type: * Default: `none` * Usage: `config` * `task` (REQUIRED): * Type: Choice('['create']') * Default: `none` * Usage: `task` * `repo_name`: * Type: STRING * Default: `all` * Usage: `--repo-name -n` default: "all" * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly repo [OPTIONS] CONFIG [create] Create aptly repos. Options: -i, --info / -ni, --no-info -d, --debug / -nd, --no-debug -p, --pretend / -np, --no-pretend Do not change anything -n, --repo-name TEXT default: "all" --help Show this message and exit. ``` ## pyaptly snapshot Manage aptly snapshots. ### Usage ``` Usage: pyaptly snapshot [OPTIONS] CONFIG [create|update] ``` ### Options * `info`: * Type: BOOL * Default: `false` * Usage: `--info -i` * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `pretend`: * Type: BOOL * Default: `false` * Usage: `--pretend -p` Do not change anything * `config` (REQUIRED): * Type: * Default: `none` * Usage: `config` * `task` (REQUIRED): * Type: Choice('['create', 'update']') * Default: `none` * Usage: `task` * `snapshot_name`: * Type: STRING * Default: `all` * Usage: `--snapshot-name -n` default: "all" * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly snapshot [OPTIONS] CONFIG [create|update] Manage aptly snapshots. Options: -i, --info / -ni, --no-info -d, --debug / -nd, --no-debug -p, --pretend / -np, --no-pretend Do not change anything -n, --snapshot-name TEXT default: "all" --help Show this message and exit. ``` ## pyaptly toml-to-toml Convert pyaptly config files from toml to toml. ### Usage ``` Usage: pyaptly toml-to-toml [OPTIONS] IN_PATH TOML_PATH ``` ### Options * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `in_path` (REQUIRED): * Type: * Default: `none` * Usage: `in_path` * `toml_path` (REQUIRED): * Type: * Default: `none` * Usage: `toml_path` * `add_defaults`: * Type: BOOL * Default: `false` * Usage: `-a --add-defaults` Add default values to fields if missing * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly toml-to-toml [OPTIONS] IN_PATH TOML_PATH Convert pyaptly config files from toml to toml. Options: -d, --debug / -nd, --no-debug -a, --add-defaults / -na, --no-add-defaults Add default values to fields if missing --help Show this message and exit. ``` ## pyaptly yaml-to-toml Convert pyaptly config files from yaml to toml. ### Usage ``` Usage: pyaptly yaml-to-toml [OPTIONS] YAML_PATH TOML_PATH ``` ### Options * `debug`: * Type: BOOL * Default: `false` * Usage: `--debug -d` * `yaml_path` (REQUIRED): * Type: * Default: `none` * Usage: `yaml_path` * `toml_path` (REQUIRED): * Type: * Default: `none` * Usage: `toml_path` * `add_defaults`: * Type: BOOL * Default: `false` * Usage: `-a --add-defaults` Add default values to fields if missing * `help`: * Type: BOOL * Default: `false` * Usage: `--help` Show this message and exit. ### CLI Help ``` Usage: pyaptly yaml-to-toml [OPTIONS] YAML_PATH TOML_PATH Convert pyaptly config files from yaml to toml. Options: -d, --debug / -nd, --no-debug -a, --add-defaults / -na, --no-add-defaults Add default values to fields if missing --help Show this message and exit. ```