Developer Guide

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
💡

The Utila CLI can be run on any environment, including local machines, virtual machines, and cloud servers.

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

Now that you have an overview of the Utila CLI, proceed with the following steps to get started: