AutoShip CLI¶
Local-first intelligent delivery assistant
AutoShip-CLI helps developers automate cleanup, verification, commit, and upload workflows after development. All core processing runs locally by default; your code never needs to leave your machine.
Core Features¶
- Local-first: Uses local AI models and local toolchains by default to avoid code leaks.
- Plugin-based: Hook system powered by pluggy for easy extension.
- Model tiers: Automatically routes tasks across different model tiers based on hardware and task type.
- Safe and reliable: Audit logging, credential encryption, plugin sandbox, and pre-commit security scans.
Installation¶
We recommend installing with pipx to keep dependencies isolated:
Or use uv:
Developers can clone the repository and use uv directly:
Quick Start¶
Run these commands in your project root:
# Initialize AutoShip configuration
autoship init
# Clean and format code
autoship clean
# Generate commit message and commit
autoship commit
# Run verification
autoship verify pytest
# Upload artifacts (example: Docker)
autoship upload --target docker --image myapp --tag latest
Global Options¶
All commands support the following global options:
| Option | Description |
|---|---|
-v, --verbose |
Output more detailed logs |
-n, --dry-run |
Preview actions without actually executing them |
-y, --yes |
Skip interactive confirmations |
-c, --config PATH |
Specify a custom configuration file path |
Next Steps¶
- See the Command Reference for detailed usage of each command.
- See Configuration for
.autoship.tomloptions. - See Plugins and the Plugin Development Guide to learn how to extend AutoShip.