Skip to main content
Installing CyberOS vendors a self-contained .cyberos/ folder into your repository. The folder is gitignored — it holds the workflow engine, memory protocol, agent entry files, and gate runner — so it never pollutes your tracked code. A single command handles everything: it auto-detects your build, lint, and test commands, scaffolds your docs/tasks/BACKLOG.md, writes per-agent instruction files, and stamps a VERSION file you can check later. Re-running the installer is always safe: it applies updates and never overwrites your existing tasks, BACKLOG.md, AGENTS.md, or gates.env.

​
Installation channels

Choose the channel that fits your setup. All channels produce the same .cyberos/ layout.
1

Run the installer

In your project root, run:
The CLI auto-detects your build, lint, and test commands, vendors .cyberos/ into your repo, scaffolds docs/tasks/BACKLOG.md, and writes agent entry files.
2

Verify the installation

Confirm everything is wired correctly:
A healthy installation prints READY. If any gate command is missing, the output tells you exactly which gates.env line to fix.
3

Check the installed folder

Confirm .cyberos/ was created in your repo root:
You should see cuo/, memory/, plugin/, AGENT-ENTRY.md, gates.env, and VERSION.

​
Install via the Claude plugin

1

Add the plugin to Claude

In Claude, go to Settings → Plugins → Add and pick dist/cyberos/cyberos.plugin (the .plugin file, not the folder). For Claude Code, run:
2

Run the install command

Open a session in your repository and type:
The plugin detects your repo root, runs the installer, and reports what it wrote.
3

Follow the prompts

If the plugin can’t auto-detect a gate command (build, lint, or test), it asks you to confirm or supply it. Review the output and confirm to proceed. Installation completes in seconds.
Install the Claude plugin to unlock the /ship-tasks one-command workflow — the fastest way to drive a task from ready_to_implement to done.

​
What gets installed

Every channel produces the same .cyberos/ tree:

​
What installation does NOT touch

Installation is strictly additive. It never modifies:
  • Your existing source code
  • BACKLOG.md if it already exists (content is preserved)
  • gates.env if already configured (a timestamped backup is made, then it is regenerated)
  • AGENTS.md if it already exists (a marked append is made at most once)
  • Any existing tasks under docs/tasks/
Installation is idempotent. Re-running npx cyberos install (or /install) applies the latest CyberOS updates to .cyberos/ but never touches your BACKLOG.md, task files, AGENTS.md, or gates.env. Use it freely to keep your repo current.

​
Updating CyberOS

To update an already-installed repo, use any of the following:
From the Claude plugin, type /update in your repo session. The command compares your .cyberos/VERSION against the available payload and applies the update only after you confirm.

​
Multi-agent support

CyberOS wires every major agent in a single install run. Per-agent instruction files and native skill directories are created if absent — your existing files are never clobbered. Any agent pointed at AGENTS.md or .cyberos/AGENT-ENTRY.md drives the same workflow, the same gates, and the same required human verdicts — no plugin required.