crewyard 0.1.1 → 0.3.0

package/README.md

@@ -2,7 +2,7 @@
 
 <div align="center">
 
-  <h1>crewyard</h1>
+  <img src="https://raw.githubusercontent.com/orafaelfragoso/crewyard/v0.3.0/docs/assets/banner.jpg" alt="Crewyard: a crew of AI coding agents planning, coding, reviewing and merging together" width="100%" />
 
   <p><strong>Ship together. Merge safely.</strong></p>
 
@@ -16,7 +16,7 @@
     &nbsp;&nbsp;·&nbsp;&nbsp;
     <a href="#how-it-works">How it works</a>
     &nbsp;&nbsp;·&nbsp;&nbsp;
-    <a href="docs/architecture/overview.md">Architecture</a>
+    <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md">Architecture</a>
     &nbsp;&nbsp;·&nbsp;&nbsp;
     <a href="#documentation">Documentation</a>
   </p>
@@ -27,7 +27,7 @@
     <img alt="MCP" src="https://img.shields.io/badge/MCP-18181B?style=flat-square" />
     <img alt="Local first" src="https://img.shields.io/badge/Local--first-18181B?style=flat-square" />
     <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>
-    <a href="LICENSE"><img alt="MIT license" src="https://img.shields.io/badge/License-MIT-18181B?style=flat-square" /></a>
+    <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/LICENSE"><img alt="MIT license" src="https://img.shields.io/badge/License-MIT-18181B?style=flat-square" /></a>
     <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>
   </p>
 
@@ -38,7 +38,7 @@
 <br />
 
 > [!NOTE]
-> **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](CHANGELOG.md) before upgrading.
+> **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.0/CHANGELOG.md) before upgrading.
 
 ## Coding agents are good at writing code. Coordinating them is the hard part.
 
@@ -159,47 +159,46 @@ bun run crew doctor
 
 In a source checkout, run `bun run crew` from the repository root wherever this README uses `crew`.
 
-See [installation and upgrades](docs/installation.md) for supported platforms, direct binary installs, checksums, backups, and removal.
+See [installation and upgrades](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/installation.md) for supported platforms, direct binary installs, checksums, backups, and removal.
 
 ## Quick start
 
-### 1. Initialize your repository
+New to Crewyard? The [getting-started guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/getting-started.md) walks through every step and what each one does.
 
 ```bash
+# 1. Register your repository
+cd ~/src/my-repo
 crew doctor
-crew init --repo /path/to/your/project
-```
-
-Crewyard creates repository configuration at `.crewyard/config.yaml` and manages coordination state locally.
-
-### 2. Connect your agents
-
-```bash
-crew account add --provider codex --name personal
-crew agent create --name engineer --provider codex --account personal
-crew install --target codex,claude,opencode --dry-run
-crew install --target codex,claude,opencode
-```
-
-The installer registers `crew mcp` and adds portable Agent Skills to supported agent hosts. Inspect the dry-run output before allowing changes to host configuration.
+crew init --repo .
 
-### 3. Plan and supervise a goal
+# 2. Add an account: reuse the Claude Code login you already have
+crew account add --provider claude --name personal --use-default-config
+crew account test claude/personal
 
-Review the plan before approving it, and watch the first runs before leaving the service unattended:
+# 3. Create agents that use it, and turn on AI review
+crew agent create --name architect --role architect --account claude/personal
+crew agent create --name engineer  --account claude/personal
+crew agent create --name reviewer  --role reviewer  --account claude/personal
+crew config set review.reviewer_agent reviewer --yes
 
-```bash
+# 4. Give it a goal, review the plan, approve it
 crew goal create --title "Add JWT authentication" --description-file goal.md
 crew goal plan GOAL-1 --agent architect
-crew goal approve GOAL-1
+crew goal status GOAL-1
+crew goal approve GOAL-1 --yes
+
+# 5. Let it work, and watch
 crew service start
 crew dashboard
 ```
 
-Create an agent with `--role architect` before using `--agent architect`. `GOAL-1` is illustrative; use the ID returned by the create command.
+`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.0/docs/accounts.md); to change or remove agents, see [Agents and policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/agents.md).
+
+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.0/docs/getting-started.md#6-connect-your-own-agent-tools-optional).
 
-The background service is required for continuous dispatch and reconciliation; the MCP server alone does not keep autonomous work running after the host exits.
+The background service keeps dispatching ready tasks; the MCP server alone does not keep work running after its host exits.
 
-<p><a href="docs/installation.md"><strong>Installation guide →</strong></a> &nbsp;·&nbsp; <a href="docs/reference/cli.md"><strong>CLI reference →</strong></a></p>
+<p><a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/getting-started.md"><strong>Getting started →</strong></a> &nbsp;·&nbsp; <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/accounts.md"><strong>Accounts →</strong></a> &nbsp;·&nbsp; <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/agents.md"><strong>Agents →</strong></a> &nbsp;·&nbsp; <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/reference/cli.md"><strong>CLI reference →</strong></a></p>
 
 ## How it works
 
@@ -232,17 +231,17 @@ flowchart TB
 
 **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.
 
-For an engineering-level explanation, see the [architecture overview](docs/architecture/overview.md), [indexing model](docs/architecture/indexing.md), and [task/lease design](docs/architecture/tasks-and-leases.md).
+For an engineering-level explanation, see the [architecture overview](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md), [indexing model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/indexing.md), and [task/lease design](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/tasks-and-leases.md).
 
 ## Interfaces
 
 | Interface | Designed for | Reference |
 | :--- | :--- | :--- |
-| **CLI** (`crew`) | Humans, scripts, and command-capable agents | [CLI reference](docs/reference/cli.md) |
-| **MCP** (`crew mcp`) | Agent hosts that support Model Context Protocol | [MCP reference](docs/reference/mcp.md) |
-| **Agent Skills** | Portable instructions for planning, execution, review, integration, recovery, and context | [Skills guide](docs/skills.md) |
-| **Local service** (`crew service`) | Continuous dispatch, reconciliation, and integration | [Architecture](docs/architecture/overview.md) |
-| **Terminal dashboard** (`crew dashboard`) | Operational visibility into active work and events | [CLI reference](docs/reference/cli.md) |
+| **CLI** (`crew`) | Humans, scripts, and command-capable agents | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/reference/cli.md) |
+| **MCP** (`crew mcp`) | Agent hosts that support Model Context Protocol | [MCP reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/reference/mcp.md) |
+| **Agent Skills** | Portable instructions for planning, execution, review, integration, recovery, and context | [Skills guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/skills.md) |
+| **Local service** (`crew service`) | Continuous dispatch, reconciliation, and integration | [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md) |
+| **Terminal dashboard** (`crew dashboard`) | Operational visibility into active work and events | [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/reference/cli.md) |
 
 ## Safety is an architectural boundary
 
@@ -255,19 +254,22 @@ Autonomous agents should not be able to bypass coordination simply by asking for
 - **Idempotent outbox operations** support retries and recovery after interruption.
 - **Local credential handling** keeps secrets out of repository configuration and orchestration event logs.
 
-Security properties depend on configuration and implementation maturity. Read the [security model](docs/policies/security-model.md) and [default policies](docs/policies/default-policies.md) before enabling unattended workflows.
+Security properties depend on configuration and implementation maturity. Read the [security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/policies/security-model.md) and [default policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/policies/default-policies.md) before enabling unattended workflows.
 
 ## Documentation
 
 | Start here | Learn more |
 | :--- | :--- |
-| [Installation](docs/installation.md) | Supported setups, local data, upgrades, and backups |
-| [CLI reference](docs/reference/cli.md) | Commands, options, and machine-readable output |
-| [MCP host setup](docs/mcp-hosts.md) | Connecting existing coding-agent tools |
-| [Agent Skills](docs/skills.md) | Reusable workflows for compatible agents |
-| [Architecture](docs/architecture/overview.md) | Services, storage, scheduling, and system boundaries |
-| [Security model](docs/policies/security-model.md) | Trust boundaries, permissions, and operational safety |
-| [Recovery runbooks](docs/incident-recovery/runbooks.md) | Failures, restarts, and reconciliation |
+| [Getting started](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/getting-started.md) | From install to your first agent-run task, step by step |
+| [Accounts](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/accounts.md) | Logging agents in: existing logins, separate logins, API keys |
+| [Agents and policies](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/agents.md) | Roles, using several accounts, changing and removing agents |
+| [Installation](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/installation.md) | Supported setups, local data, upgrades, and backups |
+| [CLI reference](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/reference/cli.md) | Commands, options, and machine-readable output |
+| [MCP host setup](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/mcp-hosts.md) | Connecting existing coding-agent tools |
+| [Agent Skills](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/skills.md) | Reusable workflows for compatible agents |
+| [Architecture](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md) | Services, storage, scheduling, and system boundaries |
+| [Security model](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/policies/security-model.md) | Trust boundaries, permissions, and operational safety |
+| [Recovery runbooks](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/incident-recovery/runbooks.md) | Failures, restarts, and reconciliation |
 
 ## Development
 
@@ -282,17 +284,17 @@ bun run build:binaries  # platform binaries, manifest and checksums
 bun run build:npm       # npm tarballs, after binaries have been built
 ```
 
-See [AGENTS.md](AGENTS.md) for code conventions, the [architecture documentation](docs/architecture/overview.md) for package boundaries, and the [release process](docs/releasing.md) for distribution.
+See [AGENTS.md](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/AGENTS.md) for code conventions, the [architecture documentation](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md) for package boundaries, and the [release process](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/releasing.md) for distribution.
 
 ## Contributing
 
-Contributions are welcome. Read the [contributing guide](CONTRIBUTING.md) and the [code of conduct](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](SECURITY.md).
+Contributions are welcome. Read the [contributing guide](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/CONTRIBUTING.md) and the [code of conduct](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/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.0/SECURITY.md).
 
 ## Project status & licensing
 
-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](CHANGELOG.md) and on the [releases page](https://github.com/orafaelfragoso/crewyard/releases). See the [release process](docs/releasing.md) for how npm packages and platform binaries are built and published.
+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.0/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.0/docs/releasing.md) for how npm packages and platform binaries are built and published.
 
-Licensed under the [MIT License](LICENSE). Copyright © 2026 Rafael Fragoso.
+Licensed under the [MIT License](https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/LICENSE). Copyright © 2026 Rafael Fragoso.
 
 ---
 
@@ -300,5 +302,5 @@ Licensed under the [MIT License](LICENSE). Copyright © 2026 Rafael Fragoso.
   <p><strong>More agents. Less coordination overhead.</strong></p>
   <sub>Built for developers who want autonomous work to reach a safe, reviewable merge.</sub>
   <br /><br />
-  <a href="#quick-start">Get started</a> · <a href="docs/architecture/overview.md">Explore the architecture</a> · <a href="https://github.com/orafaelfragoso/crewyard/issues">Issues</a>
+  <a href="#quick-start">Get started</a> · <a href="https://github.com/orafaelfragoso/crewyard/blob/v0.3.0/docs/architecture/overview.md">Explore the architecture</a> · <a href="https://github.com/orafaelfragoso/crewyard/issues">Issues</a>
 </div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crewyard",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Local-first coordination engine for independent AI coding agents.",
   "keywords": [
     "ai",
@@ -33,11 +33,11 @@
     "node": ">=22"
   },
   "optionalDependencies": {
-    "@crewyard/cli-linux-x64": "0.1.1",
-    "@crewyard/cli-linux-arm64": "0.1.1",
-    "@crewyard/cli-darwin-arm64": "0.1.1",
-    "@crewyard/cli-darwin-x64": "0.1.1",
-    "@crewyard/cli-win32-x64": "0.1.1"
+    "@crewyard/cli-linux-x64": "0.3.0",
+    "@crewyard/cli-linux-arm64": "0.3.0",
+    "@crewyard/cli-darwin-arm64": "0.3.0",
+    "@crewyard/cli-darwin-x64": "0.3.0",
+    "@crewyard/cli-win32-x64": "0.3.0"
   },
   "publishConfig": {
     "access": "public"