Loadout CLI reference

Use the installed aident CLI when your agent can run shell commands. Loadout is its default package. The live setup document owns installation; run aident --help and add --help to a command for current flags.

Start and inspect

aident setup --client-name "<agent client>" --json
aident whoami
aident doctor
aident update --check
aident --help

setup is the guided, idempotent sign-in and verification path. update --check reports availability without changing the installation. For a terminal or CI environment where you manage setup directly, install the persistent @aident-ai/cli package first, then run aident setup --client-name "<your agent>" --json. A browserless host can use aident setup --client-name "<your agent>" --oob --json for out-of-band sign-in. Follow the live setup document for current installation and verification details.

Discover and execute Actions

Command	Required fields	Purpose
`aident capabilities search`	`--query` or a batch `--queries`	Find canonical Action names. Use `--types '["action"]'` to narrow results.
`aident capabilities get`	`--name`	Read Action metadata and its current `inputSchema` and `outputSchema`.
`aident capabilities preflight`	`--name`; optional `--input` or `--input-file`	Validate the exact payload and estimate user-facing USD cost without execution.
`aident capabilities execute`	`--name`; Action-specific `--input` or `--input-file`	Run the Action after access, cost, and authorization checks.

aident capabilities search --query "list open issues" --types '["action"]' --json
aident capabilities get --name '<exact-action-name>' --json
aident capabilities preflight --name '<exact-action-name>' --input-file ./input.json --json
aident capabilities execute --name '<exact-action-name>' --input-file ./input.json --json

Use the exact Action name returned by search, such as composio:gmail_tools:gmail_send_email. The integration prefix and Action suffix are both part of the name. Input fields vary by Action; copy them from capabilities get instead of an old example.

Guidance, connections, and evidence

Command	Useful fields	Purpose
`aident skills search`	`--query`, `--limit`, `--cursor`	Find curated text guidance for a broader workflow.
`aident skills read`	`--name`, `--artifactVersionId`	Read one immutable Skill revision.
`aident vault status`	`--integrationId` or `--integrationIds`	Check whether the needed account is ready.
`aident vault connect`	`--integrationId`	Start an Aident-managed connection and give the user its URL.
`aident audit recent`	`--limit`, `--status`, `--integrationId`	Inspect Action results and recover interrupted responses.
`aident audit summary`	`--limit`, `--scope`	Summarize usage and user-facing cost.
`aident billing balance`	none	Check the available USD balance when cost matters.
`aident loadout bug submit`	`--report-file`; optional `--surface`	Submit a redacted Markdown bug report and return its ticket ID.

All examples use --json for machine-readable output. Object and array flags also accept --<flag>-file <path> to read JSON from a file. Keep credential values out of command history and logs; agent callers should use the returned Vault connection URL.

Execution fields that need care

Flag	When to use it
`--accountAlias`	Select an exact alias when the Integration exposes multiple ready accounts.
`--approvalToken`	Pass a one-time token returned by credit preflight or `credit-approval-required` after approval.
`--acknowledgementScope`	Retry the same Action and input only after `requires-user-acknowledgement` and the user’s explicit approval of one available scope.
`--timeoutSec`	Set a hosted CLI Action timeout within its published limits.

An insufficient-credits result means stop and use its billing URL. For other errors, consult troubleshooting and the endpoint schemas.

Loadout for daily agent work

Loadout for professional workflows

Start and inspect

Discover and execute Actions

Guidance, connections, and evidence

Execution fields that need care

​Start and inspect

​Discover and execute Actions

​Guidance, connections, and evidence

​Execution fields that need care

Start and inspect

Discover and execute Actions

Guidance, connections, and evidence

Execution fields that need care