Install OMMX Agent Plugins and Skills#
Note
The bundled OMMX skill is currently a mock and does not contain OMMX usage instructions.
Obtain the agent plugin or skill bundled with your installed OMMX, then install
it in your coding agent. First follow
Install and Run the OMMX CLI to set up the ommx command.
The commands below use the Python package’s CLI through uv run --no-sync.
If you built the standalone executable from main, use ommx in
place of uv run --no-sync ommx.
These shell examples use a POSIX shell.
Obtain the plugin, marketplace, or skill path#
uv run --no-sync ommx plugin path
uv run --no-sync ommx plugin marketplace path
uv run --no-sync ommx skill path
Each command prints one absolute directory path to stdout:
Command |
Directory contents |
|---|---|
|
|
|
|
|
|
Plugin and skill names are optional positional arguments:
uv run --no-sync ommx plugin path ommx
uv run --no-sync ommx skill path ommx
plugin path ommx returns the same plugin as plugin path. skill path ommx
returns the individual skill directory instead of its parent. The bundled name
is ommx.
Install the plugin for a project#
The bundle contains an Agent Plugins 1.0 manifest and Claude Code metadata. Install it through Claude Code’s local marketplace with local scope:
claude plugin marketplace add --scope local "$(uv run --no-sync ommx plugin marketplace path)"
claude plugin install --scope local ommx@ommx
The local scope records the machine-specific marketplace path and plugin
enablement in .claude/settings.local.json, for your use in this project.
For one Claude Code session, pass the plugin directory at startup instead:
claude --plugin-dir "$(uv run --no-sync ommx plugin path)"
Cursor CLI can also load the plugin for one session:
agent --plugin-dir "$(uv run --no-sync ommx plugin path)"
Confirm in a new session that the agent discovers the OMMX skill from the
configured plugin. In Claude Code, its name is /ommx:ommx. See the
Claude Code marketplace documentation
for the marketplace format and installation behavior.
Install the individual skill#
For an agent that discovers .agents/skills, link the skill from your project root:
mkdir -p .agents/skills
ln -s "$(uv run --no-sync ommx skill path ommx)" .agents/skills/ommx
Start a new session and confirm that ommx is listed with this project’s
SKILL.md as its source. You can also copy the complete skill directory:
mkdir -p .agents/skills
cp -R "$(uv run --no-sync ommx skill path ommx)" .agents/skills/ommx
Run this with no existing .agents/skills/ommx directory. Skill managers that
expect the parent directory can use skill path, for example:
gh skill install "$(uv run --no-sync ommx skill path)" ommx --from-local --scope project
Choose the agent when prompted. Confirm the skill’s project scope and source
path in a new session. Add .agents/skills/ommx to .gitignore for
an environment-specific link or copy. If a team shares a copy in Git, update it
alongside the project’s OMMX dependency.
Versions, cache, and updates#
The plugin’s manifests share the Rust CLI version shown by ommx --version,
including when launched through Python. OMMX maintains Rust and Python SDK
versions independently.
OMMX embeds the whole bundle in the Rust executable and Python wheel. Path
commands materialize it in the OS’s OMMX cache under a key derived from all
bundled files, including manifest versions. No source checkout, network access,
or Artifact Local Registry is needed. Set OMMX_PLUGIN_CACHE_DIR to choose a
writable cache location with a UTF-8 path containing no line breaks. Cached files
are generated data; subsequent calls restore missing files or changed contents.
After upgrading OMMX, obtain the paths again. Recreate symbolic links if their targets changed, or replace the complete copied skill directory. For the Claude Code marketplace, remove its local registration, register the new path, and reinstall the plugin. This also refreshes the contents when the Rust CLI version is unchanged:
claude plugin marketplace remove --scope local ommx
claude plugin marketplace add --scope local "$(uv run --no-sync ommx plugin marketplace path)"
claude plugin install --scope local ommx@ommx
For --plugin-dir, launch a new session with the new path. Confirm that the
agent reads the updated skill. If the cache is deleted, run the path command
again to recreate the bundle before using links or marketplace registrations.