Installation and invocation
- Pin
@praxa/cli@0.3.0in automated workflows. - Use the explicit
praxaexecutable with one-offnpxcommands because the package also exposes the legacyaurabin. - Run
praxa versionand assert the OpenAPI fingerprint before networked work. - Prefer a project development dependency for repeatable team automation.
- Keep global installs for interactive convenience, not release authority.
Preview before mutation
Use--dry-run for project setup and memory metadata planning. Review paths,
targets, auth mode, provider, and read-only capability before allowing local
configuration writes.
0.3.0 plan or store local read-only source metadata.
They do not connect providers, synchronize records, import data, mirror, cut
over, or write provider memory.
Credential handling
- Supply
PRAXA_ACCESS_TOKENonly at runtime. - Use a short-lived delegated Gateway OAuth token, never an Execution Fabric API key or provider key.
- Keep
.praxa/config.jsonlimited to non-secret project metadata and Gateway origin. - Mask environment values in CI and disable shell tracing around secrets.
- Remove tokens from child-process environments that do not need them.
- Revoke disposable credentials after live tests.
Stable mission identity
Persist one idempotency key per logical mission mutation. Reuse it with the exact original body after a timeout or process interruption. Create a new key when the requested operation changes.$(uuidgen) in a command that an automation system may rerun. The
retry would generate a different key and could admit separate work.
Shell and CI behavior
- Check the process exit before parsing stdout.
- Capture stderr separately and redact it before artifact upload.
- Use
--jsonwhere the command supports it; help and defaultinitoutput are human text. - Validate required JSON fields with
jq -eor a typed parser. - Set an outer job timeout; do not assume the command owns the complete pipeline deadline.
- Serialize operations that share one logical idempotency record.
Failure and reconciliation
Team operations
- Document which environment owns each Gateway URL.
- Keep production invocations in reviewed scripts, not copied shell history.
- Require peer review for mission JSON that changes budgets or committing tool authority.
- Store redacted run IDs and outcomes as deployment evidence.
- Test missing, expired, revoked, and under-scoped tokens in staging.
- Include a rollback path to the prior pinned CLI package.
Upgrade checklist
- Install the new CLI and SDK in a clean temporary project.
- Compare
praxa versionwith the approved contract values. - Run
init --dry-run --jsonand memory planning; require no unexpected write. - Review help and command-reference changes.
- Run a read-only
doctoragainst staging. - Exercise one disposable mission with replay and terminal readback.
- Update the project lock and automation image only after those checks pass.
Automation and JSON
Build a strict CI workflow with pinned binaries, safe output, and cleanup.
CLI troubleshooting
Resolve install, configuration, auth, output, replay, and memory-plan issues.