@kelceyp/caw 1.0.20 → 1.0.22

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.
Files changed (3) hide show
  1. package/README.md +105 -39
  2. package/dist/caw.js +6 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,16 +1,52 @@
1
1
  # CAW
2
2
 
3
- CAW provides independently useful capabilities that combine to provide powerful context and agentic workflows enabling your agents to build software sustainably. All capabilities are dual channel. React based web application for humans and rich MCP capabilities for agents. Everything you can do, agents can do too.
3
+ CAW helps users build software **sustainably** using AI by providing agents with **C**ontext and **A**gentic **W**orkflows (CAW). CAW is free to download and runs locally.
4
4
 
5
- ![CAW overview](https://athenadesign.com.au/caw/documents-editor.png)
5
+ ## Quick Start
6
6
 
7
- ## Content Management
7
+ ```bash
8
+ npm install -g @kelceyp/caw
9
+ caw start
10
+ ```
11
+ Then open [http://localhost:2229](http://localhost:2229) in your browser.
12
+
13
+ ![CAW overview](https://athenadesign.com.au/caw/stories-list.png)
14
+
15
+ ## Unlock sustainable development
16
+ Agents are capable coders but struggle to build software sustainably as the codebase and its complexity grow. Code reveals only so much and agents do not inherently know which parts of it to read or what the underlying intent was. Technical debt, technical mess, architectural mismatch and a host of problems creep in over time to grind progress to a halt.
17
+
18
+ In the agent era, engineering discipline is still needed. With CAW, it's cheap.
19
+
20
+ CAW enables users and agents to capture the architecture, intent, decisions and engineering discipline specific to a project as part of its knowledge base. Agents help build that knowledge base and keep it aligned with the codebase as the project grows. Creating content is easy. Creating content that is discoverable when needed is not. This is where CAW shines with useful information topologies and powerful search capabilities.
21
+
22
+ Using stories, CAW facilitates a thin slice, shift-left philosophy where agents can decompose the work and assist with specification, design and planning before coding. Upstream agents use CAW to provide downstream agents the 'Goldilocks' amount of context for the work they've been given. At each step of the way CAW reduces friction in human-to-agent and agent-to-agent collaboration. This enables humans to seamlessly inject themselves where most needed and get out of the way when not.
23
+
24
+ When multiple agents collaborate on the same piece of work, hallucinations are more likely to be caught and quality improves. This is true whether it be at the design and planning stage or at the coding and testing stage. CAW works with any agent that supports MCP and has specific integrations for Claude Code, Codex and Cursor CLI that enable agent orchestration. For humans, think of this as a browser-based reskinning of these tools. For agents, this means that any of these three agents can be used by any other as a "sub-agent". And this works recursively to a user configurable depth.
25
+
26
+ ## Dual channel
27
+
28
+ Everything you can do, agents can do too.
29
+
30
+ CAW combines independently useful capabilities that integrate with each other seamlessly to provide powerful higher-level functions. Every capability is available to humans through a React-based web application and to agents through rich MCP tooling. Go meta and have your agents assist with your project specific context engineering.
8
31
 
9
- Build your agent knowledge base in lock step with your code base.
32
+ ## Proof point
33
+
34
+ CAW was used to build CAW recursively, with version N building version N+1. In doing so, CAW was continuously dogfooded, proving the approach on a substantial software system.
35
+
36
+ ## Content is king
37
+
38
+ Why start with a blank slate?
39
+
40
+ The prompts, templates and knowledge cartridges used to build CAW are also available as a free download from [Athena Design](https://athenadesign.com.au/). The CAW user manual can be downloaded separately and imported into the shared store, making it available to users and agents across every project. Use the 'Import Bundle' feature in project settings and shared store settings.
41
+
42
+ # Capabilities
43
+ ## Documents
44
+
45
+ Build your product knowledge base in lock step with your code base.
10
46
 
11
47
  - Extended MD capabilities including inline mermaid, inline SVG, linking and includes
12
48
  - Monaco editor and extended marked rendering capabilities for users
13
- - Real time SSE updates
49
+ - Real time updates using SSE
14
50
  - Typed metadata including multivalued fields
15
51
  - Locking, clobber protection and version control
16
52
  - Image deduping and easy pasting/viewing
@@ -53,33 +89,63 @@ Create powerful templates for documents, prompts and saved searches.
53
89
  - Rich MCP tooling so that agents can assist you with context engineering
54
90
 
55
91
  <details>
56
- <summary>Editing</summary>
92
+ <summary>Template Editing</summary>
57
93
  <a href="https://athenadesign.com.au/caw/templates-editing.png">
58
94
  <img src="https://athenadesign.com.au/caw/templates-editing.png" alt="Editing" width="900"/>
59
95
  </a>
60
96
  </details>
61
97
 
62
98
  <details>
63
- <summary>Form rendering</summary>
99
+ <summary>Render Template</summary>
64
100
  <a href="https://athenadesign.com.au/caw/templates-rendering.png">
65
101
  <img src="https://athenadesign.com.au/caw/templates-rendering.png" alt="Form rendering" width="900"/>
66
102
  </a>
67
103
  </details>
68
104
 
69
- ## Agent Orchestration
105
+ ## Jobs
70
106
 
71
107
  Orchestrate your locally installed agents.
72
108
 
73
- - Browser based reskinning of Claude Code, Codex and Cursor CLI
109
+ - Unified browser-based reskinning of Claude Code, Codex and Cursor CLI
74
110
  - In chat UI wireframing using inline SVG
75
111
  - In chat mermaid diagramming
76
- - Multi-level cross vendor subagents (have Claude supervise Codex supervising Cursor)
112
+ - Multi-level cross-vendor subagents
77
113
  - Capture all prompts and outputs making them easily findable
78
114
  - Act as the orchestration hub for agents to communicate with one another
79
115
  - Seamlessly jump between REPLs and web application
80
- - Use the right model for the job
81
- - Unlock powerful agent patterns
82
- - Requires user to explicitly enable this feature in settings
116
+ - Use the right agent, model and effort level for the job
117
+ - Unlock powerful, repeatable and refinable agentic workflow patterns
118
+ - Automatic worktree configuration
119
+ - Run agents in containers or host or both
120
+ - Disabled by default and must be explicitly enabled in Preferences \> Agents
121
+
122
+ <details>
123
+ <summary>Job List View - Active Jobs</summary>
124
+ <a href="https://athenadesign.com.au/caw/job-list-active-jobs.png">
125
+ <img src="https://athenadesign.com.au/caw/job-list-active-jobs.png" alt="Job List View" width="900"/>
126
+ </a>
127
+ </details>
128
+
129
+ <details>
130
+ <summary>Job Details - Supervisor Job</summary>
131
+ <a href="https://athenadesign.com.au/caw/jobs-supervisor-details.png">
132
+ <img src="https://athenadesign.com.au/caw/jobs-supervisor-details.png" alt="Supervisor Job" width="900"/>
133
+ </a>
134
+ </details>
135
+
136
+ <details>
137
+ <summary>Job Details - Chat interface</summary>
138
+ <a href="https://athenadesign.com.au/caw/jobs-continuing-conversations.png">
139
+ <img src="https://athenadesign.com.au/caw/jobs-continuing-conversations.png" alt="Supervisor Job" width="900"/>
140
+ </a>
141
+ </details>
142
+
143
+ <details>
144
+ <summary>Job Details - Append prompt</summary>
145
+ <a href="https://athenadesign.com.au/caw/job-details-append-prompt.png">
146
+ <img src="https://athenadesign.com.au/caw/job-details-append-prompt.png" alt="Supervisor Job" width="900"/>
147
+ </a>
148
+ </details>
83
149
 
84
150
  ## Stories
85
151
 
@@ -87,14 +153,28 @@ Use a thin slice mentality to build software incrementally.
87
153
 
88
154
  - Leverage document templates for each stage of the story lifecycle
89
155
  - Leverage prompt templates to orchestrate agents at each stage of the story lifecycle
90
- - Eliminate agent assumptions using acceptance criteria
156
+ - Reduce agent assumptions using acceptance criteria
91
157
  - Define the various tracks your stories take
92
158
  - Manage your own cognitive load as the amount of parallel work increases
93
159
 
94
160
  <details>
95
- <summary>Story document explorer</summary>
96
- <a href="https://athenadesign.com.au/caw/stories-list.png">
97
- <img src="https://athenadesign.com.au/caw/stories-list.png" alt="Story document explorer" width="900"/>
161
+ <summary>Story Details - Document Explorer</summary>
162
+ <a href="https://athenadesign.com.au/caw/story-details-docs-tab.png">
163
+ <img src="https://athenadesign.com.au/caw/story-details-docs-tab.png" alt="Story document explorer" width="900"/>
164
+ </a>
165
+ </details>
166
+
167
+ <details>
168
+ <summary>Story Details - Tasks</summary>
169
+ <a href="https://athenadesign.com.au/caw/story-kanban-tab.png">
170
+ <img src="https://athenadesign.com.au/caw/story-kanban-tab.png" alt="Story tasks" width="900"/>
171
+ </a>
172
+ </details>
173
+
174
+ <details>
175
+ <summary>Story Details - Jobs</summary>
176
+ <a href="https://athenadesign.com.au/caw/story-details-three-amigos.png">
177
+ <img src="https://athenadesign.com.au/caw/story-details-three-amigos.png" alt="Story jobs" width="900"/>
98
178
  </a>
99
179
  </details>
100
180
 
@@ -102,20 +182,13 @@ Use a thin slice mentality to build software incrementally.
102
182
 
103
183
  Find what you and your agents need as the knowledge base grows.
104
184
 
105
- - Metadata based search with expressions
106
- - Full text search
185
+ - Metadata-based search with expressions
186
+ - Full-text search
107
187
  - RAG (i.e. semantic) search
108
188
  - Ancestor walks
109
189
  - Expressive query language
110
190
  - Supports all entities
111
191
 
112
- <details>
113
- <summary>Search box</summary>
114
- <a href="https://athenadesign.com.au/caw/search-box.png">
115
- <img src="https://athenadesign.com.au/caw/search-box.png" alt="Search box" width="900"/>
116
- </a>
117
- </details>
118
-
119
192
  <details>
120
193
  <summary>Query builder</summary>
121
194
  <a href="https://athenadesign.com.au/caw/search-query-builder.png">
@@ -139,16 +212,9 @@ Find what you and your agents need as the knowledge base grows.
139
212
 
140
213
  ## The Voltron Effect
141
214
 
142
- Unlock powerful automation by bringing these capabilities together. Define the visibility of prompt templates for each stage of each story track. Provide detailed and repeatable processes that are specific to your project that enable agents to find what they need and execute with the goldilocks amount of context to build sustainably.
143
-
144
- # Quick Start
215
+ Unlock powerful automation by bringing these capabilities together. Define the visibility of prompt templates for each stage of each story track. Provide detailed and repeatable processes that are specific to your project that enable agents to find what they need and execute with the Goldilocks amount of context to build sustainably.
145
216
 
146
- ```bash
147
- npm install -g @kelceyp/caw
148
- caw start
149
- ```
150
-
151
- Then open [http://localhost:2229](http://localhost:2229) in your browser.
217
+ ![Voltron Effect](https://athenadesign.com.au/caw/voltron-effect.png)
152
218
 
153
219
  ## Commands
154
220
 
@@ -166,11 +232,11 @@ caw upgrade # Upgrade to the latest version
166
232
 
167
233
  ## Optional Integrations
168
234
 
169
- All optional integrations are configured via Preferences > Infrastructure in the web UI.
235
+ All optional integrations are configured via Preferences > Infrastructure in the web UI. These integrations rely on 3rd party tools that require their own installation and setup outside of CAW. For detailed instructions visit [Athena Design](https://athenadesign.com.au/) or simply download and import the user manual and have agents perform the setup for you following the instructions provided.
170
236
 
171
237
  ### Caddy
172
238
 
173
- - Enable HTTPS and HTTP2/SPDY
239
+ - Enable HTTPS and HTTP2
174
240
  - Remove browser limitations on number of concurrent connections
175
241
  - Cleaner `caw.localhost` rather than `localhost:2229`
176
242
 
@@ -192,8 +258,8 @@ All optional integrations are configured via Preferences > Infrastructure in the
192
258
 
193
259
  ## Links
194
260
 
195
- - [Report an Issue or request a Feature](https://github.com/kelceyp-mcp-servers/caw-feedback/issues)
261
+ - [Report an issue or request a feature](https://github.com/kelceyp-mcp-servers/caw-feedback/issues)
196
262
 
197
263
  ## License
198
264
 
199
- Proprietary. All rights reserved.
265
+ Proprietary. All rights reserved.
package/dist/caw.js CHANGED
@@ -10805,10 +10805,12 @@ function createPidManager(envDir) {
10805
10805
  start(mainJsPath, envVars, nodeArgs = []) {
10806
10806
  const logPath = logFilePath(envDir);
10807
10807
  const logFd = fs5.openSync(logPath, "a");
10808
+ const env2 = { ...process.env, ...envVars };
10809
+ delete env2.CAW_DEVELOPER_TOOLS;
10808
10810
  const child = spawn(process.execPath, [...nodeArgs, mainJsPath], {
10809
10811
  detached: true,
10810
10812
  stdio: ["ignore", logFd, logFd],
10811
- env: { ...process.env, ...envVars }
10813
+ env: env2
10812
10814
  });
10813
10815
  writePid(envDir, child.pid);
10814
10816
  child.unref();
@@ -10885,7 +10887,9 @@ function createPm2Manager(envDir, checkPm2 = isPm2Installed) {
10885
10887
  const logPath = logFilePath(envDir);
10886
10888
  const envArgs = Object.entries(envVars).map(([k, v]) => `${k}=${v}`).join(" ");
10887
10889
  const nodeArgsStr = nodeArgs.length > 0 ? ` --node-args="${nodeArgs.join(" ")}"` : "";
10888
- execSync3(`${envArgs} pm2 start ${mainJsPath} --name ${name}${nodeArgsStr} --output ${logPath} --error ${logPath} --merge-logs`, { stdio: "inherit", env: { ...process.env, ...envVars } });
10890
+ const env2 = { ...process.env, ...envVars };
10891
+ delete env2.CAW_DEVELOPER_TOOLS;
10892
+ execSync3(`${envArgs} pm2 start ${mainJsPath} --name ${name}${nodeArgsStr} --output ${logPath} --error ${logPath} --merge-logs`, { stdio: "inherit", env: env2 });
10889
10893
  return name;
10890
10894
  },
10891
10895
  isRunning() {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kelceyp/caw",
3
- "version": "1.0.20",
3
+ "version": "1.0.22",
4
4
  "description": "CAW launcher — server lifecycle management CLI",
5
5
  "type": "module",
6
6
  "bin": {