Command Reference¶
AutoShip CLI commands follow a unified lifecycle: load configuration, invoke pre_* hooks, execute the command body, invoke post_* hooks, and record audit logs. This reference provides the full syntax, arguments, options, and examples for every command.
Global Options¶
These options apply to all commands and are usually placed before the subcommand (e.g. autoship --verbose init):
| Short | Long | Default | Description |
|---|---|---|---|
-v |
--verbose |
False |
Verbose output |
-n |
--dry-run |
False |
Preview actions without executing |
-y |
--yes |
False |
Skip interactive confirmations |
-c |
--config PATH |
- | Path to configuration file |
| - | --lang TEXT |
auto |
Output language (en, zh, auto) |
| - | --install-completion |
- | Install shell completion |
| - | --show-completion |
- | Show shell completion script |
View global options at any time:
Command List¶
| Command | Description | Subcommands |
|---|---|---|
| init | Initialize an AutoShip configuration file for the project | - |
| clean | Clean and format project code | - |
| verify | Run a verification command and capture errors for AI-assisted fixing | - |
| fix | Ask an LLM to propose a fix for the last verification failure | - |
| commit | Generate a commit message and commit changes | - |
| upload | Upload artifacts to a configured target | - |
| plugin | Manage plugins | list, search, info, install, uninstall, rate, stats, trust, update |
| doctor | Diagnose the AutoShip environment and dependencies | - |
| audit | Export or clean up audit logs | export, cleanup |
| registry | Browse the plugin registry and sync the index | list, dashboard, sync |
| metrics | Inspect runtime metrics | show, export |
| config | Inspect and manage AutoShip configuration | list, get, telemetry |
Document Structure¶
index.md(this page): global options and command index.<command>.md: standalone reference page for each command, including overview, syntax, arguments, options, examples, output notes, and related commands.- Complex commands (
plugin,audit,registry,metrics,config) include detailed subcommand sections.
Contributing¶
Keep the command reference consistent with the actual CLI --help output. Before editing, run:
When adding a new command, update the table on this page and the mkdocs.yml navigation.