@kelceyp/caw 1.0.14 → 1.0.17

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 +199 -0
  2. package/dist/caw.js +2 -2
  3. package/package.json +4 -2
package/README.md ADDED
@@ -0,0 +1,199 @@
1
+ # CAW
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.
4
+
5
+ ![CAW overview](https://athenadesign.com.au/caw/documents-editor.png)
6
+
7
+ ## Content Management
8
+
9
+ Build your agent knowledge base in lock step with your code base.
10
+
11
+ - Extended MD capabilities including inline mermaid, inline SVG, linking and includes
12
+ - Monaco editor and extended marked rendering capabilities for users
13
+ - Real time SSE updates
14
+ - Typed metadata including multivalued fields
15
+ - Locking, clobber protection and version control
16
+ - Image deduping and easy pasting/viewing
17
+ - Rich MCP tooling for agents to read and edit documents
18
+ - Cartridge, Scratch and Task document subtypes with additional capabilities
19
+
20
+ <details>
21
+ <summary>Document viewer</summary>
22
+ <a href="https://athenadesign.com.au/caw/documents-viewer.png">
23
+ <img src="https://athenadesign.com.au/caw/documents-viewer.png" alt="Document viewer" width="900"/>
24
+ </a>
25
+ </details>
26
+
27
+ <details>
28
+ <summary>Editor</summary>
29
+ <a href="https://athenadesign.com.au/caw/documents-editor.png">
30
+ <img src="https://athenadesign.com.au/caw/documents-editor.png" alt="Editor" width="900"/>
31
+ </a>
32
+ </details>
33
+
34
+ ## Templates
35
+
36
+ Create powerful templates for documents, prompts and saved searches.
37
+
38
+ - Handlebars templating with handlebars-helpers enabling
39
+ - Substitution
40
+ - Conditionals
41
+ - Enumeration
42
+ - String manipulation
43
+ - Arithmetic
44
+ - Collection utilities
45
+ - Number formatting
46
+ - Word inflection
47
+ - Expressions
48
+ - Type and multivalued enabled
49
+ - Subtypes include document, prompt and saved search, all providing different behaviours
50
+ - Document templates create documents
51
+ - Prompt templates orchestrate locally installed agents (see Agent Orchestration below)
52
+ - Saved searches render the query language into a search to return results
53
+ - Rich MCP tooling so that agents can assist you with context engineering
54
+
55
+ <details>
56
+ <summary>Editing</summary>
57
+ <a href="https://athenadesign.com.au/caw/templates-editing.png">
58
+ <img src="https://athenadesign.com.au/caw/templates-editing.png" alt="Editing" width="900"/>
59
+ </a>
60
+ </details>
61
+
62
+ <details>
63
+ <summary>Form rendering</summary>
64
+ <a href="https://athenadesign.com.au/caw/templates-rendering.png">
65
+ <img src="https://athenadesign.com.au/caw/templates-rendering.png" alt="Form rendering" width="900"/>
66
+ </a>
67
+ </details>
68
+
69
+ ## Agent Orchestration
70
+
71
+ Orchestrate your locally installed agents.
72
+
73
+ - Browser based reskinning of Claude Code, Codex and Cursor CLI
74
+ - In chat UI wireframing using inline SVG
75
+ - In chat mermaid diagramming
76
+ - Multi-level cross vendor subagents (have Claude supervise Codex supervising Cursor)
77
+ - Capture all prompts and outputs making them easily findable
78
+ - Act as the orchestration hub for agents to communicate with one another
79
+ - 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
83
+
84
+ ## Stories
85
+
86
+ Use a thin slice mentality to build software incrementally.
87
+
88
+ - Leverage document templates for each stage of the story lifecycle
89
+ - Leverage prompt templates to orchestrate agents at each stage of the story lifecycle
90
+ - Eliminate agent assumptions using acceptance criteria
91
+ - Define the various tracks your stories take
92
+ - Manage your own cognitive load as the amount of parallel work increases
93
+
94
+ <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"/>
98
+ </a>
99
+ </details>
100
+
101
+ ## Search
102
+
103
+ Find what you and your agents need as the knowledge base grows.
104
+
105
+ - Metadata based search with expressions
106
+ - Full text search
107
+ - RAG (i.e. semantic) search
108
+ - Ancestor walks
109
+ - Expressive query language
110
+ - Supports all entities
111
+
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
+ <details>
120
+ <summary>Query builder</summary>
121
+ <a href="https://athenadesign.com.au/caw/search-query-builder.png">
122
+ <img src="https://athenadesign.com.au/caw/search-query-builder.png" alt="Query builder" width="900"/>
123
+ </a>
124
+ </details>
125
+
126
+ <details>
127
+ <summary>Full-text search (FTS) results</summary>
128
+ <a href="https://athenadesign.com.au/caw/search-fts-results.png">
129
+ <img src="https://athenadesign.com.au/caw/search-fts-results.png" alt="Full-text search (FTS) results" width="900"/>
130
+ </a>
131
+ </details>
132
+
133
+ <details>
134
+ <summary>Semantic (RAG) search results</summary>
135
+ <a href="https://athenadesign.com.au/caw/search-rag-results.png">
136
+ <img src="https://athenadesign.com.au/caw/search-rag-results.png" alt="Semantic (RAG) search results" width="900"/>
137
+ </a>
138
+ </details>
139
+
140
+ ## The Voltron Effect
141
+
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
145
+
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.
152
+
153
+ ## Commands
154
+
155
+ ```bash
156
+ caw start # Start the server
157
+ caw stop # Stop the server
158
+ caw status # Check if the server is running
159
+ caw logs # Tail the server logs
160
+ caw upgrade # Upgrade to the latest version
161
+ ```
162
+
163
+ ## Prerequisites
164
+
165
+ - **Node.js** v24+
166
+
167
+ ## Optional Integrations
168
+
169
+ All optional integrations are configured via Preferences > Infrastructure in the web UI.
170
+
171
+ ### Caddy
172
+
173
+ - Enable HTTPS and HTTP2/SPDY
174
+ - Remove browser limitations on number of concurrent connections
175
+ - Cleaner `caw.localhost` rather than `localhost:2229`
176
+
177
+ ### PM2
178
+
179
+ - Enable automatic launch on machine start
180
+
181
+ ### Docker
182
+
183
+ - Enable agent orchestration within Docker containers
184
+
185
+ ### Git
186
+
187
+ - Enable agent orchestration within worktree branches
188
+
189
+ ### GitHub CLI
190
+
191
+ - Enable PR and other GitHub capabilities
192
+
193
+ ## Links
194
+
195
+ - [Report an Issue or request a Feature](https://github.com/kelceyp/caw-feedback/issues)
196
+
197
+ ## License
198
+
199
+ Proprietary. All rights reserved.
package/dist/caw.js CHANGED
@@ -10817,7 +10817,7 @@ function createPm2Manager(envDir, checkPm2 = isPm2Installed) {
10817
10817
  } catch {}
10818
10818
  const logPath = logFilePath(envDir);
10819
10819
  const envArgs = Object.entries(envVars).map(([k, v]) => `${k}=${v}`).join(" ");
10820
- const nodeArgsStr = nodeArgs.length > 0 ? ` --node-args="${nodeArgs.map((a) => `\\"${a}\\"`).join(" ")}"` : "";
10820
+ const nodeArgsStr = nodeArgs.length > 0 ? ` --node-args="${nodeArgs.join(" ")}"` : "";
10821
10821
  execSync3(`${envArgs} pm2 start ${mainJsPath} --name ${name}${nodeArgsStr} --output ${logPath} --error ${logPath} --merge-logs`, { stdio: "inherit", env: { ...process.env, ...envVars } });
10822
10822
  return name;
10823
10823
  },
@@ -11643,7 +11643,7 @@ if (!globalCheck.ok) {
11643
11643
  console.error(globalCheck.message);
11644
11644
  process.exit(1);
11645
11645
  }
11646
- var LAUNCHER_VERSION = "1.0.14";
11646
+ var LAUNCHER_VERSION = "1.0.15";
11647
11647
  var serverInfo = resolve();
11648
11648
  var serverVersion = serverInfo ? serverInfo.version : "not installed";
11649
11649
  var versionString = `Launcher: ${LAUNCHER_VERSION}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kelceyp/caw",
3
- "version": "1.0.14",
3
+ "version": "1.0.17",
4
4
  "description": "CAW launcher — server lifecycle management CLI",
5
5
  "type": "module",
6
6
  "bin": {
@@ -13,11 +13,13 @@
13
13
  },
14
14
  "files": [
15
15
  "dist/",
16
- "scripts/postinstall.js"
16
+ "scripts/postinstall.js",
17
+ "README.md"
17
18
  ],
18
19
  "dependencies": {
19
20
  "@kelceyp/clibuilder": "^0.2.2"
20
21
  },
22
+ "license": "UNLICENSED",
21
23
  "devDependencies": {
22
24
  "semver": "^7"
23
25
  }