@kelceyp/caw 1.0.21 → 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.
- package/README.md +93 -45
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,34 +1,52 @@
|
|
|
1
1
|
# CAW
|
|
2
2
|
|
|
3
|
-
CAW helps users build software **sustainably** using AI by providing agents with **C**ontext and **A**gentic **W**orkflows (CAW).
|
|
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
|
+
## Quick Start
|
|
6
|
+
|
|
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
|
+

|
|
14
|
+
|
|
15
|
+
## Unlock sustainable development
|
|
5
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.
|
|
6
17
|
|
|
7
|
-
|
|
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.
|
|
8
21
|
|
|
9
|
-
CAW
|
|
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.
|
|
10
23
|
|
|
11
|
-
|
|
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.
|
|
12
25
|
|
|
13
|
-
|
|
26
|
+
## Dual channel
|
|
14
27
|
|
|
15
|
-
|
|
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.
|
|
31
|
+
|
|
32
|
+
## Proof point
|
|
16
33
|
|
|
17
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.
|
|
18
35
|
|
|
19
|
-
|
|
36
|
+
## Content is king
|
|
20
37
|
|
|
21
|
-
|
|
38
|
+
Why start with a blank slate?
|
|
22
39
|
|
|
23
|
-
|
|
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.
|
|
24
41
|
|
|
25
|
-
|
|
42
|
+
# Capabilities
|
|
43
|
+
## Documents
|
|
26
44
|
|
|
27
45
|
Build your product knowledge base in lock step with your code base.
|
|
28
46
|
|
|
29
47
|
- Extended MD capabilities including inline mermaid, inline SVG, linking and includes
|
|
30
48
|
- Monaco editor and extended marked rendering capabilities for users
|
|
31
|
-
-
|
|
49
|
+
- Real time updates using SSE
|
|
32
50
|
- Typed metadata including multivalued fields
|
|
33
51
|
- Locking, clobber protection and version control
|
|
34
52
|
- Image deduping and easy pasting/viewing
|
|
@@ -71,33 +89,63 @@ Create powerful templates for documents, prompts and saved searches.
|
|
|
71
89
|
- Rich MCP tooling so that agents can assist you with context engineering
|
|
72
90
|
|
|
73
91
|
<details>
|
|
74
|
-
<summary>Editing</summary>
|
|
92
|
+
<summary>Template Editing</summary>
|
|
75
93
|
<a href="https://athenadesign.com.au/caw/templates-editing.png">
|
|
76
94
|
<img src="https://athenadesign.com.au/caw/templates-editing.png" alt="Editing" width="900"/>
|
|
77
95
|
</a>
|
|
78
96
|
</details>
|
|
79
97
|
|
|
80
98
|
<details>
|
|
81
|
-
<summary>
|
|
99
|
+
<summary>Render Template</summary>
|
|
82
100
|
<a href="https://athenadesign.com.au/caw/templates-rendering.png">
|
|
83
101
|
<img src="https://athenadesign.com.au/caw/templates-rendering.png" alt="Form rendering" width="900"/>
|
|
84
102
|
</a>
|
|
85
103
|
</details>
|
|
86
104
|
|
|
87
|
-
##
|
|
105
|
+
## Jobs
|
|
88
106
|
|
|
89
107
|
Orchestrate your locally installed agents.
|
|
90
108
|
|
|
91
|
-
-
|
|
109
|
+
- Unified browser-based reskinning of Claude Code, Codex and Cursor CLI
|
|
92
110
|
- In chat UI wireframing using inline SVG
|
|
93
111
|
- In chat mermaid diagramming
|
|
94
|
-
- Multi-level cross
|
|
112
|
+
- Multi-level cross-vendor subagents
|
|
95
113
|
- Capture all prompts and outputs making them easily findable
|
|
96
114
|
- Act as the orchestration hub for agents to communicate with one another
|
|
97
115
|
- Seamlessly jump between REPLs and web application
|
|
98
|
-
- Use the right model for the job
|
|
99
|
-
- Unlock powerful
|
|
100
|
-
-
|
|
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>
|
|
101
149
|
|
|
102
150
|
## Stories
|
|
103
151
|
|
|
@@ -105,14 +153,28 @@ Use a thin slice mentality to build software incrementally.
|
|
|
105
153
|
|
|
106
154
|
- Leverage document templates for each stage of the story lifecycle
|
|
107
155
|
- Leverage prompt templates to orchestrate agents at each stage of the story lifecycle
|
|
108
|
-
-
|
|
156
|
+
- Reduce agent assumptions using acceptance criteria
|
|
109
157
|
- Define the various tracks your stories take
|
|
110
158
|
- Manage your own cognitive load as the amount of parallel work increases
|
|
111
159
|
|
|
112
160
|
<details>
|
|
113
|
-
<summary>Story
|
|
114
|
-
<a href="https://athenadesign.com.au/caw/
|
|
115
|
-
<img src="https://athenadesign.com.au/caw/
|
|
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"/>
|
|
116
178
|
</a>
|
|
117
179
|
</details>
|
|
118
180
|
|
|
@@ -120,20 +182,13 @@ Use a thin slice mentality to build software incrementally.
|
|
|
120
182
|
|
|
121
183
|
Find what you and your agents need as the knowledge base grows.
|
|
122
184
|
|
|
123
|
-
- Metadata
|
|
124
|
-
- Full
|
|
185
|
+
- Metadata-based search with expressions
|
|
186
|
+
- Full-text search
|
|
125
187
|
- RAG (i.e. semantic) search
|
|
126
188
|
- Ancestor walks
|
|
127
189
|
- Expressive query language
|
|
128
190
|
- Supports all entities
|
|
129
191
|
|
|
130
|
-
<details>
|
|
131
|
-
<summary>Search box</summary>
|
|
132
|
-
<a href="https://athenadesign.com.au/caw/search-box.png">
|
|
133
|
-
<img src="https://athenadesign.com.au/caw/search-box.png" alt="Search box" width="900"/>
|
|
134
|
-
</a>
|
|
135
|
-
</details>
|
|
136
|
-
|
|
137
192
|
<details>
|
|
138
193
|
<summary>Query builder</summary>
|
|
139
194
|
<a href="https://athenadesign.com.au/caw/search-query-builder.png">
|
|
@@ -157,16 +212,9 @@ Find what you and your agents need as the knowledge base grows.
|
|
|
157
212
|
|
|
158
213
|
## The Voltron Effect
|
|
159
214
|
|
|
160
|
-
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
|
|
161
|
-
|
|
162
|
-
# 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.
|
|
163
216
|
|
|
164
|
-
|
|
165
|
-
npm install -g @kelceyp/caw
|
|
166
|
-
caw start
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
Then open [http://localhost:2229](http://localhost:2229) in your browser.
|
|
217
|
+

|
|
170
218
|
|
|
171
219
|
## Commands
|
|
172
220
|
|
|
@@ -184,11 +232,11 @@ caw upgrade # Upgrade to the latest version
|
|
|
184
232
|
|
|
185
233
|
## Optional Integrations
|
|
186
234
|
|
|
187
|
-
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.
|
|
188
236
|
|
|
189
237
|
### Caddy
|
|
190
238
|
|
|
191
|
-
- Enable HTTPS and HTTP2
|
|
239
|
+
- Enable HTTPS and HTTP2
|
|
192
240
|
- Remove browser limitations on number of concurrent connections
|
|
193
241
|
- Cleaner `caw.localhost` rather than `localhost:2229`
|
|
194
242
|
|
|
@@ -210,8 +258,8 @@ All optional integrations are configured via Preferences > Infrastructure in the
|
|
|
210
258
|
|
|
211
259
|
## Links
|
|
212
260
|
|
|
213
|
-
- [Report an
|
|
261
|
+
- [Report an issue or request a feature](https://github.com/kelceyp-mcp-servers/caw-feedback/issues)
|
|
214
262
|
|
|
215
263
|
## License
|
|
216
264
|
|
|
217
|
-
Proprietary. All rights reserved.
|
|
265
|
+
Proprietary. All rights reserved.
|