cyc-stack 0.6.0 → 0.7.1

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.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cycstack",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "license": "MIT",
5
5
  "description": "Portable AI engineering workflows with shared project context and verifiable changes.",
6
6
  "author": {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cycstack",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "license": "MIT",
5
5
  "description": "Portable AI engineering workflows with shared project context and verifiable changes.",
6
6
  "author": {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cycstack",
3
- "version": "0.6.0",
3
+ "version": "0.7.1",
4
4
  "license": "MIT",
5
5
  "description": "Portable AI engineering workflows with shared project context and verifiable changes.",
6
6
  "author": {
package/INSTALL.md CHANGED
@@ -1,27 +1,60 @@
1
1
  # Install CYC Stack
2
2
 
3
- Choose one route. All routes use the same CYC methods and project context. Full local workflows need Node.js 20+ and a supported AI host; Claude project hooks also need Bash, including Git Bash on Windows.
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
- **Release channels:** the public repository contains the npm and plugin distributions. Registry commands require a published version on the selected channel; a reviewed checkout or approved archive also works. Native-host qualification remains pending. Maintainers: [build and publish the release](https://github.com/TheDThompsonDev/cyc-stack/blob/main/docs/maintainers/distribution.md).
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
- After the pilot is published to `next`, run from the application project root:
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@next init
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
+ Interactive terminals show a short installation summary, setup notes and the next step. Add `--json` for the complete structured result; piped output and `--verbose` continue to use JSON. Previews and conflicts are labeled explicitly.
20
+
21
+ 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.
22
+
23
+ ### 2. Set up CYC in your AI chat
24
+
25
+ Reload your AI host in this project and review any hook-trust prompts. Then paste this into the chat:
26
+
27
+ ```text
28
+ /cyc Set up CYC for this project. Find the checks we already use in CI,
29
+ help me configure verification, and preserve our hooks and conventions.
30
+ ```
31
+
32
+ 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.
33
+
34
+ ### 3. Give it a task
35
+
36
+ In the same AI chat, describe the result you want. For example:
37
+
38
+ ```text
39
+ /cyc Fix the checkout form so a failed payment preserves the customer's
40
+ inputs, shows a useful error, and lets them retry. Verify the recovery flow.
13
41
  ```
14
42
 
15
- No flags are required. npm may ask before downloading the package. 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.
43
+ 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…”**
44
+
45
+ <details>
46
+ <summary><strong>Optional: save CYC as a development dependency</strong></summary>
16
47
 
17
48
  To keep CYC as a dependency in `package.json`, use:
18
49
 
19
50
  ```sh
20
- npm install --save-dev cyc-stack@next
51
+ npm install --save-dev cyc-stack
21
52
  npx cyc-stack init
22
53
  ```
23
54
 
24
- `npm install` downloads the package; `init` sets up the project's AI integration. The one-command route above does both without adding a dependency to `package.json`. Applications can use any language; verification uses their own checks. After installation, [finish project setup](#finish-project-setup).
55
+ `npm install` downloads the package; `init` sets up the project's AI integration. Applications can use any language; verification uses their own checks.
56
+
57
+ </details>
25
58
 
26
59
  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
60
 
@@ -85,7 +118,19 @@ Local run/check records support verification and recovery in the target project.
85
118
 
86
119
  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
120
 
88
- For npm, select the desired published version and rerun its installer. Updating the dependency alone does not refresh `.cyc/engine` or the copied skills. Preview changes, finish or stop active work under the existing recovery rules, update, then reload the host. CYC does not yet provide an automatic update checker or scheduler.
121
+ For npm, finish or stop active work under the existing recovery rules. From the target project root, preview the latest release:
122
+
123
+ ```sh
124
+ npx cyc-stack@latest init --dry-run
125
+ ```
126
+
127
+ Then apply it and reload your AI host:
128
+
129
+ ```sh
130
+ npx cyc-stack@latest init
131
+ ```
132
+
133
+ 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
134
 
90
135
  To remove a project installation, preview first:
91
136
 
@@ -96,7 +141,9 @@ node .cyc/engine/bin/cyc.mjs uninstall
96
141
 
97
142
  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
143
 
99
- ## Before registry publication
144
+ <a id="before-registry-publication"></a>
145
+
146
+ ## Install without npm
100
147
 
101
148
  Use a reviewed checkout with repository access:
102
149
 
@@ -105,4 +152,4 @@ node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application --dry-run
105
152
  node /path/to/cycstack/bin/cyc.mjs init --project /path/to/application
106
153
  ```
107
154
 
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 paths use the real installer while publication is pending.
155
+ 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.