Getting started

Your first install, step by step.

About two minutes, one command at a time. It all runs on a branch — nothing in your project changes until you read the diff and commit.

It's just files

Everything lands in your repo as human-readable files you can open, read, and edit.

Runs on a branch

You install on a Git branch, so your main project is never touched until you choose to merge.

Revert anytime

Changed your mind? One Git command removes the whole install. Nothing is installed globally.

Nothing leaves your machine

The CLI sends no usage telemetry. Signatures are checked locally before anything is written.

The walkthrough

From zero to your first command.

Copy each command in order. Every step is signature-verified and writes files you can review.

  1. Start on a fresh branch

    Everything CodexFlow writes is just files. Working on a branch means you can review — or throw away — the entire install with one Git command.

    $ git checkout -b codexflow-install
  2. Activate your license

    After purchase you get a signed activation file. This verifies it locally — no account, no login, no servers.

    $ codexflow license activate --activation-file ./codexflow.activation.json
    [ok] activation verified: Commercial Solo
  3. Install the signed payload

    CodexFlow checks the signature and checksum before anything is written, so you know the payload is genuine and untampered.

    $ codexflow payload install --manifest ./manifest.json --archive ./payload.tar
    [ok] manifest signature verified
    [ok] archive checksum verified
  4. Emit the files into your repo

    This writes the skills, agents, commands, checks and memory into your project as plain, reviewable files.

    $ codexflow emit
    skills 2,050 installed
    agents 11 installed
    checks 9 installed
    [ok] CodexFlow operating layer is active
  5. Confirm everything is healthy

    A quick health check confirms the install is complete and consistent before you rely on it.

    $ codexflow doctor
    [ok] all checks passed — ready to commit
  6. Read the diff before you keep it

    This is the safety net: see exactly what changed. Keep what you want, discard the rest — nothing is committed yet.

    $ git status && git diff

    Not sure about a file? git checkout -- <file> removes it. git checkout main undoes the whole install.

  7. Commit, then run your first command

    Commit the files you want, then ask Codex to plan a task — it now picks the right skill and the right agent for the job automatically.

    $ git add . && git commit -m "Add CodexFlow" && codexflow plan "add a contact form"
    planning with: .agents/skills + Task Planner agent

Plain English

New terms, decoded.

AGENTS.md
A plain-text file at your repo root that tells Codex the project rules, review boundaries, and your definition of done.
Skill
A task-specific procedure (e.g. “Stripe checkout review”). Codex picks the right one instead of improvising from a broad prompt.
Agent
A focused role — planner, reviewer, safety, release — that owns one part of the work and hands off to the next.
Check
An automated, deterministic rule that runs before risky work, catching secrets, destructive commands, and leaks.
Memory
Decisions and context written to your repo so the next session doesn’t start from zero.
Payload
The signed bundle CodexFlow installs. Its signature and checksum are verified before any file is written.

If something goes wrong

The newcomer's safety net.

Yes. Everything is files on a branch. Run git checkout main (or delete the branch) and the install is gone completely — nothing is installed globally on your machine.

Barely. The seven commands above are copy-paste. After that you mostly talk to Codex the way you already do; the skills and agents work in the background.

Run codexflow doctor — it explains what is missing or inconsistent and how to fix it. Activation and install verify signatures, so problems are caught early and safely, before any file is written.

Into your repo: AGENTS.md at the root, plus .agents/skills and .codexflow/ (agents, commands, checks, and memory). All human-readable, all visible in your Git diff.

No. The CodexFlow CLI does not transmit usage telemetry in this release. The files stay in your repository, under your version control.

Ready for your first install?

Grab a license, follow the seven steps, and review every file before you commit.