Terminal reference
Palo CLI
The Palo CLI is the terminal interface to the same account, memory, infrastructure, usage, and billing surfaces exposed by the SDK and HTTP API. It is designed for a human at a shell, an agent that needs structured output, and a CI job that needs stable exit codes.
python -m pip install palo-spring palo --version
palo palo auth palo --help
The bare root command palo shows the command index and does not contact the API. palo auth and palo settings open designed local panels. Other command groups show their generated command reference when no subcommand is supplied. Add --help when you need the formal option reference for any command.
The CLI wraps the hosted HTTP routes. The memory routes are available over HTTP on the reference runtime; the infrastructure routes are not served yet, so commands that call them return an error. The HTTP reference shows each route's status and is updated as routes ship.
Command map
| Surface | Examples | Purpose |
|---|---|---|
| Auth | palo auth, palo auth login, palo logout | Inspect, create, and remove local credentials. |
| Settings | palo settings, palo settings profiles, palo settings set | Manage target, output, transport, and local profiles. |
| Mind | palo mind me, palo mind keys, palo mind storage | Manage account resources, API keys, storage connections, usage, and billing. |
| Memory | palo memory write, palo memory recall, palo memory delete | Use the data plane with an API key attached to an active storage connection. |
| Infrastructure | palo infra status, palo infra metrics, palo infra events | Inspect capabilities, health, request quality, anomalies, event history, and exports. |
Short aliases are supported for frequently used surfaces. The canonical words remain valid and appear in help output so scripts remain readable.
Authentication
Run palo auth to see local state. Run palo auth login for the browser flow. The callback returns to the CLI's loopback listener, not to the Mind Platform dashboard. Run palo auth logout or its root alias palo logout to remove saved API key and session credentials.
palo auth palo auth login palo auth logout palo logout
A saved session is appropriate for interactive control-plane work. Memory writes and other API-key-only operations require PALO_API_KEY or a saved API key. palo auth reports the selected source without exposing the full secret.
Memory operations
Before writing, create or select a memory storage connection and attach it to the API key. The CLI asks for an exact confirmation on destructive actions. A bare memory command prints command help instead of attempting a request with missing input.
palo mind storage create palo mind keys create # Follow the prompts to attach an existing or managed storage.
palo memory write "The appointment moved to Monday" \\ --namespace conversation \\ --idempotency-key conversation-42-message-7 \\ --source-type external_application \\ --source-id conversation-42-message-7
palo memory recall "When is the appointment?" \\ --namespace conversation \\ --top-k 3 palo memory delete --namespace conversation \\ --confirm-namespace conversation
The write result distinguishes accepted, retained, not retained, and failed states. It includes decision, representation, related recall when requested, caller-attested source metadata, provenance, usage, and request ID. Recall calls its input a cue because it is the signal used to retrieve related memories, not a hidden model parameter. The current CLI has no bulk migration command. For imported records, submit individual writes and set --source-type imported_archive with a stable --source-id; the same storage, consent, metering, billing, and observability rules apply.
Infrastructure and monitoring
Use read-only infrastructure commands to inspect the current deployment. The default target comes from the active profile. These commands report backend state and do not require the repository on the operator's computer. A smoke test is an authorized diagnostic request against the configured deployment, not a local server startup command.
palo infra capabilities palo infra health palo infra status palo infra metrics palo infra anomalies palo infra events --limit 100 --offset 0 palo infra export
palo infra capabilities also reports the versioned storage-provider registry. It distinguishes managed execution available in the current reference data plane from BYO connections that are control-plane only, so a client can discover the data-plane boundary before dispatch. palo infra health identifies the provider, model version, deployment version, and environment that answered. For a deployed runtime, palo infra smoke-test requires a customer API key, an active managed-memory consent state, and the target's policy. Its normal service-default model substitution does not require the operator simulation capability. Caller-selected adverse simulation profiles are a separate operator-only path and cannot bypass customer consent. Use palo infra monitor --iterations 0 for a bounded live view and stop it with Ctrl+C.
Automation, JSON, and destructive actions
Designed terminal output is for people. Agents and CI should use --json, check the process exit code, and parse documented response keys. Commands that mutate state should be explicit and should never accept an unqualified confirmation shortcut.
palo infra metrics --json > metrics.json palo infra events --limit 500 --offset 0 --json palo mind keys list --json palo mind usage summary --json
Key deletion requires the exact key name. Storage deletion requires the exact storage name. Memory namespace deletion requires --confirm-namespace with the exact namespace. A bare --yes is rejected because it removes the resource identity from the confirmation step.
Completion scripts are generated by the CLI. Run palo install completion --help for shell-specific installation, or palo show completion --help to print a script without modifying shell files.
Was this page helpful?
Your feedback helps us improve our documentation.