@kitsy/coop 0.0.1 → 1.0.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/README.md CHANGED
@@ -2,6 +2,103 @@
2
2
 
3
3
  CLI package for COOP.
4
4
 
5
- Commands:
5
+ Current implemented command families:
6
6
  - `coop`
7
+ - `coop init`
8
+ - `coop create task ...`
9
+ - `coop create task --from <idea> --ai`
10
+ - `coop create idea ...`
11
+ - `coop create track ...`
12
+ - `coop create delivery ... [--commit] [--user <user>] [--force]`
13
+ - `coop assign task <id> --to <assignee> [--actor <actor>]`
14
+ - `coop list tasks|ideas|alias ...`
15
+ - `coop show task|idea ...`
16
+ - `coop transition task ... [--user <user>] [--force]`
17
+ - `coop graph validate|next|show|critical-path ...`
18
+ - `coop index status|rebuild`
19
+ - `coop plan delivery <name>`
20
+ - `coop plan delivery <name> --monte-carlo [--iterations <n>]`
21
+ - `coop plan capacity <track>`
22
+ - `coop status [--today <date>]`
23
+ - `coop view kanban`
24
+ - `coop view timeline --delivery <name>`
25
+ - `coop view velocity [--today <date>]`
26
+ - `coop view burndown --delivery <name> [--today <date>]`
27
+ - `coop view capacity [--today <date>]`
28
+ - `coop ui [--host <host>] [--port <port>] [--no-open]`
29
+ - `coop serve [--host <host>] [--port <port>] [--repo <path>]`
30
+ - `coop webhook github [--host <host>] [--port <port>] [--repo <path>]`
31
+ - `coop migrate --dry-run --to 2`
32
+ - `coop alias ...`
33
+ - `coop list alias [pattern]`
34
+ - `coop config index.data yaml|json`
35
+ - `coop config id.naming "<TYPE>-<USER>-<YYMMDD>-<RAND>"`
36
+ - `coop config project.name <name>`
37
+ - `coop config project.id <id>`
38
+ - `coop config project.aliases <csv>`
39
+ - `coop config ai.provider mock|openai|anthropic|gemini|ollama`
40
+ - `coop config ai.model <model-name>`
41
+ - `coop run task <id> [--step <step>] [--dry-run]`
42
+
43
+ Known limitations:
44
+ - `ext` is still a placeholder for future phases.
45
+ - Provider-backed AI is supported for `openai`, `anthropic`, `gemini`, and `ollama` via `.coop/config.yml` + env vars.
46
+ - Authorization is advisory and config-driven (`.coop/config.yml -> authorization`).
47
+ - Plugin runtime supports manifest triggers under `.coop/plugins/*.yml` (webhook + console + `github_pr` actions).
48
+ - `coop ui` is read-only and depends on local `.coop/.index` data. The command rebuilds stale indexes before launch.
49
+
50
+ GitHub integration quick example:
51
+ ```yaml
52
+ github:
53
+ owner: kitsy
54
+ repo: coop
55
+ base_branch: main
56
+ token_env: GITHUB_TOKEN
57
+ webhook_secret_env: GITHUB_WEBHOOK_SECRET
58
+ merge_method: squash
59
+ ```
60
+
61
+ With `.coop/plugins/github-pr.yml` enabled:
62
+ - `coop transition task PM-101 in_review` creates or updates a PR
63
+ - `coop transition task PM-101 done` merges the linked PR
64
+ - `coop webhook github --port 8787` receives GitHub review/merge webhooks and syncs task status
65
+
66
+ API server and cross-repo dependency quick example:
67
+ ```yaml
68
+ api:
69
+ host: 127.0.0.1
70
+ port: 3847
71
+ remotes:
72
+ platform-repo:
73
+ base_url: http://127.0.0.1:3848
74
+ ```
75
+
76
+ With cross-repo task references such as `external:platform-repo/PM-200`:
77
+ - `coop serve --port 3847` exposes the local read-only API
78
+ - remote dependencies resolve through the configured API base URL when reachable
79
+ - unreachable remotes are reported as external dependency risks
80
+
81
+ Workspace identity:
82
+ ```yaml
83
+ project:
84
+ name: Payments Platform
85
+ id: payments-platform
86
+ aliases:
87
+ - pay
88
+ - ledger.master
89
+ ```
90
+
91
+ This identity is exposed through:
92
+ - `GET /api/meta`
93
+ - MCP `coop_workspace_info`
94
+ - MCP `coop://workspace`
95
+
96
+ Provider config quick example:
97
+ ```yaml
98
+ ai:
99
+ provider: openai
100
+ model: gpt-5-mini
101
+ openai:
102
+ api_key_env: OPENAI_API_KEY
103
+ ```
7
104
 
package/dist/index.d.ts CHANGED
@@ -1 +1,15 @@
1
1
  #!/usr/bin/env node
2
+ import { Command } from 'commander';
3
+
4
+ /**
5
+ * Builds the root Commander program and registers implemented command groups.
6
+ * [SPEC: Architecture v2.0 §23]
7
+ */
8
+ declare function createProgram(): Command;
9
+ /**
10
+ * Executes CLI parsing and centralized error rendering/logging.
11
+ * [SPEC: Architecture v2.0 §23]
12
+ */
13
+ declare function runCli(argv?: string[]): Promise<void>;
14
+
15
+ export { createProgram, runCli };