crewcoder 0.6.1
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/LICENSE +191 -0
- package/README.md +249 -0
- package/bin/crewcoder.js +9 -0
- package/lib/launcher.js +49 -0
- package/package.json +67 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
Copyright 2026 OnPoint Dev Tools and CrewCoder contributors
|
|
180
|
+
|
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
+
you may not use this file except in compliance with the License.
|
|
183
|
+
You may obtain a copy of the License at
|
|
184
|
+
|
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
+
|
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
+
See the License for the specific language governing permissions and
|
|
191
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<img src="assets/crewcoder-logo.png" alt="CrewCoder" width="420" />
|
|
4
|
+
|
|
5
|
+
**Extensible, security-conscious coding-agent platform**
|
|
6
|
+
|
|
7
|
+
[](https://github.com/OnPoint-Dev-Tools/crewcoder/actions/workflows/sdk-check.yml)
|
|
8
|
+
[](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-agent)
|
|
9
|
+
[](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-tui)
|
|
10
|
+
[](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-sdk)
|
|
11
|
+
[](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-client)
|
|
12
|
+
[](LICENSE)
|
|
13
|
+
[](https://nodejs.org)
|
|
14
|
+
|
|
15
|
+
</div>
|
|
16
|
+
|
|
17
|
+
# CrewCoder Monorepo
|
|
18
|
+
|
|
19
|
+
This directory is an npm-workspaces monorepo for the CrewCoder Packages. The root package owns shared tooling, workspace scripts, and a single lockfile, while each package keeps its runtime dependencies and build entrypoints. For more thorough Documentation go here [CrewCoder Docs](https://crewcode-docs.logixhub.icu/crewcoder-agent/overview/)
|
|
20
|
+
|
|
21
|
+
## CrewCoder
|
|
22
|
+
|
|
23
|
+
**CrewCoder is an extensible, security-conscious coding-agent platform designed for interactive development, multi-worker orchestration, durable sessions, detached goals, and remote execution. Can also be used for the CrewCode ecosystem.**
|
|
24
|
+
|
|
25
|
+
## Install CrewCoder
|
|
26
|
+
|
|
27
|
+
Requires Node.js 22 or newer. The `crewcoder` umbrella package includes both the CrewCoder agent and terminal UI.
|
|
28
|
+
|
|
29
|
+
### Try it with npx
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
npx crewcoder
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`npx` downloads CrewCoder into npm's cache and launches the TUI without creating a persistent global installation.
|
|
36
|
+
|
|
37
|
+
### Install globally
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
npm install --global crewcoder
|
|
41
|
+
crewcoder
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The global installation of Agent + TUI provides both command names:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
crewcoder
|
|
48
|
+
cc
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
A command with no arguments opens the TUI. Arguments run the agent CLI:
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
crewcoder providers
|
|
55
|
+
crewcoder run "explain this repository"
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
The scoped packages remain available separately for development and custom packaging:
|
|
59
|
+
|
|
60
|
+
```sh
|
|
61
|
+
npm install --global @onpoint-dev-tools/crewcoder-agent
|
|
62
|
+
npm install --global @onpoint-dev-tools/crewcoder-tui
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Installing only `@onpoint-dev-tools/crewcoder-agent` does not install the TUI. Most CLI users should install the `crewcoder` umbrella package. See the [installation guide](docs/INSTALLATION.md) for more details.
|
|
66
|
+
|
|
67
|
+
## Packages
|
|
68
|
+
|
|
69
|
+
| Package | npm name | Runs on | What it is | Install command |
|
|
70
|
+
|---|---|---|---|---|
|
|
71
|
+
| CrewCoder umbrella | `crewcoder` | Node.js 22+ terminal | Recommended CLI package containing both the agent and TUI. |
|
|
72
|
+
| [`crewcoder-agent`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-agent) | [`@onpoint-dev-tools/crewcoder-agent`](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-agent) | Node.js 22+ / standalone binary | The agent harness: evented agent loop, providers, local tools, durable sessions, goals, crews, extensions, ACP and fleet servers, and the `crewcoder` / `cc` CLI. | `npm install --global @onpoint-dev-tools/crewcoder-agent` |
|
|
73
|
+
| [`crewcoder-tui`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-tui) | [`@onpoint-dev-tools/crewcoder-tui`](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-tui) | Node.js 22+ terminal | Custom terminal UI (no Ink/React/blessed/curses) driven by the agent's JSON event stream, locally or over SSH. | `npm install --global @onpoint-dev-tools/crewcoder-tui` |
|
|
74
|
+
| [`crewcoder-sdk`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-sdk) | [`@onpoint-dev-tools/crewcoder-sdk`](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-sdk) | Node.js 22+ host process | Supported TypeScript API for embedding CrewCoder in-process, plus an authenticated fleet client for remote runners. | `npm install --global @onpoint-dev-tools/crewcoder-sdk` |
|
|
75
|
+
| [`crewcoder-client`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-client) | [`@onpoint-dev-tools/crewcoder-client`](https://www.npmjs.com/package/@onpoint-dev-tools/crewcoder-client) | Browsers, Electron renderers, webviews | Browser-safe client for authenticated CrewCoder runners. Web-platform APIs only: no Node.js imports, no local files, no tool execution, no stored provider credentials. | `npm install --global @onpoint-dev-tools/crewcoder-client` |
|
|
76
|
+
|
|
77
|
+
Package READMEs:
|
|
78
|
+
[agent](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/README.md) ·
|
|
79
|
+
[tui](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-tui/README.md) ·
|
|
80
|
+
[sdk](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-sdk/README.md) ·
|
|
81
|
+
[client](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-client/README.md)
|
|
82
|
+
|
|
83
|
+
## The CrewCoder agent harness
|
|
84
|
+
|
|
85
|
+
`crewcoder-agent` is the harness every other package talks to. The TUI spawns it and reads its JSON events, the SDK embeds it in-process, and the client talks to it over the authenticated fleet HTTP/SSE API. Everything below lives in that package.
|
|
86
|
+
|
|
87
|
+
### Runtime core
|
|
88
|
+
|
|
89
|
+
- **Evented agent loop.** Every turn emits typed JSON events (assistant deltas, thinking deltas, tool calls, approvals, usage, errors) over stdout or SSE, so all frontends share one contract. See [TUI_BACKEND_CONTRACT.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/contributor/TUI_BACKEND_CONTRACT.md).
|
|
90
|
+
- **Durable sessions.** Sessions persist under the CrewCoder home and support resume, branch, prune, export, checkpoints and rewind, search, compaction, and `session why` provenance. See [SESSION_DURABILITY.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/SESSION_DURABILITY.md), [SESSION_CHECKPOINTS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/SESSION_CHECKPOINTS.md), [AUTO_COMPACTION.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/AUTO_COMPACTION.md).
|
|
91
|
+
- **State directory.** `/.crewcoder` (override with `CREWCODER_HOME`, falls back to `~/.crewcoder`) holds `config.json`, `fleet-token`, `sessions/`, `goals/`, `extensions/`, `workers/`, `cache/`, `logs/`.
|
|
92
|
+
- **Modes.** `general` (default coding), `plugin` (CrewCode app plugin architect), `extension` (CrewCoder extension architect). See [EXTENSION_MODE.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/EXTENSION_MODE.md).
|
|
93
|
+
|
|
94
|
+
### Providers
|
|
95
|
+
|
|
96
|
+
Built-in adapters cover Claude Code Agent SDK, Codex (official app-server threads with a guarded WebSocket/SSE fallback), OpenCode, Grok CLI over ACP stdio, OpenAI, Anthropic, OpenRouter, xAI, DeepSeek, and Mistral, using checked process, HTTP/SSE, WebSocket, continuation, fallback, and replay transport profiles. Thinking/reasoning streams are first-class and user-visible. Context windows resolve from provider metadata first, then a strict-match 24-hour OpenRouter catalog cache.
|
|
97
|
+
See [PROVIDERS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/PROVIDERS.md), [CODEX_TRANSPORT.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/CODEX_TRANSPORT.md), [CLAUDE_AGENT_SDK.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/CLAUDE_AGENT_SDK.md), [MODEL_CONTEXT_WINDOWS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/MODEL_CONTEXT_WINDOWS.md), [PARALLEL_TOOL_CALLS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/PARALLEL_TOOL_CALLS.md).
|
|
98
|
+
|
|
99
|
+
### Tools
|
|
100
|
+
|
|
101
|
+
Local tools include read/write/edit, transactional edits, grep, list-files, bash and background jobs, git primitives, LSP-backed code intelligence and symbol edits, docs lookup, memory (`remember`), worker delegation, and plugin/extension scaffolding and validation. Only tools marked parallel-safe run concurrently; sequential tools stay ordering barriers, and tool output is size-limited and redacted.
|
|
102
|
+
See [CODE_INTELLIGENCE_TOOLS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/CODE_INTELLIGENCE_TOOLS.md), [GIT_PRIMITIVE_TOOLS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/GIT_PRIMITIVE_TOOLS.md), [TRANSACTIONAL_EDITS_AND_BACKGROUND_JOBS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/TRANSACTIONAL_EDITS_AND_BACKGROUND_JOBS.md), [TOOL_OUTPUT_SAFETY.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/TOOL_OUTPUT_SAFETY.md).
|
|
103
|
+
|
|
104
|
+
### Orchestration
|
|
105
|
+
|
|
106
|
+
- **Worker crews and teams** — named workers with their own identity files, sequential crew runs, declarative teams in `crewcoder.json`, and session handoffs. See [WORKER_CREWS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/WORKER_CREWS.md).
|
|
107
|
+
- **Crew tasks** — durable project-wide task IDs with dependency edges, surfaced in the TUI sidebar. See [CREW_TASKS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/CREW_TASKS.md).
|
|
108
|
+
- **Detached durable goals** — a CrewCoder-owned supervisor with maker/verifier separation, not a provider feature. See [DURABLE_GOALS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/DURABLE_GOALS.md).
|
|
109
|
+
|
|
110
|
+
### Security and trust
|
|
111
|
+
|
|
112
|
+
Approval modes (`never`, `review`, `always`, `full-access`, `sandboxed`), sandbox and trust tiers, runtime guardrails, explicit external-directory grants, repository rules, audit logging and redaction, and a mandatory bearer token for the fleet API.
|
|
113
|
+
See [SANDBOX_AND_TRUST.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/SANDBOX_AND_TRUST.md), [RUNTIME_GUARDRAILS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/RUNTIME_GUARDRAILS.md), [INTERACTIVE_APPROVAL_CONTROL.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/INTERACTIVE_APPROVAL_CONTROL.md), [AUDIT_AND_REDACTION.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/AUDIT_AND_REDACTION.md), [EXTERNAL_DIRECTORIES.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/EXTERNAL_DIRECTORIES.md).
|
|
114
|
+
|
|
115
|
+
### Extensibility
|
|
116
|
+
|
|
117
|
+
Capability-based CrewCoder extensions declare contribution points in `crewcoder.extension.json` — providers, tools, skills, prompt packs, commands, workflows, context providers, validators, approval policies, hooks, and sandboxed Live UI — all gated by config, trust tier, and capability checks. Separately, CrewCoder can generate CrewCode app plugins (`crewcode.plugin.json`).
|
|
118
|
+
See [EXTENSIONS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/EXTENSIONS.md), [EXTENSION_HOOKS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/EXTENSION_HOOKS.md), [EXTENSION_REGISTRY.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/EXTENSION_REGISTRY.md), [LIVE_UI_COMPONENTS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/LIVE_UI_COMPONENTS.md), [WORKFLOWS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/WORKFLOWS.md).
|
|
119
|
+
|
|
120
|
+
**STILL WORKING ON EXTENSION REGISTRY**
|
|
121
|
+
|
|
122
|
+
### Ways to connect
|
|
123
|
+
|
|
124
|
+
| Method | Best for | Transport | Authentication |
|
|
125
|
+
|---|---|---|---|
|
|
126
|
+
| Local CLI/TUI | Working on the current machine | Local subprocess | Local OS account |
|
|
127
|
+
| Remote agents | Local TUI, remote workspace | SSH stdio | SSH keys |
|
|
128
|
+
| ACP | Third-party ACP-compatible editors | ACP over stdio, often through SSH | Process boundary or SSH |
|
|
129
|
+
| Fleet mode | SDKs, apps, dashboards, automation, concurrent runs | HTTP + SSE/WebSocket | Fleet bearer token plus tunnel/HTTPS |
|
|
130
|
+
| In-process SDK | Embedding in a trusted Node.js host | Direct TypeScript calls | Host process boundary |
|
|
131
|
+
|
|
132
|
+
See [FLEET_MODE.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/FLEET_MODE.md), [ACP_ADAPTER.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/ACP_ADAPTER.md), [SDK.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/SDK.md), and [REMOTE_AGENTS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-tui/docs/REMOTE_AGENTS.md).
|
|
133
|
+
|
|
134
|
+
## Common commands
|
|
135
|
+
|
|
136
|
+
```sh
|
|
137
|
+
npm install
|
|
138
|
+
npm run build
|
|
139
|
+
npm run typecheck
|
|
140
|
+
npm run test
|
|
141
|
+
npm run check
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Run one workspace directly:
|
|
145
|
+
|
|
146
|
+
```sh
|
|
147
|
+
npm run dev -w @onpoint-dev-tools/crewcoder-agent
|
|
148
|
+
npm run typecheck -w @onpoint-dev-tools/crewcoder-sdk
|
|
149
|
+
npm run dev -w @onpoint-dev-tools/crewcoder-tui
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## TypeScript SDK and browser client
|
|
153
|
+
|
|
154
|
+
`@onpoint-dev-tools/crewcoder-sdk` `0.6.0` is the supported Node.js 22+ API for custom interfaces, automated workflows, custom tools, programmatic agent tests, and authenticated remote fleet clients. It supports typed events/errors, durable or in-memory sessions, approvals, follow-ups, cancellation, persistent fleet history, event cursors, reconnect, HTTP/SSE controls, and safe WebSocket connection metadata.
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
import { createCrewCoderSession } from "@onpoint-dev-tools/crewcoder-sdk";
|
|
158
|
+
|
|
159
|
+
const session = createCrewCoderSession({ cwd: process.cwd(), provider: "codex", approval: "review" });
|
|
160
|
+
session.subscribe((event) => {
|
|
161
|
+
if (event.type === "assistant_delta") process.stdout.write(event.text);
|
|
162
|
+
});
|
|
163
|
+
await session.prompt("Explain the failing tests.");
|
|
164
|
+
session.dispose();
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
Browsers, Electron renderers, and webviews should use `@onpoint-dev-tools/crewcoder-client` instead, which talks to an authenticated runner over HTTP/SSE with web-platform APIs only:
|
|
168
|
+
|
|
169
|
+
```ts
|
|
170
|
+
import { CrewCoderClient } from "@onpoint-dev-tools/crewcoder-client";
|
|
171
|
+
|
|
172
|
+
const client = new CrewCoderClient({ baseUrl: "https://runner.example.com", token });
|
|
173
|
+
const run = await client.createRun({ prompt: "Fix the failing tests", cwd: "/workspace/project" });
|
|
174
|
+
await client.streamEvents(run.runId, (event) => { /* render */ });
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
See [SDK.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/SDK.md) for SDK examples, [FLEET_MODE.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/FLEET_MODE.md) for the VPS workflow, and [SDK_RELEASE.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/contributor/SDK_RELEASE.md) for compatibility and release gates.
|
|
178
|
+
|
|
179
|
+
## Detached durable goals
|
|
180
|
+
|
|
181
|
+
```sh
|
|
182
|
+
crewcoder goal start "Complete the migration and stop when contract tests pass" --provider codex
|
|
183
|
+
crewcoder goal status
|
|
184
|
+
crewcoder goal approve
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
The TUI exposes the same workflow through `/goal`. Goals survive closing the TUI and pause safely for approvals or recoverable blockers. See [DURABLE_GOALS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/DURABLE_GOALS.md).
|
|
188
|
+
|
|
189
|
+
## Standalone VPS runner
|
|
190
|
+
|
|
191
|
+
Build a Linux x64 executable that does not require Node.js on the VPS:
|
|
192
|
+
|
|
193
|
+
```sh
|
|
194
|
+
npm run build:standalone -w @onpoint-dev-tools/crewcoder-agent
|
|
195
|
+
crewcoder deploy user@vps --binary crewcoder-agent/dist-bin/crewcoder-linux-x64 --execute
|
|
196
|
+
ssh -N -L 8787:127.0.0.1:8787 user@vps
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
Standalone deployment is loopback-only and intended for SSH terminal, ACP-over-SSH, local-TUI-over-SSH, or tunneled fleet access. Fleet API authentication is mandatory and uses an automatically generated private bearer token.
|
|
200
|
+
|
|
201
|
+
Run the TUI on your PC while the agent and workspace stay on the VPS:
|
|
202
|
+
|
|
203
|
+
```sh
|
|
204
|
+
crewcoder-tui \
|
|
205
|
+
--remote user@vps \
|
|
206
|
+
--remote-cwd /srv/projects/my-project
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
See [REMOTE_AGENTS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-tui/docs/REMOTE_AGENTS.md) for the remote TUI workflow. The fleet guide includes deployment, token-safe curl, SDK, WebSocket, Python, rotation, and troubleshooting examples at [FLEET_MODE.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/FLEET_MODE.md).
|
|
210
|
+
|
|
211
|
+
## CI integrations
|
|
212
|
+
|
|
213
|
+
The repository root is a GitHub composite action for `crewcoder run --ci`.
|
|
214
|
+
GitLab users can include `.gitlab/crewcoder.gitlab-ci.yml`, and local repositories
|
|
215
|
+
can install a managed review hook with:
|
|
216
|
+
|
|
217
|
+
```sh
|
|
218
|
+
crewcoder hook install --budget 25k
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
By default the GitHub action builds the agent from its tagged source checkout;
|
|
222
|
+
pass a preinstalled executable to skip the build. GitLab requires a
|
|
223
|
+
runner-provided CrewCoder binary.
|
|
224
|
+
See [CI_INTEGRATIONS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/crewcoder-agent/docs/CI_INTEGRATIONS.md).
|
|
225
|
+
|
|
226
|
+
## Debugging
|
|
227
|
+
|
|
228
|
+
```sh
|
|
229
|
+
CREWCODER_TUI_SYSTEM_LOGS=1 npm run dev -w @onpoint-dev-tools/crewcoder-tui
|
|
230
|
+
CREWCODER_DUMP_MODEL_INPUT=1 npm run dev -w @onpoint-dev-tools/crewcoder-tui
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
## Inspired By
|
|
234
|
+
|
|
235
|
+
- Pi
|
|
236
|
+
- Hermes
|
|
237
|
+
|
|
238
|
+
## Documentation
|
|
239
|
+
|
|
240
|
+
- Agent docs: [`crewcoder-agent/docs`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-agent/docs) — providers, tools, sessions, goals, crews, extensions, security, fleet, CI.
|
|
241
|
+
- Contributor docs: [`crewcoder-agent/docs/contributor`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-agent/docs/contributor) — provider transports, TUI backend contract, system prompt template, SDK release gates.
|
|
242
|
+
- TUI docs: [`crewcoder-tui/docs`](https://github.com/OnPoint-Dev-Tools/crewcoder/tree/main/crewcoder-tui/docs) — themes, settings, remote agents, task sidebar, approvals, image attachments.
|
|
243
|
+
- Roadmap: [ROADMAP.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/ROADMAP.md) · Development rules: [AGENTS.md](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/AGENTS.md)
|
|
244
|
+
|
|
245
|
+
## Links
|
|
246
|
+
|
|
247
|
+
- Repository: https://github.com/OnPoint-Dev-Tools/crewcoder
|
|
248
|
+
- Issues: https://github.com/OnPoint-Dev-Tools/crewcoder/issues
|
|
249
|
+
- License: [Apache-2.0](https://github.com/OnPoint-Dev-Tools/crewcoder/blob/main/LICENSE)
|
package/bin/crewcoder.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { runCrewCoder } from "../lib/launcher.js";
|
|
3
|
+
|
|
4
|
+
try {
|
|
5
|
+
process.exitCode = await runCrewCoder(process.argv.slice(2));
|
|
6
|
+
} catch (error) {
|
|
7
|
+
process.stderr.write(`crewcoder: ${error instanceof Error ? error.message : String(error)}\n`);
|
|
8
|
+
process.exitCode = 1;
|
|
9
|
+
}
|
package/lib/launcher.js
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { spawn } from "node:child_process";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { createRequire } from "node:module";
|
|
4
|
+
|
|
5
|
+
const require = createRequire(import.meta.url);
|
|
6
|
+
const AGENT_PACKAGE = "@onpoint-dev-tools/crewcoder-agent";
|
|
7
|
+
const TUI_PACKAGE_JSON = "@onpoint-dev-tools/crewcoder-tui/package.json";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Resolve the installed CLI that should handle this invocation.
|
|
11
|
+
* Bare `crewcoder` opens the TUI; argument-bearing calls use the agent CLI.
|
|
12
|
+
*
|
|
13
|
+
* @param {readonly string[]} args
|
|
14
|
+
* @param {(specifier: string) => string} [resolveModule]
|
|
15
|
+
* @returns {string}
|
|
16
|
+
*/
|
|
17
|
+
export function resolveCrewCoderCli(args, resolveModule = require.resolve) {
|
|
18
|
+
if (args.length === 0) {
|
|
19
|
+
const packageJsonPath = resolveModule(TUI_PACKAGE_JSON);
|
|
20
|
+
return path.join(path.dirname(packageJsonPath), "dist", "cli.js");
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
const agentEntryPath = resolveModule(AGENT_PACKAGE);
|
|
24
|
+
return path.join(path.dirname(agentEntryPath), "cli.js");
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Run the selected CrewCoder package with inherited terminal I/O.
|
|
29
|
+
*
|
|
30
|
+
* @param {readonly string[]} args
|
|
31
|
+
* @param {{ spawnProcess?: typeof spawn, nodePath?: string, resolveModule?: (specifier: string) => string }} [options]
|
|
32
|
+
* @returns {Promise<number>}
|
|
33
|
+
*/
|
|
34
|
+
export function runCrewCoder(args, options = {}) {
|
|
35
|
+
const spawnProcess = options.spawnProcess ?? spawn;
|
|
36
|
+
const nodePath = options.nodePath ?? process.execPath;
|
|
37
|
+
const cliPath = resolveCrewCoderCli(args, options.resolveModule);
|
|
38
|
+
|
|
39
|
+
return new Promise((resolve, reject) => {
|
|
40
|
+
const child = spawnProcess(nodePath, [cliPath, ...args], {
|
|
41
|
+
stdio: "inherit",
|
|
42
|
+
env: process.env
|
|
43
|
+
});
|
|
44
|
+
child.once("error", reject);
|
|
45
|
+
child.once("close", (code, signal) => {
|
|
46
|
+
resolve(code ?? (signal ? 1 : 0));
|
|
47
|
+
});
|
|
48
|
+
});
|
|
49
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "crewcoder",
|
|
3
|
+
"version": "0.6.1",
|
|
4
|
+
"description": "One-command installer and launcher for the CrewCoder agent and terminal UI",
|
|
5
|
+
"private": false,
|
|
6
|
+
"license": "Apache-2.0",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/OnPoint-Dev-Tools/crewcoder.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": "https://github.com/OnPoint-Dev-Tools/crewcoder/issues",
|
|
13
|
+
"homepage": "https://github.com/OnPoint-Dev-Tools/crewcoder#readme",
|
|
14
|
+
"keywords": [
|
|
15
|
+
"ai",
|
|
16
|
+
"coding-agent",
|
|
17
|
+
"crewcoder",
|
|
18
|
+
"cli"
|
|
19
|
+
],
|
|
20
|
+
"bin": {
|
|
21
|
+
"crewcoder": "./bin/crewcoder.js",
|
|
22
|
+
"cc": "./bin/crewcoder.js"
|
|
23
|
+
},
|
|
24
|
+
"files": [
|
|
25
|
+
"bin",
|
|
26
|
+
"lib",
|
|
27
|
+
"LICENSE",
|
|
28
|
+
"README.md"
|
|
29
|
+
],
|
|
30
|
+
"publishConfig": {
|
|
31
|
+
"access": "public",
|
|
32
|
+
"provenance": true
|
|
33
|
+
},
|
|
34
|
+
"packageManager": "npm@11.8.0",
|
|
35
|
+
"workspaces": [
|
|
36
|
+
"crewcoder-*"
|
|
37
|
+
],
|
|
38
|
+
"scripts": {
|
|
39
|
+
"clean": "npm run clean --workspaces --if-present",
|
|
40
|
+
"build": "npm run build --workspaces --if-present",
|
|
41
|
+
"typecheck": "npm run typecheck --workspaces --if-present",
|
|
42
|
+
"test": "npm run test:launcher && npm run test --workspaces --if-present",
|
|
43
|
+
"test:launcher": "vitest run test/launcher.test.js",
|
|
44
|
+
"pack:check": "node scripts/check-crewcoder-package.cjs",
|
|
45
|
+
"release:check": "npm run test:launcher && npm run pack:check",
|
|
46
|
+
"check": "npm run typecheck && npm run test",
|
|
47
|
+
"dev:agent": "npm run dev -w @onpoint-dev-tools/crewcoder-agent",
|
|
48
|
+
"dev:tui": "npm run dev -w @onpoint-dev-tools/crewcoder-tui",
|
|
49
|
+
"start:agent": "npm run start -w @onpoint-dev-tools/crewcoder-agent",
|
|
50
|
+
"start:tui": "npm run start -w @onpoint-dev-tools/crewcoder-tui",
|
|
51
|
+
"release:check:sdk": "node scripts/check-sdk-release.cjs && npm run release:check && npm run release:check -w @onpoint-dev-tools/crewcoder-agent && npm run release:check -w @onpoint-dev-tools/crewcoder-client && npm run release:check -w @onpoint-dev-tools/crewcoder-sdk"
|
|
52
|
+
},
|
|
53
|
+
"dependencies": {
|
|
54
|
+
"@onpoint-dev-tools/crewcoder-agent": "0.6.1",
|
|
55
|
+
"@onpoint-dev-tools/crewcoder-tui": "0.6.0",
|
|
56
|
+
"typescript": "^5.7.2"
|
|
57
|
+
},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@types/fs-extra": "^11.0.4",
|
|
60
|
+
"@types/node": "^22.10.1",
|
|
61
|
+
"tsx": "^4.19.2",
|
|
62
|
+
"vitest": "^2.1.8"
|
|
63
|
+
},
|
|
64
|
+
"engines": {
|
|
65
|
+
"node": ">=22.0.0"
|
|
66
|
+
}
|
|
67
|
+
}
|