Getting started with CyberOS

CyberOS is CyberSkill's internal working platform: a set of modules (workflow engine, memory, skills, services) that agents and people operate together. Everything ships from this repo and carries one platform version (the root VERSION file); module versions are internal.

Run CyberOS in your own project

CyberOS vendors itself into any repository under a single gitignored .cyberos/ folder, organised by module.

Build the payload once, from a CyberOS checkout:

`` bash tools/install/build.sh # writes dist/cyberos/ ``

Initialise your repo (pick one):

`` bash /path/to/dist/cyberos/install.sh /path/to/your/repo # or, from the published package / Homebrew: npx cs install /path/to/your/repo brew install cyberos-cli && cs install /path/to/your/repo ``

This vendors .cyberos/cuo (the task workflow engine), .cyberos/memory (the BRAIN protocol) and .cyberos/plugin, detects your build/lint/test gates into .cyberos/gates.env, scaffolds docs/tasks/BACKLOG.md, creates the local BRAIN store at .cyberos/memory/store/, stamps .cyberos/VERSION, and regenerates docs/status/ (status-hub@3 tabless canvas from status-feed@1).

Stay current:

`` bash /path/to/dist/cyberos/version.sh /path/to/your/repo # notify bash /path/to/dist/cyberos/install.sh /path/to/your/repo # apply update ``

Desktop alternative: the CyberOS desktop app has a "CyberOS Ops" tab that runs the same build / check / init operations from the UI.

The full step-by-step runbook (first task, gates, human acceptance, multi-repo rollout) is tools/install/docs/index.md.

Ship work

All work is a task under docs/tasks/ - net-new (type: feature), fixes (type: bug), hardening (type: improvement) and chores (type: chore) alike, indexed by ONE BACKLOG.md. The ship-tasks workflow drives each task through the lifecycle with two mandatory human-acceptance gates (review acceptance and final acceptance); an agent never sets done itself.

Develop CyberOS itself

Rust services: cd services && cargo test.
The full DB-backed verification (what CI runs): bash scripts/local_verify.sh - boots the dev Postgres + Redis, applies every crate's migrations, runs each module suite. Wipe first (docker compose -f services/dev/docker-compose.yml down -v) to see exactly what CI sees.
Docs: edit markdown under docs/, modules/<m>/docs/, or services/<s>/docs/, then bash tools/docs-site/build.sh. The website renders into gitignored dist/website - generated output is never committed or edited.

Changelog

History lives in the changelog; this page describes only the current state.

Generated from docs/reference/getting-started.md — edit the markdown source, not this file (TASK-DOCS-002).