cyc-stack 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/.cursor-plugin/plugin.json +1 -1
- package/INSTALL.md +55 -10
- package/README.md +223 -146
- package/bin/cyc.mjs +11 -2
- package/docs/engineering/failure-handling.md +6 -0
- package/docs/installation.md +14 -12
- package/docs/response-standard.md +1 -1
- package/docs/runtime.md +2 -0
- package/docs/work-assessments.md +78 -0
- package/methods/cyc-scout/SKILL.md +1 -1
- package/methods/cyc-verify/SKILL.md +4 -1
- package/package.json +2 -4
- package/plugin.json +1 -1
- package/scripts/runtime.mjs +117 -8
- package/scripts/test-output.mjs +10 -0
- package/scripts/work-review.mjs +73 -4
- package/skills/cyc/SKILL.md +4 -2
- package/scripts/check-response.mjs +0 -13
package/INSTALL.md
CHANGED
|
@@ -1,27 +1,58 @@
|
|
|
1
1
|
# Install CYC Stack
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**Install from your project's terminal, then use CYC in your AI chat.** CYC Stack is [published on npm](https://www.npmjs.com/package/cyc-stack). The npm route needs Node.js 20+ and Claude Code, Codex or Cursor. Claude project hooks also need Bash, including Git Bash on Windows.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The steps below use the latest published release. For team rollouts, [pin a version](docs/installation.md#optional-npm-controls) and verify hook behavior in your host. A published package alone does not establish host activation.
|
|
6
6
|
|
|
7
7
|
## Install with npm
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
### 1. Install in your project
|
|
10
|
+
|
|
11
|
+
Open a terminal in your existing project's root and run:
|
|
10
12
|
|
|
11
13
|
```sh
|
|
12
|
-
npx cyc-stack@
|
|
14
|
+
npx cyc-stack@latest init
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
Accept npm's download prompt if it appears. Add `--dry-run` to preview changes before installing. No source checkout or global installation is needed, and the command does not add a dependency to your application's `package.json`.
|
|
18
|
+
|
|
19
|
+
Installation adds CYC's engine, one public `cyc` skill and host hooks. CYC detects hosts from existing project files; if none are detected, it sets up all three supported hosts. It preserves existing project instructions and unrelated hooks, and refuses conflicts with unowned or customized files.
|
|
20
|
+
|
|
21
|
+
### 2. Set up CYC in your AI chat
|
|
22
|
+
|
|
23
|
+
Reload your AI host in this project and review any hook-trust prompts. Then paste this into the chat:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
/cyc Set up CYC for this project. Find the checks we already use in CI,
|
|
27
|
+
help me configure verification, and preserve our hooks and conventions.
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
CYC helps configure the project's actual checks and reports what was verified. [Setup diagnostics](#finish-project-setup) distinguish installed files, configured checks and real hook activation.
|
|
31
|
+
|
|
32
|
+
### 3. Give it a task
|
|
33
|
+
|
|
34
|
+
In the same AI chat, describe the result you want. For example:
|
|
35
|
+
|
|
36
|
+
```text
|
|
37
|
+
/cyc Fix the checkout form so a failed payment preserves the customer's
|
|
38
|
+
inputs, shows a useful error, and lets them retry. Verify the recovery flow.
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Replace the example with your own task. `/cyc` belongs in the AI host, not the terminal. If the command is unavailable, select the discovered `cyc` skill or ask **“Use the cyc skill to…”**
|
|
42
|
+
|
|
43
|
+
<details>
|
|
44
|
+
<summary><strong>Optional: save CYC as a development dependency</strong></summary>
|
|
16
45
|
|
|
17
46
|
To keep CYC as a dependency in `package.json`, use:
|
|
18
47
|
|
|
19
48
|
```sh
|
|
20
|
-
npm install --save-dev cyc-stack
|
|
49
|
+
npm install --save-dev cyc-stack
|
|
21
50
|
npx cyc-stack init
|
|
22
51
|
```
|
|
23
52
|
|
|
24
|
-
`npm install` downloads the package; `init` sets up the project's AI integration.
|
|
53
|
+
`npm install` downloads the package; `init` sets up the project's AI integration. Applications can use any language; verification uses their own checks.
|
|
54
|
+
|
|
55
|
+
</details>
|
|
25
56
|
|
|
26
57
|
Previewing changes, choosing a host, saving a development dependency and selecting an approved version are [optional install controls](docs/installation.md#optional-npm-controls).
|
|
27
58
|
|
|
@@ -85,7 +116,19 @@ Local run/check records support verification and recovery in the target project.
|
|
|
85
116
|
|
|
86
117
|
Plugins use their host's update controls. Enable automatic marketplace updates where the host and team allow them. A team can keep an approved version; a publisher cannot force updates onto arbitrary public installations.
|
|
87
118
|
|
|
88
|
-
For npm,
|
|
119
|
+
For npm, finish or stop active work under the existing recovery rules. From the target project root, preview the latest release:
|
|
120
|
+
|
|
121
|
+
```sh
|
|
122
|
+
npx cyc-stack@latest init --dry-run
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Then apply it and reload your AI host:
|
|
126
|
+
|
|
127
|
+
```sh
|
|
128
|
+
npx cyc-stack@latest init
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
Teams can substitute an approved exact version. Updating an npm dependency alone does not refresh `.cyc/engine` or the copied skills. Valid project configuration and local run records are preserved. Customized managed files cause a conflict; back up and merge those customizations before retrying. CYC does not yet provide an automatic update checker or scheduler.
|
|
89
132
|
|
|
90
133
|
To remove a project installation, preview first:
|
|
91
134
|
|
|
@@ -96,7 +139,9 @@ node .cyc/engine/bin/cyc.mjs uninstall
|
|
|
96
139
|
|
|
97
140
|
Then remove the npm development dependency if you added it. Customized files and run records can be retained; inspect the command report. Plugin removal uses the host's own controls and does not imply deletion of project context or local evidence.
|
|
98
141
|
|
|
99
|
-
|
|
142
|
+
<a id="before-registry-publication"></a>
|
|
143
|
+
|
|
144
|
+
## Install without npm
|
|
100
145
|
|
|
101
146
|
Use a reviewed checkout with repository access:
|
|
102
147
|
|
|
@@ -105,4 +150,4 @@ node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application --dry-run
|
|
|
105
150
|
node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application
|
|
106
151
|
```
|
|
107
152
|
|
|
108
|
-
Quote paths containing spaces. An approved packed archive is another option; see [offline installation](docs/installation.md#private-repositories-and-npm-git-fetch-failures). These
|
|
153
|
+
Quote paths containing spaces. An approved packed archive is another option; see [offline installation](docs/installation.md#private-repositories-and-npm-git-fetch-failures). These are alternatives to the published npm package.
|