archgate 0.4.0 → 0.6.0

package/README.md

@@ -6,6 +6,7 @@
 
 [![License: FSL-1.1-ALv2](https://img.shields.io/badge/License-FSL--1.1--ALv2-blue.svg)](LICENSE.md)
 [![Release](https://github.com/archgate/cli/actions/workflows/release.yml/badge.svg)](https://github.com/archgate/cli/actions/workflows/release.yml)
+[![Docs](https://img.shields.io/badge/docs-cli.archgate.dev-blue)](https://cli.archgate.dev)
 
 </div>
 
@@ -33,15 +34,38 @@ Archgate has two layers:
 
 When a rule is violated, `archgate check` reports the file, line, and which ADR was broken. Exit code 1 means violations — wire it into CI and it blocks merges automatically.
 
-**The AI integration layer** is a Claude Code plugin that gives AI agents live access to your ADRs through the MCP server (`archgate mcp`). Agents read the decisions before writing code, validate changes after, and capture new patterns into the governance base. Archgate ships as its own governance subject — its own development is governed by the ADRs in `.archgate/adrs/`.
+**The CLI is free and open source.** Writing ADRs, enforcing rules, running checks in CI, and wiring up pre-commit hooks all work without an account or subscription.
+
+**Editor plugins are an optional paid add-on** for teams that want AI agents (Claude Code, Cursor) to read ADRs, validate changes, and capture new patterns automatically. Plugins are distributed from [plugins.archgate.dev](https://plugins.archgate.dev). See [Editor plugins](#editor-plugins) for details.
 
 ## Installation
 
 ```bash
+# npm
 npm install -g archgate
+
+# Bun
+bun install -g archgate
+
+# Yarn
+yarn global add archgate
+
+# pnpm
+pnpm add -g archgate
+```
+
+You can also install Archgate as a dev dependency and run it through your package manager:
+
+```bash
+# Install as dev dependency
+npm install -D archgate    # or: bun add -d archgate
+
+# Run via package manager
+npx archgate check         # npm / Yarn / pnpm
+bun run archgate check     # Bun
 ```
 
-**Requirements:** macOS (arm64) or Linux (x86_64). Node.js is only needed to run the wrapper — the CLI itself is a standalone binary.
+**Requirements:** macOS (arm64), Linux (x86_64), or Windows (x86_64). Node.js is only needed to run the npm/yarn/pnpm wrapper — the CLI itself is a standalone binary.
 
 > **Using [proto](https://moonrepo.dev/proto)?** Add the following to `~/.proto/config.toml` and your shell profile so globals persist across Node.js version switches:
 >
@@ -59,8 +83,8 @@ npm install -g archgate
 ## Quick start
 
 ```bash
-# 1. Install
-npm install -g archgate
+# 1. Install (pick your package manager)
+npm install -g archgate    # or: bun install -g archgate
 
 # 2. Initialize governance in your project
 cd my-project
@@ -76,7 +100,9 @@ archgate init
 archgate check
 ```
 
-`archgate init` creates the `.archgate/adrs/` directory, an example ADR with a companion rules file to show the pattern, and configures the Claude Code plugin if you use it.
+`archgate init` creates the `.archgate/adrs/` directory with an example ADR and rules file, and configures editor settings. No account or login is needed — the CLI is fully functional without plugins.
+
+**Want AI agent integration?** See [Editor plugins](#editor-plugins) to add the optional paid plugin for Claude Code or Cursor.
 
 ## Writing rules
 
@@ -117,15 +143,37 @@ Rules receive the list of files to check (filtered by the ADR's `files` glob if
 
 ## Commands
 
+### `archgate login`
+
+Authenticate with GitHub to access the optional paid editor plugins.
+
+```bash
+archgate login           # authenticate via GitHub Device Flow
+archgate login status    # show current auth status
+archgate login logout    # remove stored credentials
+archgate login refresh   # re-authenticate and claim a new token
+```
+
+Opens a browser-based GitHub Device Flow. Once authorized, an archgate plugin token is stored in `~/.archgate/credentials`. This token is used by `archgate init` to install the editor plugin. Not required for CLI-only usage.
+
 ### `archgate init`
 
 Initialize governance in the current project.
 
 ```bash
-archgate init
+archgate init                    # Claude Code (default)
+archgate init --editor cursor    # Cursor
+archgate init --install-plugin   # force plugin install attempt
 ```
 
-Creates `.archgate/adrs/` with an example ADR and rules file, and optionally wires up the Claude Code plugin.
+Creates `.archgate/adrs/` with an example ADR and rules file and configures editor settings. Works without an account — plugin installation only happens when you are logged in.
+
+**Plugin install behavior** (optional — requires `archgate login`):
+
+- If you are logged in, init auto-detects your credentials and installs the plugin.
+- For **Claude Code**: if the `claude` CLI is on PATH, the plugin is installed automatically via `claude plugin marketplace add` and `claude plugin install`. If not, the manual commands are printed.
+- For **Cursor**: the plugin bundle is downloaded from [plugins.archgate.dev](https://plugins.archgate.dev) and extracted into `.cursor/`.
+- Use `--install-plugin` to explicitly request plugin installation (useful if auto-detection is skipped).
 
 ### `archgate check`
 
@@ -230,15 +278,45 @@ pre-commit:
       run: archgate check --staged
 ```
 
-## Claude Code plugin
+## Editor plugins
+
+> **Plugins are an optional paid add-on.** The CLI works fully without them. Plugins add AI agent integration — your AI coding agent reads ADRs before writing code, validates changes after implementation, and captures new patterns back into ADRs.
+
+Plugins are distributed from [plugins.archgate.dev](https://plugins.archgate.dev).
+
+### Setup
+
+```bash
+# 1. Log in (one-time) — links your GitHub account and issues a plugin token
+archgate login
+
+# 2. Initialize a project with the plugin
+archgate init                  # Claude Code (default)
+archgate init --editor cursor  # or Cursor
+```
+
+If you are logged in, `archgate init` auto-detects your credentials and installs the plugin. You can also pass `--install-plugin` explicitly.
+
+### Claude Code
+
+If the `claude` CLI is on your PATH, the plugin is installed automatically. Otherwise, run the printed commands manually:
+
+```bash
+claude plugin marketplace add https://<user>:<token>@plugins.archgate.dev/archgate.git
+claude plugin install archgate@archgate
+```
+
+Once installed, run `archgate:onboard` in Claude Code to initialize governance for your project.
+
+### Cursor
+
+The Cursor plugin bundle is downloaded from [plugins.archgate.dev](https://plugins.archgate.dev) and extracted into `.cursor/` automatically.
 
-The Claude Code plugin (`archgate:developer`) gives AI agents a full governance workflow:
+Once installed, run the `ag-onboard` skill in Cursor to initialize governance for your project.
 
-- Reads applicable ADRs before writing code
-- Validates changes after implementation
-- Captures new patterns back into ADRs
+## Documentation
 
-Install the plugin from [archgate/claude-code-plugin](https://github.com/archgate/claude-code-plugin), then run `archgate:onboard` once in your project to initialize governance.
+Full documentation is available at **[cli.archgate.dev](https://cli.archgate.dev)** -- including guides for writing ADRs, writing rules, CI integration, editor plugin setup, and the complete CLI and MCP reference.
 
 ## Contributing
 

package/bin/archgate.cjs

@@ -9,16 +9,18 @@ function getPlatformPackageName() {
   const { platform, arch } = process;
   if (platform === "darwin" && arch === "arm64") return "archgate-darwin-arm64";
   if (platform === "linux" && arch === "x64") return "archgate-linux-x64";
+  if (platform === "win32" && arch === "x64") return "archgate-win32-x64";
   throw new Error(
-    `Unsupported platform: ${platform}/${arch}\narchgate supports darwin/arm64 and linux/x64 only.`
+    `Unsupported platform: ${platform}/${arch}\narchgate supports darwin/arm64, linux/x64, and win32/x64.`
   );
 }
 
 function getBinaryPath() {
   const pkgName = getPlatformPackageName();
+  const binaryName = process.platform === "win32" ? "archgate.exe" : "archgate";
   try {
     const pkgDir = path.dirname(require.resolve(`${pkgName}/package.json`));
-    const binaryPath = path.join(pkgDir, "bin", "archgate");
+    const binaryPath = path.join(pkgDir, "bin", binaryName);
     if (fs.existsSync(binaryPath)) return binaryPath;
   } catch {
     /* platform package not installed */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "archgate",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Enforce Architecture Decision Records as executable rules — for both humans and AI agents",
   "readme": "README.md",
   "license": "FSL-1.1-ALv2",
@@ -21,8 +21,11 @@
   },
   "keywords": [
     "archgate",
-    "cli",
-    "framework"
+    "adr",
+    "architecture-decision-records",
+    "governance",
+    "linter",
+    "cli"
   ],
   "bugs": {
     "url": "https://github.com/archgate/cli/issues"
@@ -33,7 +36,8 @@
   },
   "os": [
     "darwin",
-    "linux"
+    "linux",
+    "win32"
   ],
   "scripts": {
     "cli": "bun run src/cli.ts",
@@ -44,10 +48,13 @@
     "format:check": "prettier --check .",
     "test": "bun test --timeout 60000",
     "test:watch": "bun test --watch --timeout 60000",
-    "build:check": "bun build src/cli.ts --compile --bytecode --outfile dist/.build-check && rm -f dist/.build-check",
+    "build:check": "bun build src/cli.ts --compile --bytecode --outfile dist/.build-check && rm -f dist/.build-check dist/.build-check.exe",
     "validate": "bun run lint && bun run typecheck && bun run format:check && bun test && bun run check && bun run build:check",
     "commit": "cz",
-    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
+    "docs:dev": "cd docs && bunx --bun astro dev",
+    "docs:build": "cd docs && bunx --bun astro build",
+    "docs:preview": "cd docs && bunx --bun astro preview"
   },
   "type": "module",
   "devDependencies": {
@@ -71,6 +78,7 @@
   },
   "optionalDependencies": {
     "archgate-darwin-arm64": ">=0.1.1",
-    "archgate-linux-x64": ">=0.1.1"
+    "archgate-linux-x64": ">=0.1.1",
+    "archgate-win32-x64": ">=0.1.1"
   }
 }