Install and Run the OMMX CLI

Install and Run the OMMX CLI#

The ommx command lets you inspect and exchange Artifacts, manage the Local Registry, and obtain bundled agent plugins and skills. You can run it as a standalone executable or from the OMMX Python package.

If your uv project already has a Python SDK version that includes the CLI, run this from the project root:

uv run ommx --help

Install the standalone executable with cargo-binstall#

Install cargo-binstall, then select a v3 version from the Rust SDK releases. For example, the published 3.0.0-beta.6 release provides CLI archives:

cargo binstall ommx@3.0.0-beta.6
ommx --help

OMMX’s release metadata lets cargo-binstall select the archive for your platform. The standalone executable can be used without a Python environment.

To select the latest stable release, use cargo binstall ommx. During v3 prerelease development, specify a v3 version explicitly; an unversioned install selects the stable v2 series. Choose a release whose notes include the commands you need. The agent plugin and skill commands described in this documentation are newer than 3.0.0-beta.6; see the Rust SDK release notes and the Python SDK release notes for availability.

Use the CLI included in the Python package#

The Python ommx package includes the ommx console command starting with 3.0.0b8. Add that package to your uv project, then run the command in the project’s environment:

uv add 'ommx>=3.0.0b8'
uv run ommx --help

The CLI uses the OMMX version selected by the project’s dependencies. If the project already depends on a compatible ommx, no separate CLI installation is needed. The command syntax is the same for the same CLI version. Available commands depend on the installed version.

Check the version and available commands#

uv run ommx --version
uv run ommx --help
uv run ommx inspect --help

For the standalone executable, use ommx in place of uv run ommx. OMMX manages Rust and Python SDK versions independently; ommx --version reports the Rust CLI version, including when invoked from Python.

To obtain and install the bundled agent plugin or individual skill, continue to Install OMMX Agent Plugins and Skills. For ref deletion, restoration, and garbage collection, see Local Registry cleanup.

Contents