Skip to main content

oceanum-prax-cli

PRAX project, pipeline, deployment, and operations commands for the Oceanum CLI.

Use oceanum prax to work with PRAX from your terminal. The interactive console is available as prax-console.

Command surface

The inventory below includes every visible command and nested subcommand registered with the Oceanum CLI. Indentation indicates nesting: for example, pipeline → triggers → pause means oceanum prax pipeline triggers pause.

oceanum prax
  artifacts — Inspect retained build artifacts.
    list
    show
  builds — Build inspection commands
    list
    logs
    show
  deploy — Deployment management commands
    list
    show
    spec
    watch
  health — Health check and observability commands
    project
    stage
    summary
  init — Scaffold ProjectSpecs and CI pipelines.
    ci
    connections
  logs — Stream deployment logs to stdout
  notifications — Notification history, configuration, and delivery observability
    channels
      create
      delete
      list
      show
      update
    deliveries
      list
    list
    org-alerts
      list
      set
      unset
    subscriptions
      create
      delete
      list
      show
      update
  operations — Inspect and control durable stage deployment operations.
    cancel
    list
    recover
    replace
    show
    watch
  org — Organization management commands
    create
    deprovision
    list
    provision
    quota
    set-tier
    show
    tiers
    usage
  pipeline — Pipeline management commands
    cycles
    list
    logs
    resubmit
    retry
    run
    runs
    show
    stop
    terminate
    triggers
      pause
      resume
      show
  project — Project management commands
    archive
    delete
    deploy
    edit
    export
    history
    history-compare
    history-get
    list
    show
    status
  route — Route inspection and permissions commands
    list
    permissions
      get
      set
  secret — Manage PRAX-backed credential secrets.
    delete
    list
    migrate-owner
    preflight
    set
    show
  service — Service inspection commands
    health
    instance
    list
    logs
    metrics
    show
    status
    usage
  stage — Inspect and operate immutable stage releases.
    approve
    candidate
    compare
    deploy-direct
    evaluate
    history
    promote
    retry-delivery
    rollback
    rollback-preview
    show
  template — Project template commands
    deprecate
    diff
    list
    publish
    scaffold
    source
    validate
    versions
  user — User inspection commands
    list
    show
  validate — Validate a PRAX ProjectSpec file

Use oceanum prax --help or append --help to any command path for its arguments, required options, and output formats. Account-backed commands require authentication; use oceanum auth login to establish an interactive session.

Examples

These show command syntax, not pre-existing resources. Substitute your project, pipeline, deployment, stages, and release number. project.yaml is a local complete ProjectSpec. Promotion requires an eligible source release and appropriate access.

# Validate a local ProjectSpec, then create or replace its project configuration.
oceanum prax validate project.yaml
oceanum prax deploy spec project.yaml --reason "Apply example project"

# Inspect/export the authored project and retained build observations.
oceanum prax project status forecast-project
oceanum prax project export forecast-project --output yaml
oceanum prax builds list --project forecast-project

# Run a pipeline at an explicit project-owned stage binding.
oceanum prax pipeline run forecast --project-ref forecast-project --stage-ref dev --watch

# Preview a project-wide authored trigger change without submitting it.
oceanum prax pipeline triggers pause forecast-project forecast --dry-run

# Inspect immutable stage releases and promote a pinned source release.
oceanum prax stage history --project forecast-project --stage dev
oceanum prax stage promote --project forecast-project --stage prod --from-stage dev --release 3 --idempotency-key promotion-001 --reason "Promote reviewed release"

# Stream deployment logs.
oceanum prax logs forecast-deployment --follow

Pipeline trigger pause/resume edits the common authored triggers.enabled setting for every stage that references that pipeline. It validates and previews the change before confirmation; --dry-run previews without submitting a revision. Recovery of events received while paused is not guaranteed. Check each stage's observed binding state after deployment to verify that the change has taken effect.

Requirements

Python 3.11+ and Oceanum CLI 1.2.0+ are required. The Python distribution is named oceanum-prax-cli and integrates with the Oceanum CLI. Its dependencies and version bounds are declared in pyproject.toml.

Versions

The CLI and SDK share the same release version. Each CLI release depends on the matching oceanum-prax-sdk release.

See also

Pipeline discovery

oceanum prax pipeline list --project forecast-project --stage dev --limit 20 loads a bounded server definition page. Search filters pipeline/project names; stage filters authored membership, not readiness. Each returned stage binding is shown independently with its latest execution outcome; no global phase or pipeline-wide health is inferred. --limit bounds definitions, never truncates a sibling stage binding. Use --offset for another server page. Run admission still requires an explicit project and stage and fresh server validation.

Metadata

Release files for oceanum-prax-cli 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oceanum-prax-cli 0.3.2
File Size Uploaded Provenance Actions
oceanum_prax_cli-0.3.2.tar.gz 130.7 kB With provenance Details for oceanum_prax_cli-0.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for oceanum-prax-cli 0.3.2
File Interpreter ABI Platform Actions
oceanum_prax_cli-0.3.2-py3-none-any.whl Python 3 none any Details for oceanum_prax_cli-0.3.2-py3-none-any.whl

Total release size: 286.0 kB

Release files / oceanum_prax_cli-0.3.2.tar.gz

Download URL oceanum_prax_cli-0.3.2.tar.gz
Size 130.7 kB
Tags Source
SHA-256 checksum
How to use checksums
61c570cbd41346b92c38a8cbb136fcc3f2cc3310e5bb479e8aef5e5e569ccf09
BLAKE2b-256 checksum
How to use checksums
253d77616f2f5709437243bd261f8a03b7155eb1ab83d649f696c34ded9c4c0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / oceanum_prax_cli-0.3.2-py3-none-any.whl

Download URL oceanum_prax_cli-0.3.2-py3-none-any.whl
Size 155.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0f5ac597abedb20d5fb48cd5657c85404dacedf0624e56292309cebbf8b3261f
BLAKE2b-256 checksum
How to use checksums
13c94cb93b59f880a07677af977fca55add9aeae8ed87a3ea190ec6a328ed7e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for oceanum-prax-cli 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for oceanum_prax_cli-0.3.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page