Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.98 KB

README.md

File metadata and controls

37 lines (26 loc) · 1.98 KB

Voltage CLI documentation

Start with the README for install and a quick start, or follow getting started from install to a settled test payment.

Do a task

  • Install: platforms, download verification, building from source, credential stores, completions
  • Log in and use profiles: browser login, API keys, scope, profiles, voltage context
  • Wallets: create, inspect, ledger, policies, delete
  • Payments: receive, send, wait, invoices, quotes, prices
  • Requests: request bodies, friendly flags, filters, paging
  • Webhooks: create with a saved secret, events, deliveries, key rotation
  • Checkout: session and stream tokens, events
  • Troubleshooting: what each exit code and error means, and the fix
  • Scripting: JSON, VOLTAGE_EXECUTE, running without a person

Look it up

Understand

  • Safety model: --execute, described changes, payment IDs, Ctrl-C, redaction

For AI agents

Use --json and branch on exit codes. Run a change without --execute to describe it (exit code 6), then send it with --execute. Never pass --show-secrets. For product concepts, see the Voltage API docs.

For contributors