# Add to your Claude Code skills
git clone https://github.com/evidentloop/sopifyResumable, traceable AI coding — decisions and history stay with the project
English · 简体中文 · Quick Start · Contributors
When facts are missing, Sopify stops and asks. When a decision needs your approval, it waits. When work is interrupted, it resumes from the last stopping point — even across different AI hosts.
curl -fsSL https://github.com/evidentloop/sopify/releases/latest/download/install.sh | bash -s -- --target codex:en-US
After install, use ~go to start a managed workflow. See Installation for other targets, platforms, and verification.
Already in a Sopify-managed repo? Open any AI host and continue the unfinished task — it picks up from where you left off. Full walkthrough →
| Step | What happens | |------|-------------| | Start | Ask the host to begin or continue a task | | Pause | Sopify stops when facts are missing or a decision needs you | | Resume | Work picks up from project state — even on a different host |
As repositories grow, AI-assisted development runs into a hidden problem: decision context stays trapped in chat history, each new session re-derives the project state, and the user's mental model, the AI's understanding, and the codebase start to drift apart.
No comments yet. Be the first to share your thoughts!
Sopify uses project-level conventions to make critical steps visible. The basic process record is generated automatically, but the long-term compounding value still depends on consistently closing out work and maintaining project knowledge.
| Gap | Sopify's answer | |-----|-----------------| | State is trapped in a single host's chat session | Portable project state — switch hosts mid-task | | No independent quality gate | An isolated, independent review pass before execution | | Decisions are invisible and non-auditable | Plan changes force re-confirmation — the AI cannot silently proceed | | Each session's learning is disposable | Plans, decisions, and reviews persist as reusable project assets |
Two-step install (recommended for first-time review):
curl -fsSL -o sopify-install.sh https://github.com/evidentloop/sopify/releases/latest/download/install.sh
sed -n '1,40p' sopify-install.sh
bash sopify-install.sh --target codex:en-US
Windows PowerShell:
iwr https://github.com/evidentloop/sopify/releases/latest/download/install.ps1 -OutFile sopify-install.ps1
Get-Content sopify-install.ps1 -TotalCount 40
.\sopify-install.ps1 --target codex:en-US
The repo-local install path remains available for developers and maintainers:
bash scripts/install-sopify.sh --target codex:en-US
python3 scripts/install_sopify.py --target claude:en-US --workspace /path/to/project
Install targets:
codex:zh-CNcodex:en-USclaude:zh-CNclaude:en-USThe protocol works with any host. Verified runtime integrations today:
| Host | Install target | Availability | Validation coverage | Notes |
|------|----------------|--------------|---------------------|-------|
| codex | codex:zh-CN / codex:en-US | Deep verified | Host install flow, workspace bootstrap, and runtime package smoke are verified | Suitable for daily use |
| claude | claude:zh-CN / claude:en-US | Deep verified | Host install flow, workspace bootstrap, and runtime package smoke are verified | Suitable for daily use |
Notes:
sopify status / sopify doctor for detailed capability claims and live diagnosticsAvailability expresses the current delivery tier, while Validation coverage describes what has already been validatedInstaller behavior:
--workspace--workspace is an advanced prewarm path for maintainers, CI, or explicit repository setup~go when you want Sopify to manage the full task workflow for you.status to see current progress, doctor to troubleshoot.python3 scripts/sopify_status.py --format text
python3 scripts/sopify_doctor.py --format text
will bootstrap on first project trigger: the host install is ready and the project-local runtime has not been prepared yetworkspace outcome: stub_selected [continue]: the workspace runtime entry is healthyglobal_bundle_missing, global_bundle_incompatible, or global_index_corrupted): repair the install and retryAfter install, open your selected host inside a repository and paste one of the prompts below.
# Simple task
"Fix the typo on line 42 in src/utils.ts"
# Medium task
"Add error handling to login, signup, and password reset"
# Complex task
"~go Add user authentication with JWT"
# Plan only
"~go plan Refactor the database layer"
[my-app-ai] Solution Design ✓
Plan: .sopify-skills/plan/20260323_auth/
Summary: JWT auth + token refresh + route guards
Tasks: 5 items
---
Next: Reply "continue" to start implementation
This is only a placeholder example of the pacing and format, not a fixed output contract; simple tasks are shorter, and complex tasks pause at checkpoints for confirmation.
For the full workflow, checkpoints, and plan lifecycle details, see How Sopify Works.
Start from the example config:
cp examples/sopify.config.yaml ./sopify.config.yaml
Most commonly used settings:
brand: auto
language: en-US
workflow:
mode: adaptive
require_score: 7
plan:
directory: .sopify-skills
Notes:
workflow.mode supports strict / adaptive / minimalplan.directory only affects newly created knowledge and plan directories| Command | Description |
|---------|-------------|
| ~go | Automatically route and run the full workflow |
| ~go plan | Plan only |
| ~go exec | Advanced restore/debug entry, not the default user path |
| ~go finalize | Close out the current metadata-managed plan |
Most users only need ~go and ~go plan; maintainer validation commands live in CONTRIBUTING.md.
sopify/
├── scripts/ # install, diagnostics, and maintainer scripts
├── examples/ # configuration examples
├── docs/ # workflow guides and developer references
├── runtime/ # built-in runtime / skill packages
├── .sopify-skills/ # project knowledge base
│ ├── blueprint/ # design baseline, reduction targets
│ │ └── architecture-decision-records/ # ADR entity files
│ ├── plan/ # active plans
│ └── history/ # archived plans
├── Codex/ # Codex host prompt layer
└── Claude/ # Claude host prompt layer
This is a simplified view of the core layout. See docs/how-sopify-works.en.md for the full workflow, checkpoints, and knowledge layout.
Update sopify.config.yaml:
language: zh-CN # or en-US
By default they live under .sopify-skills/ in the project root. To change that:
plan:
directory: .my-custom-dir
This only affects newly created directories; existing history is not migrated automatically.
--workspace prewarm?Most users do not need it. A default install is already complete; Sopify bootstraps the project-local runtime automatically on the first trigger.
Use --workspace only for maintainer validation, CI, or when you explicitly want to prewarm a specific repository ahead of time. For this advanced path, use the repo-local installer:
python3 scripts/install_sopify.py --target codex:en-US --workspace /path/to/project
Delete or clear .sopify-skills/user/preferences.md; keep feedback.jsonl only if you still want the audit trail.
When you change Codex/Skills/{CN,EN}, the mirrored Claude/Skills/{CN,EN} content, or runtime/builtin_skill_packages/*/skill.yaml, follow the validation steps in CONTRIBUTING.md.
This repository uses dual licensing:
For user-visible behavior changes, update both README.md and README.zh-CN.md when needed, then follow CONTRIBUTING.md for validation.