You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
English · [简体中文](./README.zh-CN.md) · [Quick Start](#quick-start) · [Configuration](#configuration) · [Contributors](./CONTRIBUTORS.md)
@@ -35,6 +35,15 @@ Sopify uses machine-readable protocols to make critical steps visible: when fact
35
35
- Multi-stage work that keeps moving in the same repository instead of one-off edits
36
36
- You're willing to manage progress with plan / blueprint artifacts and close out each stage
37
37
38
+
## What You Get After Install
39
+
40
+
- Your host is ready to run Sopify after install.
41
+
- The first time you trigger Sopify in a project, it prepares the local `.sopify-runtime/`.
42
+
-`status` shows the current host / workspace state.
43
+
-`doctor` shows deeper installation and runtime diagnostics and repair guidance.
44
+
45
+
This guide focuses on install visibility, verification, and stable first use; repository cleanup flows are intentionally out of scope here.
46
+
38
47
## Quick Start
39
48
40
49
### Installation
@@ -87,11 +96,20 @@ Notes:
87
96
Installer behavior:
88
97
89
98
- Installs the selected host prompt layer and the Sopify payload
90
-
- When `--workspace` is omitted, this is still a complete install; Sopify bootstraps `.sopify-runtime/` on the first project trigger
91
-
- Prewarms `.sopify-runtime/` when `--workspace` is provided
92
-
- Use `python3 scripts/sopify_status.py --format text` to inspect the support matrix and current workspace state
93
-
- Use `python3 scripts/sopify_doctor.py --format text` to inspect payload, bundle, and smoke diagnostics
94
-
-`status` / `doctor` surface the current path directly: `payload bundle: source_kind=global_active|legacy_layout|unresolved`, `payload outcome: ...`, and `workspace outcome: stub_selected [continue]` when a workspace stub is healthy
99
+
- A standard install makes your host ready to run Sopify; most users do not need `--workspace`
100
+
- Sopify prepares `.sopify-runtime/` the first time you trigger it in a project workspace
101
+
-`--workspace` is an advanced prewarm path for maintainers, CI, or explicit repository setup
102
+
103
+
### Verify Your Install
104
+
105
+
```bash
106
+
python3 scripts/sopify_status.py --format text
107
+
python3 scripts/sopify_doctor.py --format text
108
+
```
109
+
110
+
-`will bootstrap on first project trigger`: the host install is ready and the project-local runtime has not been prepared yet
111
+
-`workspace outcome: stub_selected [continue]`: the workspace runtime entry is healthy
112
+
- Payload or bundle corruption errors (for example `global_bundle_missing`, `global_bundle_incompatible`, or `global_index_corrupted`): repair the install and retry
95
113
96
114
### Choose an Entry by Task Size
97
115
@@ -103,6 +121,8 @@ Installer behavior:
103
121
104
122
### First Use
105
123
124
+
After install, open Codex or Claude inside a repository and paste one of the prompts below.
125
+
106
126
```bash
107
127
# Simple task
108
128
"Fix the typo on line 42 in src/utils.ts"
@@ -301,14 +321,6 @@ Use `--workspace` only for maintainer validation, CI, or when you explicitly wan
Use `python3 scripts/sopify_status.py --format text` first, then `python3 scripts/sopify_doctor.py --format text` if the workspace still looks suspicious.
307
-
308
-
- New repositories: no manual migration is needed. A normal install is already complete, and Sopify bootstraps `.sopify-runtime/` on the first project trigger.
309
-
- Already bootstrapped repositories: keep the existing `.sopify-runtime/`. A healthy thin-stub workspace should show `workspace outcome: stub_selected [continue]`.
310
-
- Old vendored repositories: still supported, but no one-click migrator is provided in this release. If `status` / `doctor` show `legacy_fallback_selected [warn]`, refresh the local install and trigger Sopify in that repository again. If the surface instead shows `global_bundle_missing`, `global_bundle_incompatible`, or `global_index_corrupted`, repair the installed payload first and retry.
311
-
312
324
### Q: How do I reset learned preferences?
313
325
314
326
Delete or clear `.sopify-skills/user/preferences.md`; keep `feedback.jsonl` only if you still want the audit trail.
0 commit comments