|
| 1 | +# authy-cli |
| 2 | + |
| 3 | +A CLI secrets store & dispatch tool built for AI agents. |
| 4 | + |
| 5 | +Authy stores encrypted secrets locally and dispatches them to agents with policy-based scoping, short-lived session tokens, and audit logging. No server required. |
| 6 | + |
| 7 | +## Install |
| 8 | + |
| 9 | +```bash |
| 10 | +npx authy-cli --help |
| 11 | +``` |
| 12 | + |
| 13 | +Or install globally: |
| 14 | + |
| 15 | +```bash |
| 16 | +npm install -g authy-cli |
| 17 | +authy --help |
| 18 | +``` |
| 19 | + |
| 20 | +### Other install methods |
| 21 | + |
| 22 | +```bash |
| 23 | +# Linux/macOS |
| 24 | +curl -fsSL https://raw.githubusercontent.com/eric8810/authy/main/install.sh | sh |
| 25 | + |
| 26 | +# Windows (PowerShell) |
| 27 | +irm https://raw.githubusercontent.com/eric8810/authy/main/install.ps1 | iex |
| 28 | +``` |
| 29 | + |
| 30 | +## Quick Start |
| 31 | + |
| 32 | +```bash |
| 33 | +# Initialize a vault with a keyfile |
| 34 | +authy init --generate-keyfile ~/.authy/keys/master.key |
| 35 | + |
| 36 | +# Store a secret (reads from stdin) |
| 37 | +authy store db-url |
| 38 | + |
| 39 | +# Retrieve it |
| 40 | +authy get db-url |
| 41 | + |
| 42 | +# Launch the admin TUI (secrets never touch shell history) |
| 43 | +authy admin --keyfile ~/.authy/keys/master.key |
| 44 | +``` |
| 45 | + |
| 46 | +## Agent Workflow |
| 47 | + |
| 48 | +```bash |
| 49 | +# Create a scoped policy |
| 50 | +authy policy create deploy-agent --allow "db-*" --deny "openai-*" |
| 51 | + |
| 52 | +# Create a short-lived session token |
| 53 | +authy session create --scope deploy-agent --ttl 1h |
| 54 | + |
| 55 | +# Agent uses the token to read only allowed secrets |
| 56 | +export AUTHY_TOKEN="authy_v1...." |
| 57 | +export AUTHY_KEYFILE=~/.authy/keys/master.key |
| 58 | +authy get db-url # works |
| 59 | +authy get openai-api-key # denied |
| 60 | + |
| 61 | +# Or inject secrets into a subprocess |
| 62 | +authy run --scope deploy-agent -- ./deploy.sh |
| 63 | +``` |
| 64 | + |
| 65 | +## Supported Platforms |
| 66 | + |
| 67 | +| Platform | Architecture | |
| 68 | +|----------|-------------| |
| 69 | +| Linux | x64, arm64 | |
| 70 | +| macOS | x64, arm64 | |
| 71 | +| Windows | x64 | |
| 72 | + |
| 73 | +## Documentation |
| 74 | + |
| 75 | +For full documentation, see the [GitHub repository](https://github.com/eric8810/authy). |
| 76 | + |
| 77 | +## License |
| 78 | + |
| 79 | +MIT |
0 commit comments