ucli agent guide

CLI: INLINECODE0

Recommended defaults

CODEBLOCK0

• - --output json for machine-readable output
• INLINECODE2 to suppress decorative text
• INLINECODE3 to shrink payloads
• INLINECODE4 and --sort to shape data before it hits your context

Guardrails

• - Prefer read-only commands first. Inspect before acting.
• Use --yes only in deliberate automation paths, never speculatively.
• Pair destructive actions with explicit identifiers. No fuzzy matching in the shell.
• Re-fetch state after any mutation. Do not trust a prior cache.
• Treat exit code 0 as success. Non-zero: capture stderr, retry only on transient failures.

Command groups

Group	Typical use
INLINECODE8	INLINECODE9, health, status, resources, INLINECODE13
INLINECODE14

status, devices, parity, parity-check actions | | disks | Inventory, SMART, temp, usage, mount | | containers | list, inspect, logs, stats, lifecycle actions | | notifications | list, latest, get, create, archive | | vms | list, inspect, lifecycle actions | | shares | list, get, usage | | logs | list, get, system, tail, search | | services | list, get, status | | network | Interfaces, status | | schema | API introspection | | diagnostics | ping, latency, env, doctor |

Workflow: health check

CODEBLOCK1

1. 1. Fetch each separately. Fail fast on non-zero exits.
2. Summarize array state, service state, resource pressure, warnings.
3. Only pull logs if the snapshot shows trouble.

Workflow: container management

CODEBLOCK2

1. 1. Resolve target by id or names.
2. Inspect current state.
3. Execute with --yes when confirmation would block automation.
4. Re-read status after mutation.

Anti-patterns

• - Don't parse human-readable output. Always use --output json.
• Don't assume partial success from human-readable text. Check exit codes.
• Don't retry on non-transient errors (auth, bad arguments, missing resources).
• Don't skip --fields on large result sets. Token waste adds up fast.
• Don't chain mutations without re-fetching state between them.
• Don't use --force unless you understand exactly what it skips.

Configuration

Default config path: INLINECODE59

CODEBLOCK3

Prefer --host and --api-key explicitly for isolated jobs, --profile <name> for stable environments.

ucli agent guide

CLI: INLINECODE63

Recommended defaults

CODEBLOCK4

• - --output json for machine-readable output
• INLINECODE65 to suppress decorative text
• INLINECODE66 to shrink payloads
• INLINECODE67 and --sort to shape data before it hits your context

Guardrails

• - Prefer read-only commands first. Inspect before acting.
• Use --yes only in deliberate automation paths, never speculatively.
• Pair destructive actions with explicit identifiers. No fuzzy matching in the shell.
• Re-fetch state after any mutation. Do not trust a prior cache.
• Treat exit code 0 as success. Non-zero: capture stderr, retry only on transient failures.

Command groups

Group	Typical use
INLINECODE71	INLINECODE72, health, status, resources, INLINECODE76
INLINECODE77

status, devices, parity, parity-check actions | | disks | Inventory, SMART, temp, usage, mount | | containers | list, inspect, logs, stats, lifecycle actions | | notifications | list, latest, get, create, archive | | vms | list, inspect, lifecycle actions | | shares | list, get, usage | | logs | list, get, system, tail, search | | services | list, get, status | | network | Interfaces, status | | schema | API introspection | | diagnostics | ping, latency, env, doctor |

Workflow: health check

CODEBLOCK5

1. 1. Fetch each separately. Fail fast on non-zero exits.
2. Summarize array state, service state, resource pressure, warnings.
3. Only pull logs if the snapshot shows trouble.

Workflow: container management

CODEBLOCK6

1. 1. Resolve target by id or names.
2. Inspect current state.
3. Execute with --yes when confirmation would block automation.
4. Re-read status after mutation.

Anti-patterns

• - Don't parse human-readable output. Always use --output json.
• Don't assume partial success from human-readable text. Check exit codes.
• Don't retry on non-transient errors (auth, bad arguments, missing resources).
• Don't skip --fields on large result sets. Token waste adds up fast.
• Don't chain mutations without re-fetching state between them.
• Don't use --force unless you understand exactly what it skips.

Configuration

Default config path: INLINECODE122

CODEBLOCK7

Prefer --host and --api-key explicitly for isolated jobs, --profile <name> for stable environments.