@opscotch/oms

@opscotch/oms (CLI)

OMS installer — install the OMS application into a folder, copy bundled OMS skills into your IDE, and merge Opscotch MCP config. OMS projects are created later with @oms-assistant.

Current release: 0.3.2.

Install from npm

npx @opscotch/oms install

Non-interactive (CI / automation):

npx @opscotch/oms install --yes \
  --directory ~/oms-dev \
  --ide cursor \
  --display-name "Your Name" \
  --installation-name oms-dev \
  --chat-language English \
  --document-language English

Interactive install asks a capability profile (six areas + guidance style) so agents match explanation depth to your background.

Open the target folder in Cursor or Codex → @oms-assistant to finish setup (setup.yaml stays completed: false until then). Then use create project, edit project, or list projects. @oms-architect is also bundled for optional dedicated manifest/bootstrap planning.

IDE outputs

IDE	Install writes
Cursor	.cursor/mcp.json (oms-workspace stdio), .cursor/permissions.json (oms-workspace:*), .cursor/skills/oms-assistant/, .cursor/skills/oms-architect/
Codex	.codex/config.toml ([mcp_servers.oms-workspace]), .agents/skills/oms-assistant/, .agents/skills/oms-architect/, root AGENTS.md

Workspace runtime (once per machine): legal acceptance is required; a license is optional with @opscotch/oms-workspace 0.1.6+:

oms workspace install \
  --directory ~/oms-dev \
  --legal-accepted '<base64-acceptance-blob>'

Use optional --license-file <path> for backward compatibility or production-agent workflows. See .oms/opscotch-install-steps.md or root README.md.

Cursor: Set Settings → Agents → Run Mode to Auto-review or Allowlist. Install writes .cursor/permissions.json with oms-workspace:* allowlist + Auto-review hints. Re-run oms install in the installation folder to refresh merge after upgrade from 0.2.0.

Codex: Trust the project folder when prompted — project .codex/config.toml (including MCP) loads only for trusted projects.

Develop from source

cd packages/cli
npm install && npm link

oms install --directory ~/oms-dev

npm install runs prepare automatically (bundles skills/ + templates/ into bundle/). Re-run npm run prepare after editing skills or templates without reinstalling.

Commands

Command	Description
oms install	Interactive install (guided prompts)
oms install --yes …	Non-interactive; same tree as interactive when flags match
oms workspace install	Install ~/.oms-workspace Docker runtime (legal token required; license optional)
oms --version	CLI semver (matches .oms/.oms-version in fresh installs)

Flags

Flag	Purpose
--directory	Target folder; if omitted, interactive install defaults to current folder
--ide	cursor or codex (v1 parity)
--display-name	Prefill for Assistant
--installation-name	.oms/installation.yaml name
--project-name	[deprecated] Alias for --installation-name
--chat-language	Seeds .oms/config.yaml
--document-language	Seeds .oms/config.yaml
--team-mode	solo (v1)
--capability-profile	Non-interactive default 1.1.1.1.1.1.1
--yes	Skip prompts

Monorepo layout

oms/  (public repo)
├── packages/cli/     ← this package (@opscotch/oms)
├── skills/           ← oms-assistant + oms-architect bundle
└── templates/        ← customer scaffold source

See the repository root README.md for the full setup flow.

Upgrade re-runs

Re-running oms install in an existing OMS installation refreshes IDE skills and merges MCP without clobbering team-info member files. Non-empty non-OMS directories prompt for confirmation (interactive) or fail (--yes).

Release checklist

Before npm publish:

1. Bump packages/cli/package.json version.
2. Run npm run prepare — syncs templates/.oms-version and refreshes bundle/.
3. npm test in packages/cli.
4. Smoke: oms --version, oms install --yes --ide cursor, oms install --yes --ide codex.
5. Confirm .oms/.oms-version in a fresh install equals the published CLI version.
6. npm publish --access public (requires npm login to @opscotch org).