Develop with AI
ledger-enterprise-cli
Overview
ledger-enterprise-cli is a command-line interface for AI agents and developers to interact with Ledger Enterprise programmatically. It wraps the same request-based governance model as the platform: accounts, transactions, requests, approvals — all policy-enforced, all auditable.
Primary use case: an AI agent holds API operator credentials, initiates requests via the CLI, and completes approvals without a context switch to the web app. Administrators define rules in Ledger Enterprise; the CLI is how agents execute under those rules.
The CLI enforces the latest published version at runtime. If your installed version is outdated, it will block and prompt you to upgrade before processing any command.
Setup
Requires: Node.js ≥ 22
Install
// bash
npm install -g ledger-enterprise-cliAuthenticate — API credentials (recommended for agent workflows)
Set the following environment variables before running login api. API key credentials are not accepted as CLI flags.
LEDGER_ENTERPRISE_API_URL
Yes
Base URL of your Ledger Enterprise instance
LEDGER_ENTERPRISE_WORKSPACE
Yes
Workspace name
LEDGER_ENTERPRISE_API_KEY_ID
Yes
API key ID
LEDGER_ENTERPRISE_API_KEY_SECRET
Yes
API key secret
LEDGER_ENTERPRISE_API_PRIVATE_KEY
Optional
Hex-encoded PEM private key for the API operator. Required only when approving requests programmatically via requests sign. Not needed for read operations or device-based approval.
Authenticate — Ledger device (Stax or Flex)
Requires a connected Ledger Stax or Flex. No API key secret is involved in this path.
End a session
Agent Skill
The CLI ships a bundled agent skill — a Markdown guide that instructs AI agents how to use the CLI correctly: authentication, command syntax, approval workflows, confirmation requirements, and error handling. The skill follows the shared SKILL format and works with any compatible AI assistant.
Install the skill
Refresh after upgrades. The skill is versioned with the CLI binary. Re-run skill install after each npm update -g ledger-enterprise-cli to keep the agent’s instructions in sync with the available commands.
The skill covers:
Session setup and credential handling
Full command reference with required options and output shapes
API-user approval workflow: getChallenge → sign → approve api
Confirmation requirements for write and critical operations
Exit codes and error handling
Command Reference
All commands return JSON to stdout. Use the global --pretty flag for indented output. Authentication (login) is required before any resource command.
Global options
-- pretty
Indent JSON output
--debug
Enable verbose diagnostic logs
--timestamps
Add timestamps to log lines
-v, --version
Print installed CLI version
-h, --help
Help for any command or subcommand
Accounts
accounts list [--page] [--pageSize]
Paginated list of workspace accounts
accounts get --id <id>
Single account by ID
accounts getBalance --id <id> [--id ...]
Balances for one or more accounts
Transactions
transactions list --accountId <id> [--cursor]
Transaction history for an account (cursor pagination)
transactions estimate --accountId <id> --transactionData '<json>'
Fee estimate for a transaction payload
Requests
requests list [--page] [--pageSize]
Paginated list of workspace requests
requests get --id <id>
Single request by ID
requests create --requestData '<json>'
Create a new request
requests getChallenge --id <id>
Fetch approval challenge (API user session only)
requests sign --challenge <payload>
Sign a challenge locally using LEDGER_ENTERPRISE_API_PRIVATE_KEY; returns signature JWT
requests approve api --id <id> --signature <jwt>
Submit API-user approval using signature from sign
requests approve device --id <id>
Complete approval on a connected Ledger device
API approval workflow
getChallenge → verify decoded payload → sign → approve api.
The private key never leaves the local machine — only the derived signature is sent to the server.
Users
users list [--page] [--pageSize]
Paginated directory of workspace users
users get --id <id>
Single user by ID
Groups
groups list [--page] [--pageSize]
Paginated directory of workspace groups
groups get --id <id>
Single group by ID
Policies
policies list [--page] [--pageSize]
Paginated list of workspace policies
policies get --id <id>
Single policy by ID
Whitelists
whitelists list [--page] [--pageSize]
Paginated list of address whitelists
whitelists get --id <id>
Single whitelist by ID
Exit codes
0
Success
1
General / network error
2
Validation error (missing option, invalid input)
3
Authentication error
4
Resource not found
5
Server error
Important Legal Notice
The Ledger Enterprise CLI is a technology feature that enables AI agents and developers to interact with Ledger Enterprise programmatically under administrator-defined governance rules. It is not a financial service, brokerage, investment adviser, or custodian. Ledger does not hold, manage, or have access to user assets at any time.
All requests initiated through this CLI are subject to the rules and approval policies defined by the user’s administrators in Ledger Enterprise. The user is solely responsible for the configuration of its governance policies, the credentials issued to API operators, and the logic, prompts, financial parameters, and outcomes of any transaction proposed or initiated by an AI agent. Ledger exercises no control over, and bears no responsibility for, the accuracy, profitability, suitability, or intent of any AI agent operating through this CLI. The user acknowledges that it uses this feature at its own risk.
Due to the non-deterministic nature of AI models, instructions generated by AI agents may contain errors, inaccuracies, or unintended parameters. Users must ensure appropriate human oversight of agent-initiated workflows.
The CLI includes a bundled agent skill that provides AI agents with instructions for authentication, command syntax, approval workflows, and error handling. This skill is provided as a developer resource only. It does not constitute a security audit, certification, or endorsement of any workflow or implementation built using it. Ledger does not guarantee that outputs generated by this skill are secure, correct, or free from vulnerabilities. The user is solely responsible for validating any agent behaviour informed by this skill against their own governance policies and security requirements.
This CLI and agent skill are provided "as is," in early development, without warranty of any kind. Features, APIs, and behaviours may change. Use of these features does not establish any contractual, advisory, or fiduciary relationship between the user or developer and Ledger SAS or its affiliates. To the maximum extent permitted by law, Ledger SAS and its affiliates shall not be liable for any direct, indirect, incidental, special, punitive, or consequential damages arising from use of these features, including but not limited to loss of digital assets, unauthorised access, smart contract exploits, or transaction malfunction.
Last updated