agentplane 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,20 @@
 # agentplane
 
-AgentPlane is an offline-first CLI for managing agent workflows (tasks, guardrails, recipes).
+[![npm](https://img.shields.io/npm/v/agentplane.svg)](https://www.npmjs.com/package/agentplane)
+[![Downloads](https://img.shields.io/npm/dm/agentplane.svg)](https://www.npmjs.com/package/agentplane)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/basilisk-labs/agentplane/blob/main/LICENSE)
+[![Node.js 20+](https://img.shields.io/badge/Node.js-20%2B-3c873a.svg)](https://github.com/basilisk-labs/agentplane/blob/main/docs/user/prerequisites.mdx)
+
+Agent Plane is an offline-first CLI for running policy-driven agent workflows inside real repositories.
+It turns "AI magic" into a predictable process with approvals, role boundaries, and audit-friendly artifacts.
+
+## Features
+
+- Policy-first execution with explicit approvals and guardrails.
+- Role-based workflows for teams: ORCHESTRATOR, PLANNER, CREATOR, INTEGRATOR, etc.
+- Two workflow modes: `direct` (single checkout) and `branch_pr` (worktrees + integration).
+- Task tracking, verification, and exports baked in.
+- Recipes for repeatable setup and automation.
 
 ## Install
 
@@ -8,12 +22,71 @@ AgentPlane is an offline-first CLI for managing agent workflows (tasks, guardrai
 npm install -g agentplane
 ```
 
+Or run without installing:
+
+```bash
+npx agentplane --help
+```
+
 ## Requirements
 
 - Node.js >= 20
 
-## CLI
+## Quickstart
+
+Initialize a repository:
+
+```bash
+npx agentplane init
+```
+
+See the built-in quickstart guide:
+
+```bash
+npx agentplane quickstart
+```
+
+Switch workflow mode if you need a structured team flow:
+
+```bash
+npx agentplane config set workflow_mode branch_pr
+```
+
+## Common Commands
 
 ```bash
 agentplane --help
+agentplane quickstart
+agentplane config show
+agentplane task list
+agentplane task new --title "..." --description "..." --priority med --owner ORCHESTRATOR --tag docs
+agentplane verify <task-id>
+agentplane finish <task-id>
+agentplane recipes list
 ```
+
+## Docs and Guides
+
+- Documentation index: https://github.com/basilisk-labs/agentplane/tree/main/docs
+- Workflow overview: https://github.com/basilisk-labs/agentplane/blob/main/docs/user/workflow.mdx
+- CLI commands: https://github.com/basilisk-labs/agentplane/blob/main/docs/user/commands.mdx
+- Project layout: https://github.com/basilisk-labs/agentplane/blob/main/docs/developer/project-layout.mdx
+- Recipes: https://github.com/basilisk-labs/agentplane/tree/main/agentplane-recipes
+
+## How it works
+
+Agent Plane expects a repository policy file (`AGENTS.md`) plus a project config (`.agentplane/config.json`).
+Together, they define role boundaries, approval gates, and the execution pipeline:
+
+```text
+Preflight -> Plan -> Approval -> Tasks -> Verify -> Finish -> Export
+```
+
+## Support
+
+- Issues: https://github.com/basilisk-labs/agentplane/issues
+- Contributing: https://github.com/basilisk-labs/agentplane/blob/main/CONTRIBUTING.md
+
+## License
+
+MIT

package/assets/AGENTS.md

@@ -163,6 +163,7 @@ Every task must have these sections in its README or task doc:
 
 ## Updating task docs
 
+- Workflow/task artifacts (task READMEs, PR artifacts, task exports) must be updated via `agentplane` commands, not manual edits.
 - Task README updates must be done via `agentplane task doc set ...`
 - Manual edits to `.agentplane/tasks/<task-id>/README.md` are prohibited.
 
@@ -170,6 +171,8 @@ Every task must have these sections in its README or task doc:
 
 # COMMIT WORKFLOW
 
+- Commits and pushes must go through `agentplane` commands (no direct `git commit`/`git push`). If a push is needed but no `agentplane` command exists, ask for guidance.
+
 ## Commit message semantics (canonical)
 
 There are two supported modes:

package/dist/cli/prompts.js

@@ -8,7 +8,7 @@ export async function promptChoice(prompt, choices, defaultValue) {
     if (!trimmed)
         return defaultValue;
     if (!choices.includes(trimmed)) {
-        process.stdout.write(`Invalid choice, using default ${defaultValue}\n`);
+        process.stdout.write(`Invalid choice; using default ${defaultValue}\n`);
         return defaultValue;
     }
     return trimmed;

package/dist/cli/recipes-bundled.js

@@ -10,9 +10,9 @@ export function listBundledRecipes() {
 export function renderBundledRecipesHint() {
     const entries = listBundledRecipes();
     if (entries.length === 0) {
-        return "Available bundled recipes: none";
+        return "Bundled recipes: none";
     }
-    return `Available bundled recipes: ${entries.map((entry) => entry.id).join(", ")}`;
+    return `Bundled recipes: ${entries.map((entry) => entry.id).join(", ")}`;
 }
 export function validateBundledRecipesSelection(recipes) {
     if (recipes.length === 0)
@@ -27,7 +27,7 @@ export function validateBundledRecipesSelection(recipes) {
         throw new CliError({
             exitCode: 2,
             code: "E_USAGE",
-            message: `Unknown recipes: ${missing.join(", ")}. ${renderBundledRecipesHint()}`,
+            message: `Unknown recipe id(s): ${missing.join(", ")}. ${renderBundledRecipesHint()}`,
         });
     }
 }

package/dist/command-guide.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"command-guide.d.ts","sourceRoot":"","sources":["../src/command-guide.ts"],"names":[],"mappings":"AA4KA,wBAAgB,SAAS,IAAI,MAAM,EAAE,CAEpC;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOzD;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CA2EzC"}
+{"version":3,"file":"command-guide.d.ts","sourceRoot":"","sources":["../src/command-guide.ts"],"names":[],"mappings":"AA4KA,wBAAgB,SAAS,IAAI,MAAM,EAAE,CAEpC;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAOzD;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CA4EzC"}

package/dist/command-guide.js

@@ -228,6 +228,7 @@ export function renderQuickstart() {
         "- `--json`: emit JSON-formatted errors",
         "- `--help` / `-h`: show help",
         "- `--version`: show version",
+        "- `--no-update-check`: skip checking npm for a newer CLI version",
         "",
         "Notes:",
         "- `.env` at the repo root is loaded automatically (without overwriting existing environment variables).",

package/dist/help.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,IAAI,MAAM,CA2HnC"}
+{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,IAAI,MAAM,CA4HnC"}

package/dist/help.js

@@ -3,15 +3,16 @@ export function renderHelp() {
         "agentplane (v1 prototype)",
         "",
         "Usage:",
-        "  agentplane [--root <path>] [--json] <namespace> <command> [options]",
-        "  agentplane [--root <path>] [--json] <command> [options]",
+        "  agentplane [--root <path>] [--json] [--no-update-check] <namespace> <command> [options]",
+        "  agentplane [--root <path>] [--json] [--no-update-check] <command> [options]",
         "",
         "Core namespaces (implemented in this prototype): config, mode, task, ide, recipes, backend",
         "",
         "Flags:",
-        "  --help, -h     Show help",
-        "  --version      Show version",
-        "  --root <path>  Treat <path> as project root",
+        "  --help, -h           Show help",
+        "  --version            Show version",
+        "  --root <path>        Treat <path> as project root",
+        "  --no-update-check    Skip checking npm for a newer CLI version",
         "",
         "Quickstart commands:",
         "  agentplane quickstart",

package/dist/run-cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run-cli.d.ts","sourceRoot":"","sources":["../src/run-cli.ts"],"names":[],"mappings":"AA+sPA,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAunD5D"}
+{"version":3,"file":"run-cli.d.ts","sourceRoot":"","sources":["../src/run-cli.ts"],"names":[],"mappings":"AAo8QA,wBAAsB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA4/D5D"}