Install / Getting Started

Install the paid workflow OS for your Codex-powered repo.

CodexFlow is installed from your repository root after purchase. It adds a repo-native workflow layer that Codex and humans can use together: AGENTS.md guidance, repo memory, skills, commands, QA guardrails, runbooks, and handoff workflows.

CodexFlow is independent and is not affiliated with, endorsed by, or sponsored by OpenAI.

Before you start

You need:

• A paid Personal or Standard / Commercial Solo order
• The signed activation file from your secure access page
• The signed payload manifest and verified archive from your secure access page
• A local code repository
• Git installed
• Node.js and npm available in your terminal
• Terminal access from the repository root

Recommended before running CodexFlow:

git status

Commit or stash important work before installing any new workflow files. CodexFlow is designed to create human-readable files, but you should still start from a clean or intentionally prepared working tree.

1. Prepare the repo

From the root of the repository you want to structure, install the CLI package used by CodexFlow hooks and local commands:

npm install -D create-codexflow

The exact package source and fulfillment files are provided through your secure order access page.

2. Activate your paid license

Place the activation file somewhere private on your machine, outside public repositories, then run:

codexflow license activate --activation-file ./codexflow.activation.json

Check the license state:

codexflow license status

Expected paid behavior:

• Personal shows non-commercial rights.
• Standard / Commercial Solo shows commercial solo rights.
• Raw license secrets are not displayed in generated premium file watermarks.

3. Install the paid Individual payload

Install the paid payload from the files provided through your secure access flow:

codexflow payload install \
  --manifest ./individual-core-0.1.0.manifest.json \
  --archive ./individual-core-0.1.0.tar.gz

The CLI checks activation signature, payload manifest signature, tier, entitlement, and archive checksum before writing files.

4. Emit the workflow layer

Generate the repo workflow files:

codexflow emit

Paid output is emitted with customer-specific license metadata and watermarks that record tier and commercial-use status without exposing raw license keys.

After installation, review the generated files before committing them:

git status
git diff

Commit the baseline once you are satisfied:

git add .
git commit -m "Install CodexFlow workflow layer"

5. Verify the paid setup

Run:

codexflow license status
codexflow payload list
codexflow doctor
git status
git diff

A healthy paid setup should show:

• A trusted paid activation
• The correct tier
• The expected commercial-use flag
• Installed paid payload status
• Generated premium workflow files
• Reviewable Git changes

For Personal, commercial use should be false.

For Standard / Commercial Solo, commercial use should be true.

6. Work with CodexFlow in a real session

A practical CodexFlow session looks like this:

1. Start from a clean branch.
2. Ask Codex to read AGENTS.md and relevant repo memory.
3. Use the appropriate CodexFlow command, skill, or runbook.
4. Let Codex propose a plan before editing when risk is high.
5. Review risky files before changes are applied.
6. Run tests or checks.
7. Update handoff notes.
8. Commit reviewable work.

CodexFlow does not replace engineering judgment. It gives Codex and humans a shared operating structure.

7. Removing CodexFlow

To remove CodexFlow-generated files, use the uninstall flow:

codexflow uninstall --yes

To remove an installed paid payload:

codexflow payload remove individual-core

Review the Git diff after uninstalling.