Documentation
Everything the engine does, written down
Install it, connect an agent, call the tools, author a workflow. Each page describes what the shipped engine does — when the engine changes, the page changes with it.
Getting started
- Install and run the engine
Download the CodyCody engine for your platform, activate it with your license key, and start the two servers your coding agent and browser connect to.
- Connect your coding agent
Add the engine to Claude Code, Codex or any MCP client over streamable HTTP, authenticated with an agent token you issue and can revoke.
MCP tools
- ccw_list
List the published workflows the engine can run, with the description and input schema each one declares.
- ccw_start
Start a workflow instance. The engine runs its own steps until one needs the agent, then returns that step's instruction.
- ccw_continue
Report the result of the current step and receive the next instruction. The same call completes an instruction, a decision, a shell command, a review and an approval gate.
- ccw_status
The current state of one workflow instance — status, current step, and progress through any task list.
- ccw_instance_list
List workflow instances, filtered by status or workflow, newest first.
- ccw_instance_logs
The execution log of one instance — every step started, completed, waited or failed, with the engine's notes.
- ccw_instance_cancel
Cancel a running instance. The reason is recorded in its audit trail.
- ccw_step_back
Rewind an instance to an earlier step when a step was answered wrongly. Rewinds engine state only, and reports what it could not undo.
- ccw_skill_list
List the reusable skills on the instance — standalone markdown procedures an agent can fetch and follow.
- ccw_skill_call
Fetch a skill's full instructions with every nested skill and instruction-file reference resolved, ready to follow.
Authoring workflows
- Execution model
A workflow is a directed graph run cooperatively by the engine and an agent. Design for that split — the engine decides what happens next, the agent does the work.
- Document format
A workflow is one JSON document — name, description, input schema, steps and transitions. The naming rules that templates depend on.
- Step types
The fourteen step types — what each one's config means, which ones the agent performs, and the contracts the engine enforces around them.
- Transitions
How steps connect, which steps branch, how loops are built, and the labelled transitions that task loops and reviews require.
- Template language
The {{dotted.path}} syntax that carries input, step results, task data and variables between steps — and the two places it behaves differently.
- Validation
What publish checks, and what it does not — the runtime failures an author has to prevent by hand.
- Instruction files and skills
Reusable prompt content that lives outside workflows — attached to steps, embedded by reference, or fetched by agents directly.
- Design guidelines
Eight rules for workflows that produce auditable results, terminate, and survive being run by an agent that remembers nothing between steps.
- Authoring over the API
From the Team tier, a coding agent can create, validate and publish workflows through the REST API with its agent token. Without a token the API refuses every request.
Packages
- Workflow packages
A package is a set of published workflows, sub-workflows and instruction files for one job. What ships, and where to read what each one does.
Full SDLC
- Overview
The SDLC package runs a whole software lifecycle as workflows — requirements, architecture, style guide, decomposition, build and test, change, deployment and release.
- Building a new system
Run phases 1 to 5 of the SDLC package in order — requirements, solution design, style guide, decomposition, then development and test — and what each one asks of you.
- Working with existing code
Recover a baseline from code that already ships, retrofit a test suite under a coverage ratchet, fix a bug reproduction-first, and run a change through the impacted phases only.
- Deploying and releasing
Run the composed system locally against stubs or live services, provision the hosting environments as infrastructure-as-code, and promote a versioned release with verification and rollback.
- SDLC workflow reference
Every workflow in the SDLC package with its inputs, outputs and gates, the id conventions and file layout it uses, the shipped Python helpers, and what to do when a run stops.
Want the reasons rather than the reference? See where human approval gates and agent tokens in CI pay off.
FAQ
Questions, answered
- Which coding agents work with CodyCody?
- Any MCP-compatible client: Claude Code, Codex, or your own agent. The engine exposes execution tools over streamable HTTP.
- Is it self-hosted, and does it phone home?
- Self-hosted, and no. You run the engine on your own machine or server; license activation is offline via a signed key, so it works fully air-gapped. Your code and data never pass through us.
- What is a personal profile — and what's a seat?
- Each user signs in and gets a personal profile: their own library of workflows and skills that follows them across every project, bound to your instance. A seat is one such profile. The free Starter tier includes one; Pro is priced per profile.
- How do coding agents and CI authenticate?
- Long-lived, revocable agent tokens issued from your account — separate from the browser session, so a CI job or agent runs for as long as you allow and can be revoked on its own without affecting anyone else.
- What does the license cover?
- The engine is licensed per profile, per year, updates included. Starter is free for one profile; Pro is per seat; Team adds a client-reuse license for agencies; Enterprise adds SSO, a site license and a signed key for air-gapped use. Workflow packages are not sold separately: each one is included with the license tier that unlocks it, updates included.
- What is a workflow package?
- A ready-made set of workflows, sub-workflows and instruction files for a specific job — code review, a release pipeline, a migration, a security suite. Drop it in and run it. Start with the Code Review package, included with every license.
- Can I get a refund?
- Yes — 14 days, no questions asked. See our refund policy.