Utila CLI

The Utila CLI is a command-line tool for interacting with the Utila API. With it, you can:

• Manage vaults, transactions, and other API resources
• Set up devices and retrieve key shares for transaction signing
• Sign transactions
• Run the Utila Co-Signer to support automated workflows

Install the CLI

Download the CLI 1.5.0 or later from the Resource Center in the Utila console. See also Downloads.

Examples below use utila - use your file name, or rename it to utila.

Make it runnable, then check the version:

chmod +x ./utila
./utila --version

You’re ready for the next step when this prints a version of 1.5.0 or later.

macOS: If macOS blocks the file, run:

xattr -d com.apple.quarantine ./utila

Then go to System Settings → Privacy & Security and click Open Anyway.

Windows: If you see “Windows protected your PC”, click Run anyway.

The CLI talks to production (api.utila.io) unless you set UTILA_HOST first. Set that before you sign in, if you use another environment:

export UTILA_HOST=<api-host>

To run the CLI in Docker or a cloud container, see Dockerfile.

CLI Command Groups

The CLI commands are organized into groups, each focused on a specific domain:

• vaults – Manage vaults (e.g. list)
• devices – Manage devices (e.g. list, register)
• keys – Work with keys and key shares (e.g. list, download)
• transactions – Sign transactions (e.g. sign)
• cosigner – Run the co-signer service
• auth – Configure authentication (e.g. list, add-service-account-credentials)
• config – Manage CLI configuration

For a full list of commands use the --help flag.

To get help for a specific group of commands or any command you can also specify the --help flag. For example:

utila auth --help

Next Steps

1. CLI Authentication - sign the CLI in with a service account
2. Device and Key Shares Setup Guide - enroll a device to sign transactions
3. Utila Co-Signer - what the co-signer is
4. Co-Signer Setup Guide - start a co-signer