cyc-stack 0.0.0-stage → 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/.agents/plugins/marketplace.json +12 -0
- package/.claude-plugin/marketplace.json +14 -0
- package/.claude-plugin/plugin.json +17 -0
- package/.codex-plugin/plugin.json +33 -0
- package/.cursor-plugin/marketplace.json +13 -0
- package/.cursor-plugin/plugin.json +19 -0
- package/INSTALL.md +153 -0
- package/LICENSE +21 -0
- package/README.md +436 -2
- package/bin/cyc.mjs +294 -0
- package/catalog/playbooks.json +20 -0
- package/docs/README.md +30 -0
- package/docs/assets/cyc-method-library.svg +39 -0
- package/docs/assets/cyc-overview.svg +44 -0
- package/docs/assets/cyc-readme-banner-mobile.svg +31 -0
- package/docs/assets/cyc-readme-banner.svg +39 -0
- package/docs/assets/cyc-workflow-diagram.svg +415 -0
- package/docs/code-quality.md +42 -0
- package/docs/context.md +40 -0
- package/docs/cyc-method-map.md +58 -0
- package/docs/cyc-workflow.md +188 -0
- package/docs/engineering/code-standards.md +103 -0
- package/docs/engineering/domain-design.md +81 -0
- package/docs/engineering/failure-handling.md +105 -0
- package/docs/impact-analysis.md +70 -0
- package/docs/installation.md +198 -0
- package/docs/onboarding-recovery.md +75 -0
- package/docs/principles.md +49 -0
- package/docs/project-tools.md +108 -0
- package/docs/response-standard.md +202 -0
- package/docs/runtime.md +249 -0
- package/docs/skill-contract.md +70 -0
- package/docs/skill-craft.md +23 -0
- package/docs/validation.md +39 -0
- package/docs/work-assessments.md +180 -0
- package/hooks/claude.json +10 -0
- package/hooks/codex.json +28 -0
- package/hooks/cursor.json +8 -0
- package/methods/cyc-build/SKILL.md +65 -0
- package/methods/cyc-build/references/file-writes.md +11 -0
- package/methods/cyc-challenge/SKILL.md +48 -0
- package/methods/cyc-context/SKILL.md +76 -0
- package/methods/cyc-context/references/evidence.md +27 -0
- package/methods/cyc-context/references/templates.md +54 -0
- package/methods/cyc-context/scripts/evidence.mjs +61 -0
- package/methods/cyc-correct/SKILL.md +43 -0
- package/methods/cyc-deliver/SKILL.md +52 -0
- package/methods/cyc-design/SKILL.md +50 -0
- package/methods/cyc-design/frontend-design/SKILL.md +43 -0
- package/methods/cyc-design/frontend-design/references/color.md +77 -0
- package/methods/cyc-design/frontend-design/references/craft-rules.md +61 -0
- package/methods/cyc-design/frontend-design/references/decision-sheet.md +110 -0
- package/methods/cyc-design/frontend-design/references/experience-review.md +58 -0
- package/methods/cyc-design/frontend-design/references/generic-tells.md +76 -0
- package/methods/cyc-design/frontend-design/references/layout-archetypes.md +188 -0
- package/methods/cyc-design/frontend-design/references/reference-standards.md +38 -0
- package/methods/cyc-design/frontend-design/references/typography.md +51 -0
- package/methods/cyc-design/frontend-design/references/ux-foundations.md +45 -0
- package/methods/cyc-design/frontend-design/references/visual-material.md +42 -0
- package/methods/cyc-error-ledger/SKILL.md +53 -0
- package/methods/cyc-error-ledger/references/entry-format.md +38 -0
- package/methods/cyc-explore/SKILL.md +41 -0
- package/methods/cyc-frame/SKILL.md +49 -0
- package/methods/cyc-impact/SKILL.md +64 -0
- package/methods/cyc-reflect/SKILL.md +48 -0
- package/methods/cyc-remember/SKILL.md +53 -0
- package/methods/cyc-scout/SKILL.md +67 -0
- package/methods/cyc-setup/SKILL.md +60 -0
- package/methods/cyc-teach/SKILL.md +40 -0
- package/methods/cyc-understand/SKILL.md +40 -0
- package/methods/cyc-understand/references/diagnose.md +53 -0
- package/methods/cyc-verify/SKILL.md +87 -0
- package/methods/cyc-verify/references/recipe.md +53 -0
- package/package.json +91 -4
- package/plugin.json +40 -0
- package/rules/cyc-delivery.mdc +33 -0
- package/scripts/baseline-worker.mjs +10 -0
- package/scripts/catalog.mjs +29 -0
- package/scripts/claude-project-hook.mjs +12 -0
- package/scripts/context-review.mjs +600 -0
- package/scripts/host-activation.mjs +66 -0
- package/scripts/install.mjs +387 -0
- package/scripts/onboarding.mjs +110 -0
- package/scripts/packet.mjs +107 -0
- package/scripts/project-tools.mjs +196 -0
- package/scripts/recovery.mjs +66 -0
- package/scripts/response-gate.mjs +105 -0
- package/scripts/response-hook.mjs +237 -0
- package/scripts/response-mode.mjs +12 -0
- package/scripts/run-gate.mjs +264 -0
- package/scripts/runtime.mjs +1832 -0
- package/scripts/source-hash-worker.mjs +5 -0
- package/scripts/source-snapshot.mjs +405 -0
- package/scripts/test-output.mjs +268 -0
- package/scripts/work-review.mjs +326 -0
- package/skills/cyc/SKILL.md +132 -0
- package/skills/cyc/references/playbooks/bug-fix.md +13 -0
- package/skills/cyc/references/playbooks/evaluate.md +13 -0
- package/skills/cyc/references/playbooks/experience.md +7 -0
- package/skills/cyc/references/playbooks/explore.md +9 -0
- package/skills/cyc/references/playbooks/feature.md +14 -0
- package/skills/cyc/references/playbooks/handoff.md +11 -0
- package/skills/cyc/references/playbooks/investigation.md +7 -0
- package/skills/cyc/references/playbooks/performance.md +7 -0
- package/skills/cyc/references/playbooks/plan.md +11 -0
- package/skills/cyc/references/playbooks/refactor.md +12 -0
- package/skills/cyc/references/playbooks/reflect.md +11 -0
- package/skills/cyc/references/playbooks/resume.md +11 -0
- package/skills/cyc/references/playbooks/review.md +9 -0
- package/skills/cyc/references/playbooks/teach.md +11 -0
- package/skills/cyc/references/playbooks/verify.md +7 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"interface": { "displayName": "CYC Stack" },
|
|
4
|
+
"plugins": [
|
|
5
|
+
{
|
|
6
|
+
"name": "cycstack",
|
|
7
|
+
"source": { "source": "local", "path": "./" },
|
|
8
|
+
"policy": { "installation": "AVAILABLE", "authentication": "ON_INSTALL" },
|
|
9
|
+
"category": "Productivity"
|
|
10
|
+
}
|
|
11
|
+
]
|
|
12
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "CYC Stack contributors"
|
|
5
|
+
},
|
|
6
|
+
"description": "CYC Stack: verified, loop-engineered AI workflows for software teams.",
|
|
7
|
+
"plugins": [
|
|
8
|
+
{
|
|
9
|
+
"name": "cycstack",
|
|
10
|
+
"source": "./",
|
|
11
|
+
"description": "Portable AI engineering workflows with shared project context and verifiable changes."
|
|
12
|
+
}
|
|
13
|
+
]
|
|
14
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"description": "Portable AI engineering workflows with shared project context and verifiable changes.",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "CYC Stack contributors"
|
|
8
|
+
},
|
|
9
|
+
"keywords": [
|
|
10
|
+
"engineering",
|
|
11
|
+
"skills",
|
|
12
|
+
"verification",
|
|
13
|
+
"loop-engineering",
|
|
14
|
+
"context-engineering"
|
|
15
|
+
],
|
|
16
|
+
"hooks": "./hooks/claude.json"
|
|
17
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"description": "Portable AI engineering workflows with shared project context and verifiable changes.",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "CYC Stack contributors"
|
|
8
|
+
},
|
|
9
|
+
"skills": "./skills/",
|
|
10
|
+
"keywords": [
|
|
11
|
+
"engineering",
|
|
12
|
+
"skills",
|
|
13
|
+
"verification",
|
|
14
|
+
"loop-engineering",
|
|
15
|
+
"context-engineering"
|
|
16
|
+
],
|
|
17
|
+
"interface": {
|
|
18
|
+
"displayName": "CYC Stack",
|
|
19
|
+
"shortDescription": "Portable workflows with visible evidence",
|
|
20
|
+
"longDescription": "Coordinate reusable skills, investigate affected behavior, loop until verified, and keep a project history of context and errors. Ask CYC to set up each project to activate the delivery gate.",
|
|
21
|
+
"developerName": "CYC Stack contributors",
|
|
22
|
+
"category": "Productivity",
|
|
23
|
+
"capabilities": [
|
|
24
|
+
"Interactive",
|
|
25
|
+
"Write"
|
|
26
|
+
],
|
|
27
|
+
"defaultPrompt": [
|
|
28
|
+
"Set up CYC in this project.",
|
|
29
|
+
"Use CYC to fix this bug and verify affected behavior."
|
|
30
|
+
]
|
|
31
|
+
},
|
|
32
|
+
"hooks": "./hooks/codex.json"
|
|
33
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "CYC Stack contributors"
|
|
5
|
+
},
|
|
6
|
+
"plugins": [
|
|
7
|
+
{
|
|
8
|
+
"name": "cycstack",
|
|
9
|
+
"source": ".",
|
|
10
|
+
"description": "Portable AI engineering workflows with shared project context and verifiable changes."
|
|
11
|
+
}
|
|
12
|
+
]
|
|
13
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "cycstack",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"description": "Portable AI engineering workflows with shared project context and verifiable changes.",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "CYC Stack contributors"
|
|
8
|
+
},
|
|
9
|
+
"keywords": [
|
|
10
|
+
"engineering",
|
|
11
|
+
"skills",
|
|
12
|
+
"verification",
|
|
13
|
+
"loop-engineering",
|
|
14
|
+
"context-engineering"
|
|
15
|
+
],
|
|
16
|
+
"skills": "./skills/",
|
|
17
|
+
"rules": "./rules/",
|
|
18
|
+
"hooks": "./hooks/cursor.json"
|
|
19
|
+
}
|
package/INSTALL.md
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
# Install CYC Stack
|
|
2
|
+
|
|
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
|
+
|
|
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
|
+
|
|
7
|
+
## Install with npm
|
|
8
|
+
|
|
9
|
+
### 1. Install in your project
|
|
10
|
+
|
|
11
|
+
Open a terminal in your existing project's root and run:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npx cyc-stack@latest init
|
|
15
|
+
```
|
|
16
|
+
|
|
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>
|
|
45
|
+
|
|
46
|
+
To keep CYC as a dependency in `package.json`, use:
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
npm install --save-dev cyc-stack
|
|
50
|
+
npx cyc-stack init
|
|
51
|
+
```
|
|
52
|
+
|
|
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>
|
|
56
|
+
|
|
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).
|
|
58
|
+
|
|
59
|
+
## Ask your agent
|
|
60
|
+
|
|
61
|
+
Give your agent this request in the project where you want CYC:
|
|
62
|
+
|
|
63
|
+
```text
|
|
64
|
+
Install CYC Stack in this project. Follow its INSTALL.md at
|
|
65
|
+
https://github.com/TheDThompsonDev/cyc-stack/blob/main/INSTALL.md
|
|
66
|
+
or the reviewed local checkout I provide. Preview the local changes,
|
|
67
|
+
preserve our instructions and unrelated hooks, then configure our real
|
|
68
|
+
project checks and tell me whether this host actually loaded the hooks.
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Teams can replace `main` with their approved tag or commit. The agent needs its normal command and filesystem capabilities; CYC does not connect to it through a separate service.
|
|
72
|
+
|
|
73
|
+
Agent procedure: follow [agent-guided installation](docs/installation.md#agent-guided-installation).
|
|
74
|
+
|
|
75
|
+
An isolated copy of `skills/cyc` is insufficient: its methods and CLI are part of the same distribution. Use the installer or a complete plugin bundle.
|
|
76
|
+
|
|
77
|
+
## Install as a plugin
|
|
78
|
+
|
|
79
|
+
Install the native plugin, then ask **“Use CYC to set up this project.”** Plugin installation makes methods available; project activation and check configuration happen separately. Your host owns plugin files and updates. The existing `activate` command creates project config and ignore rules; it does not install Node or prove hooks are active.
|
|
80
|
+
|
|
81
|
+
For **Claude Code**, the repository includes a marketplace. Once the source is accessible and the host integration qualified:
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
claude plugin marketplace add TheDThompsonDev/cyc-stack
|
|
85
|
+
claude plugin install cycstack@cycstack
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
For **Codex desktop**, register the public repository marketplace using a current Codex CLI:
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
codex plugin marketplace add TheDThompsonDev/cyc-stack
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Restart the desktop app, open its plugin browser, select the **CYC Stack** marketplace and install **CYC Stack**. Review and trust its hooks through the host UI, then run setup. If your client lacks this marketplace command, use the [manual repository marketplace flow](https://developers.openai.com/plugins/build/plugins#install-a-local-plugin-manually).
|
|
95
|
+
|
|
96
|
+
The repository catalog is `.agents/plugins/marketplace.json`. Root `plugin.json` is the portable manifest; `.codex-plugin/plugin.json` remains the compatibility fallback. The same npm archive contains both. CYC's lifecycle-hook plugin cannot currently be listed unchanged in OpenAI's public directory. Installing a skills-only listing on the web would not deploy local hooks. [OpenAI distribution limits](https://developers.openai.com/plugins/build/plugins#bundled-mcp-servers-and-lifecycle-hooks).
|
|
97
|
+
|
|
98
|
+
For **Cursor**, use its native plugin flow with `.cursor-plugin/plugin.json`; the full bundle includes rules and Cursor-specific hooks. Local import can be restricted by team policy. Official marketplace listing is a separate review step. [Cursor plugin installation](https://cursor.com/docs/plugins).
|
|
99
|
+
|
|
100
|
+
The discovered invocation can be namespaced, such as a plugin's `cyc` command. You can always ask the host to use the discovered CYC skill by name. Do not install both routes just to obtain the same methods. If both exist, verify which integration owns the hooks; plugin hooks defer to a project installation for that host.
|
|
101
|
+
|
|
102
|
+
## Finish project setup
|
|
103
|
+
|
|
104
|
+
Reload the host and review any hook-trust prompt through its normal UI. Ask CYC to find and configure the project's existing checks. For project installations:
|
|
105
|
+
|
|
106
|
+
```sh
|
|
107
|
+
node .cyc/engine/bin/cyc.mjs doctor
|
|
108
|
+
node .cyc/engine/bin/cyc.mjs onboard
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
`doctor` checks files and configuration. `onboard` separates remaining setup steps; inspection runs no project checks. Passing diagnostics alone does not establish native hook activation. For plugin installs, the agent resolves these CLI commands from the plugin's own directory.
|
|
112
|
+
|
|
113
|
+
Local run/check records support verification and recovery in the target project. No adoption analytics system is required. Review [installation details](docs/installation.md) for file ownership, retained records, updates and removal.
|
|
114
|
+
|
|
115
|
+
## Updates and removal
|
|
116
|
+
|
|
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.
|
|
118
|
+
|
|
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.
|
|
132
|
+
|
|
133
|
+
To remove a project installation, preview first:
|
|
134
|
+
|
|
135
|
+
```sh
|
|
136
|
+
node .cyc/engine/bin/cyc.mjs uninstall --dry-run
|
|
137
|
+
node .cyc/engine/bin/cyc.mjs uninstall
|
|
138
|
+
```
|
|
139
|
+
|
|
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.
|
|
141
|
+
|
|
142
|
+
<a id="before-registry-publication"></a>
|
|
143
|
+
|
|
144
|
+
## Install without npm
|
|
145
|
+
|
|
146
|
+
Use a reviewed checkout with repository access:
|
|
147
|
+
|
|
148
|
+
```sh
|
|
149
|
+
node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application --dry-run
|
|
150
|
+
node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application
|
|
151
|
+
```
|
|
152
|
+
|
|
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.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Danny Thompson
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|