# CodeRook

> Version control and project hosting for projects of any size, run by ACCA Gaming Productions. Every save is a complete, compressed snapshot; projects are private or public at the owner's choice; and nothing stored on CodeRook is used to train AI or sold. Paid for by storage subscriptions, with 5 GB free.

CodeRook has three clients that do the same things: a desktop app, a command-line tool called `cbx` (npm package `@coderook/cli`), and the website. There is no staging area, no branches to manage and no rebase: you save a folder, and the save is kept. Saves can be named and made public as versions, compared, restored, proposed into a protected main line with review and checks, and downloaded as a whole.

## Start here

- [How CodeRook works](https://coderook.com/docs): saves, versions, lines, the desktop app and the cbx command line
- [Why CodeRook](https://coderook.com/why): what it is for and how it compares with the alternatives
- [Pricing](https://coderook.com/pricing): every feature on every plan; paying buys storage
- [Download](https://coderook.com/download): the desktop app
- [AI and your projects](https://coderook.com/ai): the no-training commitment and each project's own AI settings
- [Security](https://coderook.com/security): what is protected and what is not
- [Films](https://coderook.com/films): five short films about what it does, every screen a real recording
- [Changelog](https://coderook.com/changelog)
- [Status](https://coderook.com/status)

## Building on CodeRook

- Serve an app its own updates from a public project: name a release like 1.2.3 (`cbx release 1.2.3`), attach the installers (`cbx attach <file>`), and give the project's feed to the app's updater. electron-updater's generic provider reads it directly: `https://api.coderook.com/v1/public/projects/{owner}/{slug}/updates`. Anything else can read `.../releases/latest` as JSON (version, notes, and each file's size, SHA-256 and address), or `.../releases` for every release. The source does not have to be public: `cbx release 1.2.3 --downloads public` offers a release's downloads and feed while the version's files stay private, so one project ships its own app.
- [Updating an app from CodeRook](https://coderook.com/docs#app-updates): the full guide
- [Public API](https://coderook.com/docs#public-api): read any public project without signing in, from `https://api.coderook.com/v1/public`
- [Pull requests](https://coderook.com/docs#pull-requests): every project has a Pull requests tab with line comments, suggested changes, reviews, checks and a merge box; `cbx pr` does the same from a terminal
- [Keeping files private](https://coderook.com/docs#private-files): a public project can keep folders and file types to its own people with `cbx private add "design/"`
- [Workflow files](https://coderook.com/docs#workflow-files): actions as YAML in .rook/workflows, with triggers (save, pull_request, issue, release, schedule), matrix, needs, approval, concurrency, secrets and a per-run token
- [Issues](https://coderook.com/docs#issues): timeline, close reasons, forms in .rook/issue-forms, rules that label, assign and close quiet issues; `cbx issue`
- [Forks](https://coderook.com/docs#forks): fork a public project and offer changes back as a pull request with `cbx fork`
- [Reporting a vulnerability](https://coderook.com/docs#security-reports): private reports to a project's owner, `cbx security report`
- [Signed releases](https://coderook.com/docs#release-drafts): drafts, channels, SHA256SUMS and a signed manifest checked by `cbx verify`; OSV dependency checks with `cbx deps`
- [Mod repositories for games](https://coderook.com/docs#mod-repositories): a game's maker sets one up (`cbx mods create`) with its own rules; modders publish (`cbx mods publish`); nothing is listed until it passes those rules and a malware scan; the game reads a catalogue signed with the repository's own key from `https://mods.coderook.com/v1/modrepo/{repo}`
- [OpenAPI description](https://api.coderook.com/openapi.json): the public routes, machine-readable
- [API front door](https://api.coderook.com/): what the API offers and where each part is described
- Claude connector: an MCP server at `https://api.coderook.com/mcp`, signed in with OAuth, with tools to list projects and versions, read and compare files, name and release versions, check an app's update feed, undo, take down and change visibility
- Command line: `npm install -g @coderook/cli`, then `cbx` (`cbx help` lists every command); it also installs a git remote helper, so plain `git push` works

## Public projects

Browse all of them at https://coderook.com/explore. Each project page states its owner's wishes about AI use in a `content-usage` meta tag; respect it.

- [batty-251/zt1-engine](https://coderook.com/batty-251/zt1-engine)
- [demo-57/forecast-board](https://coderook.com/demo-57/forecast-board)
- [batty-251/voxai-coder-linux](https://coderook.com/batty-251/voxai-coder-linux)
- [batty-251/fxsound-linux](https://coderook.com/batty-251/fxsound-linux)
- [batty-251/wallpaper-picker](https://coderook.com/batty-251/wallpaper-picker)
- [batty-251/winbar](https://coderook.com/batty-251/winbar): PopOS taskbar that gives you the windows feel.
- [batty-251/cbx](https://coderook.com/batty-251/cbx): Open-source version control for projects of any size: snapshots, content-defined chunking, real merges, offline first. Format and sync protocol specified. Apache 2.0. Mirror: github.com/AlexC1991/cbx
- [batty-251/3d-game-project-claude](https://coderook.com/batty-251/3d-game-project-claude)
- [batty-251/outpost-command](https://coderook.com/batty-251/outpost-command)
- [batty-251/voxai-coder-releases](https://coderook.com/batty-251/voxai-coder-releases)
- [batty-251/byte-releases](https://coderook.com/batty-251/byte-releases)
- [batty-251/desktop3d](https://coderook.com/batty-251/desktop3d)
- [batty-251/voxai-coder](https://coderook.com/batty-251/voxai-coder)

## Optional

- [Terms](https://coderook.com/terms)
- [Privacy](https://coderook.com/privacy)
- [Acceptable use](https://coderook.com/acceptable-use)
- [About](https://coderook.com/about)
- [Contact](https://coderook.com/contact)
