crewyard 0.3.1 → 0.3.2
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 +31 -31
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
4
|
|
|
5
|
-
<img src="https://raw.githubusercontent.com/orafaelfragoso/crewyard/v0.3.
|
|
5
|
+
<img src="https://raw.githubusercontent.com/orafaelfragoso/crewyard/v0.3.2/docs/assets/banner.jpg" alt="Crewyard: a crew of AI coding agents planning, coding, reviewing and merging together" width="100%" />
|
|
6
6
|
|
|
7
7
|
<p><strong>Ship together. Merge safely.</strong></p>
|
|
8
8
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
·
|
|
17
17
|
<a href="#how-it-works">How it works</a>
|
|
18
18
|
·
|
|
19
|
-
<a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
19
|
+
<a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md">Architecture</a>
|
|
20
20
|
·
|
|
21
21
|
<a href="#documentation">Documentation</a>
|
|
22
22
|
</p>
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
<img alt="MCP" src="https://img.shields.io/badge/MCP-18181B?style=flat-square" />
|
|
28
28
|
<img alt="Local first" src="https://img.shields.io/badge/Local--first-18181B?style=flat-square" />
|
|
29
29
|
<a href="https://www.npmjs.com/package/crewyard"><img alt="npm" src="https://img.shields.io/npm/v/crewyard?style=flat-square&color=18181B&label=npm" /></a>
|
|
30
|
-
<a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
30
|
+
<a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/LICENSE"><img alt="MIT license" src="https://img.shields.io/badge/License-MIT-18181B?style=flat-square" /></a>
|
|
31
31
|
<a href="https://github.com/orafaelfragoso/crewyard/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/orafaelfragoso/crewyard/actions/workflows/ci.yml/badge.svg" /></a>
|
|
32
32
|
</p>
|
|
33
33
|
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
<br />
|
|
39
39
|
|
|
40
40
|
> [!NOTE]
|
|
41
|
-
> **Pre-1.0 software.** Crewyard is being developed toward v1.0, and commands and configuration may still change between minor versions. Run `crew <command> --help` to see what your installed version supports, and check the [changelog](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
41
|
+
> **Pre-1.0 software.** Crewyard is being developed toward v1.0, and commands and configuration may still change between minor versions. Run `crew <command> --help` to see what your installed version supports, and check the [changelog](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/CHANGELOG.md) before upgrading.
|
|
42
42
|
|
|
43
43
|
## Coding agents are good at writing code. Coordinating them is the hard part.
|
|
44
44
|
|
|
@@ -159,11 +159,11 @@ bun run crew doctor
|
|
|
159
159
|
|
|
160
160
|
In a source checkout, run `bun run crew` from the repository root wherever this README uses `crew`.
|
|
161
161
|
|
|
162
|
-
See [installation and upgrades](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
162
|
+
See [installation and upgrades](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/installation.md) for supported platforms, direct binary installs, checksums, backups, and removal.
|
|
163
163
|
|
|
164
164
|
## Quick start
|
|
165
165
|
|
|
166
|
-
New to Crewyard? The [getting-started guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
166
|
+
New to Crewyard? The [getting-started guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/getting-started.md) walks through every step and what each one does.
|
|
167
167
|
|
|
168
168
|
```bash
|
|
169
169
|
# 1. Register your repository
|
|
@@ -192,13 +192,13 @@ crew service start
|
|
|
192
192
|
crew dashboard
|
|
193
193
|
```
|
|
194
194
|
|
|
195
|
-
`GOAL-1` is the ID that `goal create` prints. Codex and OpenCode work the same way with `--provider codex` or `--provider opencode`. For separate logins, several accounts or API keys, see [Accounts](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
195
|
+
`GOAL-1` is the ID that `goal create` prints. Codex and OpenCode work the same way with `--provider codex` or `--provider opencode`. For separate logins, several accounts or API keys, see [Accounts](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/accounts.md); to change or remove agents, see [Agents and policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/agents.md).
|
|
196
196
|
|
|
197
|
-
To let Claude Code, Codex and OpenCode sessions you start yourself use Crewyard's tasks and tools, run `crew install` (add `--dry-run` first to see the changes). The guide lists [where it installs the MCP server and Skills](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
197
|
+
To let Claude Code, Codex and OpenCode sessions you start yourself use Crewyard's tasks and tools, run `crew install` (add `--dry-run` first to see the changes). The guide lists [where it installs the MCP server and Skills](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/getting-started.md#6-connect-your-own-agent-tools-optional).
|
|
198
198
|
|
|
199
199
|
The background service keeps dispatching ready tasks; the MCP server alone does not keep work running after its host exits.
|
|
200
200
|
|
|
201
|
-
<p><a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
201
|
+
<p><a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/getting-started.md"><strong>Getting started →</strong></a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/accounts.md"><strong>Accounts →</strong></a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/agents.md"><strong>Agents →</strong></a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/reference/cli.md"><strong>CLI reference →</strong></a></p>
|
|
202
202
|
|
|
203
203
|
## How it works
|
|
204
204
|
|
|
@@ -231,17 +231,17 @@ flowchart TB
|
|
|
231
231
|
|
|
232
232
|
**The architecture is deliberately provider-agnostic.** The CLI and MCP server are thin interfaces over shared application services. SQLite WAL provides durable coordination; external GitHub and process side effects are reconciled rather than treated as a single database transaction.
|
|
233
233
|
|
|
234
|
-
For an engineering-level explanation, see the [architecture overview](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
234
|
+
For an engineering-level explanation, see the [architecture overview](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md), [indexing model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/indexing.md), and [task/lease design](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/tasks-and-leases.md).
|
|
235
235
|
|
|
236
236
|
## Interfaces
|
|
237
237
|
|
|
238
238
|
| Interface | Designed for | Reference |
|
|
239
239
|
| :--- | :--- | :--- |
|
|
240
|
-
| **CLI** (`crew`) | Humans, scripts, and command-capable agents | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
241
|
-
| **MCP** (`crew mcp`) | Agent hosts that support Model Context Protocol | [MCP reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
242
|
-
| **Agent Skills** | Portable instructions for planning, execution, review, integration, recovery, and context | [Skills guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
243
|
-
| **Local service** (`crew service`) | Continuous dispatch, reconciliation, and integration | [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
244
|
-
| **Terminal dashboard** (`crew dashboard`) | Operational visibility into active work and events | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
240
|
+
| **CLI** (`crew`) | Humans, scripts, and command-capable agents | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/reference/cli.md) |
|
|
241
|
+
| **MCP** (`crew mcp`) | Agent hosts that support Model Context Protocol | [MCP reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/reference/mcp.md) |
|
|
242
|
+
| **Agent Skills** | Portable instructions for planning, execution, review, integration, recovery, and context | [Skills guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/skills.md) |
|
|
243
|
+
| **Local service** (`crew service`) | Continuous dispatch, reconciliation, and integration | [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md) |
|
|
244
|
+
| **Terminal dashboard** (`crew dashboard`) | Operational visibility into active work and events | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/reference/cli.md) |
|
|
245
245
|
|
|
246
246
|
## Safety is an architectural boundary
|
|
247
247
|
|
|
@@ -254,22 +254,22 @@ Autonomous agents should not be able to bypass coordination simply by asking for
|
|
|
254
254
|
- **Idempotent outbox operations** support retries and recovery after interruption.
|
|
255
255
|
- **Local credential handling** keeps secrets out of repository configuration and orchestration event logs.
|
|
256
256
|
|
|
257
|
-
Security properties depend on configuration and implementation maturity. Read the [security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
257
|
+
Security properties depend on configuration and implementation maturity. Read the [security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/policies/security-model.md) and [default policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/policies/default-policies.md) before enabling unattended workflows.
|
|
258
258
|
|
|
259
259
|
## Documentation
|
|
260
260
|
|
|
261
261
|
| Start here | Learn more |
|
|
262
262
|
| :--- | :--- |
|
|
263
|
-
| [Getting started](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
264
|
-
| [Accounts](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
265
|
-
| [Agents and policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
266
|
-
| [Installation](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
267
|
-
| [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
268
|
-
| [MCP host setup](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
269
|
-
| [Agent Skills](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
270
|
-
| [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
271
|
-
| [Security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
272
|
-
| [Recovery runbooks](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
263
|
+
| [Getting started](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/getting-started.md) | From install to your first agent-run task, step by step |
|
|
264
|
+
| [Accounts](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/accounts.md) | Logging agents in: existing logins, separate logins, API keys |
|
|
265
|
+
| [Agents and policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/agents.md) | Roles, using several accounts, changing and removing agents |
|
|
266
|
+
| [Installation](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/installation.md) | Supported setups, local data, upgrades, and backups |
|
|
267
|
+
| [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/reference/cli.md) | Commands, options, and machine-readable output |
|
|
268
|
+
| [MCP host setup](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/mcp-hosts.md) | Connecting existing coding-agent tools |
|
|
269
|
+
| [Agent Skills](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/skills.md) | Reusable workflows for compatible agents |
|
|
270
|
+
| [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md) | Services, storage, scheduling, and system boundaries |
|
|
271
|
+
| [Security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/policies/security-model.md) | Trust boundaries, permissions, and operational safety |
|
|
272
|
+
| [Recovery runbooks](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/incident-recovery/runbooks.md) | Failures, restarts, and reconciliation |
|
|
273
273
|
|
|
274
274
|
## Development
|
|
275
275
|
|
|
@@ -284,17 +284,17 @@ bun run build:binaries # platform binaries, manifest and checksums
|
|
|
284
284
|
bun run build:npm # npm tarballs, after binaries have been built
|
|
285
285
|
```
|
|
286
286
|
|
|
287
|
-
See [AGENTS.md](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
287
|
+
See [AGENTS.md](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/AGENTS.md) for code conventions, the [architecture documentation](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md) for package boundaries, and the [release process](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/releasing.md) for distribution.
|
|
288
288
|
|
|
289
289
|
## Contributing
|
|
290
290
|
|
|
291
|
-
Contributions are welcome. Read the [contributing guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
291
|
+
Contributions are welcome. Read the [contributing guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/CONTRIBUTING.md) and the [code of conduct](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/CODE_OF_CONDUCT.md), and use [GitHub Issues](https://github.com/orafaelfragoso/crewyard/issues) for bug reports and feature requests. Report vulnerabilities privately as described in the [security policy](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/SECURITY.md).
|
|
292
292
|
|
|
293
293
|
## Project status & licensing
|
|
294
294
|
|
|
295
|
-
Crewyard is **under active development toward v1.0**. Releases are cut automatically from `main` with [release-please](https://github.com/googleapis/release-please); every release is listed in the [changelog](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
295
|
+
Crewyard is **under active development toward v1.0**. Releases are cut automatically from `main` with [release-please](https://github.com/googleapis/release-please); every release is listed in the [changelog](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/CHANGELOG.md) and on the [releases page](https://github.com/orafaelfragoso/crewyard/releases). See the [release process](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/releasing.md) for how npm packages and platform binaries are built and published.
|
|
296
296
|
|
|
297
|
-
Licensed under the [MIT License](https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
297
|
+
Licensed under the [MIT License](https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/LICENSE). Copyright © 2026 Rafael Fragoso.
|
|
298
298
|
|
|
299
299
|
---
|
|
300
300
|
|
|
@@ -302,5 +302,5 @@ Licensed under the [MIT License](https://github.com/orafaelfragoso/crewyard/blob
|
|
|
302
302
|
<p><strong>More agents. Less coordination overhead.</strong></p>
|
|
303
303
|
<sub>Built for developers who want autonomous work to reach a safe, reviewable merge.</sub>
|
|
304
304
|
<br /><br />
|
|
305
|
-
<a href="#quick-start">Get started</a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.
|
|
305
|
+
<a href="#quick-start">Get started</a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.2/docs/architecture/overview.md">Explore the architecture</a> · <a href="https://github.com/orafaelfragoso/crewyard/issues">Issues</a>
|
|
306
306
|
</div>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "crewyard",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"description": "Local-first coordination engine for independent AI coding agents.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai",
|
|
@@ -33,11 +33,11 @@
|
|
|
33
33
|
"node": ">=22"
|
|
34
34
|
},
|
|
35
35
|
"optionalDependencies": {
|
|
36
|
-
"@crewyard/cli-linux-x64": "0.3.
|
|
37
|
-
"@crewyard/cli-linux-arm64": "0.3.
|
|
38
|
-
"@crewyard/cli-darwin-arm64": "0.3.
|
|
39
|
-
"@crewyard/cli-darwin-x64": "0.3.
|
|
40
|
-
"@crewyard/cli-win32-x64": "0.3.
|
|
36
|
+
"@crewyard/cli-linux-x64": "0.3.2",
|
|
37
|
+
"@crewyard/cli-linux-arm64": "0.3.2",
|
|
38
|
+
"@crewyard/cli-darwin-arm64": "0.3.2",
|
|
39
|
+
"@crewyard/cli-darwin-x64": "0.3.2",
|
|
40
|
+
"@crewyard/cli-win32-x64": "0.3.2"
|
|
41
41
|
},
|
|
42
42
|
"publishConfig": {
|
|
43
43
|
"access": "public"
|