Start Here
Global flags
Use the flags that apply across Blnk CLI commands.
Global flags apply at the root of the CLI or recur on multiple commands. Command-specific flags are documented on each resource or additional command page.
Global flags
Blnk CLI supports the following global flags:
| Flag | Type | Description |
|---|---|---|
-h, --help | boolean | Show help for the current command. Run blnk [command] --help for subcommand help. |
-v, --version | boolean | Print the CLI version and exit. |
Shared resource flags
These flags appear on many list, create, and fetch commands under Resource commands.
| Flag | Type | Default | Description |
|---|---|---|---|
--json | boolean | - | Print the full API response as JSON. On create, prints JSON after a successful request.On list, applies when fetching a single resource with --id. |
--id | string | - | Fetch a single resource by ID on list commands(for example --id ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc for ledgers).Without --json, the CLI prints a formatted summary;with --json, it prints the full object. |
-p, --page | integer | 1 | Page number for paginated list results. |
--per-page | integer | 10 | Number of results per page for paginated lists. |
--{field} | string | - | Filter list results by any indexed field. Pass the field name after -- and the value after a space.Quote comma-separated values for multiple matches, for example --currency "USD,EUR". |
-h, --help | boolean | - | Show help for the current subcommand. |
For how output changes with these flags, see CLI output formats.