Voltage CLI

Use the Voltage CLI to work with the Voltage API from your terminal. The voltage command lets you inspect wallets, create and track payments, work with quotes and webhooks, and automate account operations. You can run commands yourself or ask your coding agent to run them for you.

The CLI is open source and available for macOS, Linux, and Windows. See the Voltage CLI repository for source code and the full reference.

If your agent has the current Agent Skill PackVoltage Agent Skill Pack, its voltage-api skill includes knowledge of the CLI: installation, authentication, profiles, commands, and payment outcomes. An agent with terminal access can help install the CLI and drive it on your behalf.

Install the skill pack with Node.js/npm available:

This installs skills across supported agent harnesses. Omit --all to choose agents interactively. Installing the skills does not install the CLI or sign in to Voltage. If you installed the pack before CLI support was added, update it using the instructions on the Agent Skill Pack page.

Open a new agent session and try:

Once connected, you can ask:

Complete browser login yourself when prompted. Give the agent the intended environment, wallet, and task; keep credentials out of the conversation. The CLI and its profiles use your existing account permissions.

Verify the installation:

The examples on this page use release v0.1.0. Check the release instructions and your installed command's --help when using another version.

Start with browser login:

Follow the browser prompt to sign in and complete MFA. On a remote machine, add --no-browser and open the verification URL yourself.

Replace ORG_ID and ENV_ID below with the IDs for your intended organization and environment. Save them in a profile:

A profile saves your organization, environment, and credential selection. The name dev is just a label: inspect the selected wallet's network before making test payments. If you need a development wallet, start with the Wallet Setup GuideWallet Setup Guide and Staging EnvironmentStaging Environment.

Use a wallet ID from the list above:

Add --json for scripts or agent use:

With a confirmed Mutinynet Bitcoin wallet, create a 150-sat invoice:

--wait ready waits for the invoice to be available. Pay it from another compatible test wallet, then use the returned payment ID to check settlement:

An accepted request or a generated invoice does not mean the payment is complete. If the wait times out, keep the payment ID and check it again. See the command reference for additional operations.

For scripts, import an environment API key using the hidden input prompt:

Create the key in the intended environment as described in the Developer GuideDeveloper Guide. Organization and environment discovery commands require browser login; obtain those IDs before configuring key-based automation.

The CLI normally stores credentials in your operating system's credential store. For headless Linux without an unlocked Secret Service, use --credential-store file when importing the key; this stores credentials in an owner-only file. CLI profiles live under $XDG_CONFIG_HOME/voltage or ~/.config/voltage. The CLI does not read the agent skill's direct-request helper file at ~/.voltage/.env.

For automated payments, inspect the returned business outcome as well as the command's exit code. Reconcile an uncertain submission by its existing payment ID before retrying. Commands returning one-time secrets, such as webhook creation, support --output-file PATH to save the response privately.

Use the CLI README for more examples and output conventions. For building an application integration, continue with the Developer GuideDeveloper Guide and Voltage API reference.