codework 0.1.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.md +8 -0
- package/LICENSE +21 -0
- package/README.md +55 -0
- package/dist/cli.js +1506 -0
- package/package.json +34 -0
package/AGENTS.md
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Agent Instructions
|
|
2
|
+
|
|
3
|
+
Codework coordinates AI coding agents through append-only workspace events and stdout-as-context.
|
|
4
|
+
|
|
5
|
+
MUST: Keep stdout operational and explicit.
|
|
6
|
+
MUST: Preserve the `CODEWORK CONTEXT GUIDE` contract for LLM-facing commands.
|
|
7
|
+
MUST NOT: Add behavior that launches, drives, or controls external AI agent CLIs.
|
|
8
|
+
MUST NOT: add destructive repository automation to Codework without a separate guardrail design.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 SHUHEI IHARA
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Codework
|
|
2
|
+
|
|
3
|
+
Codework is a TypeScript CLI harness for coordinating multiple AI coding agents through stdout-as-context.
|
|
4
|
+
|
|
5
|
+
It does not run Codex, Claude Code, or Cursor CLI. Instead, each agent calls `codework` from its own shell-capable environment, and Codework returns a strict operational guide plus shared workspace state.
|
|
6
|
+
|
|
7
|
+
## Quick start
|
|
8
|
+
|
|
9
|
+
In Codex:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
! codework new workspace=my-workspace --name=codex --follow=user
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
In Claude Code:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
! codework join --workspace=my-workspace --name=claude --follow=codex
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Then agents should repeatedly use:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
! codework poll --workspace=my-workspace --name=<agent>
|
|
25
|
+
! codework say --workspace=my-workspace --name=<agent> --to=<agent|all> --kind=note --message="..."
|
|
26
|
+
! codework done --workspace=my-workspace --name=<agent> --summary="..."
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Runtime support
|
|
30
|
+
|
|
31
|
+
Node.js:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm run build
|
|
35
|
+
node dist/cli.js doctor
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Deno:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
deno run --allow-read --allow-write --allow-env --allow-run=git src/cli.ts doctor
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Bun:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
bun run src/cli.ts doctor
|
|
48
|
+
bun run src/cli.ts new workspace=my-workspace --name=bun --follow=user
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Notes for Japanese users
|
|
52
|
+
|
|
53
|
+
Codework の stdout は、そのまま LLM の次コンテキストに入る主成果物です。そのため既定の text 出力は短い成功メッセージではなく、エージェントが守るべき英語の運用命令を返します。
|
|
54
|
+
|
|
55
|
+
`workspace=my-workspace` と `--workspace=my-workspace` の両方を受け付けます。これは Codex / Claude Code などの shell escape 利用時の表記ゆれを吸収するための仕様です。
|