ledgers command to browse ledger containers, open one record by ID, and create new ledgers on your connected Core instance. Ledgers group balances and transactions; start here when you need a ledger_id for balance setup.
| Command | Alias | Description |
|---|---|---|
| list | l | Browse all ledgers in a table; add --id to fetch one |
| create | c | Create a ledger via interactive prompts |
list
See every ledger on your connected Core instance in a paginated table with ID, name, and created time.
Use this when you need a ledger_id before creating balances or when auditing how your books are partitioned.
| Option | Type | Default | Description |
|---|---|---|---|
--{field} | string | — | Filter by any indexed field. Quote comma-separated values for multiple matches. |
-p, --page | integer | 1 | Page number. |
--per-page | integer | 10 | Results per page. |
-h, --help | boolean | — | Show help for this command. |
list --id
Resolve one ledger by ledger_id, including its name and meta_data.
Pass --json to print the same payload your application receives from the Core API.
| Option | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | Ledger ID to fetch (for example ldg_46074f0e-898d-4b48-bced-d647816168c0). |
--json | boolean | No | Print the full API object as JSON instead of a formatted summary. |
-h, --help | boolean | No | Show help for this command. |
create
Add a ledger container through guided prompts for name and optional JSON metadata.
Create ledgers first when you are standing up a new product, region, or currency scope. Balances and transactions hang off a ledger.
| Argument | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Ledger name. Prompt: ledger name > |
meta_data | object | No | Optional metadata as JSON. Prompt: metadata (json) >. Press Enter to skip. |
| Option | Type | Description |
|---|---|---|
--json | boolean | After a successful create, print the full API response as JSON. |
-h, --help | boolean | Show help for this command. |