@pathrule/cli 0.0.1 → 0.0.2

package/README.md

@@ -1,41 +1,65 @@
-# Pathrule CLI
+# Pathrule
 
-Pathrule CLI is the local runtime for headless terminals, SSH sessions, and
-Browser+CLI workflows. It owns local auth, workspace attach, MCP install,
-preflight checks, companion-file sync, and doctor diagnostics.
+Pathrule is the shared memory, rules, and skills layer for AI coding agents.
 
-## Distribution Policy
+Use the CLI to connect a local repository to Pathrule, sync the workspace
+context agents need, and install Pathrule into tools such as Claude Code,
+Cursor, Codex, and Windsurf.
 
-Pathrule CLI v1 ships through three channels:
+## Getting Started
 
-- Signed standalone binary artifacts for direct download.
-- Homebrew tap formula that installs the signed binary artifact.
-- `@pathrule/cli` npm package as a thin launcher/installer for Node-first users.
+Install the CLI:
 
-The CLI does not silently replace its own binary by default. Update behavior is
-controlled by `PATHRULE_UPDATE_POLICY` or `pathrule config set update.policy`:
+```bash
+npm i -g @pathrule/cli
+```
+
+Run setup from the repository you want to connect:
 
-- `manual`: no update checks.
-- `notify`: check for newer versions and print a passive notice.
-- `auto`: opt-in only, reserved for managed installers such as npm or Homebrew.
+```bash
+cd your-project
+pathrule setup
+```
 
-`CI=true` and `NO_UPDATE_CHECK=1` force manual mode.
+`pathrule setup` guides you through sign-in when needed, finds or creates the
+right workspace, attaches the current folder, syncs local companion files, and
+offers to install Pathrule for your AI tools.
 
-## Install
+## What Pathrule Gives Your Agents
 
-### Homebrew
+- Path-scoped context, delivered just in time instead of pasted into every chat.
+- Shared memory, rules, and skills that survive between AI sessions.
+- One workspace layer for Claude Code, Cursor, Codex, Windsurf, and other
+  MCP-compatible tools.
+- Local setup for companion files, MCP config, SSH sessions, and headless
+  terminals.
+- A privacy-first model: Pathrule does not read, scan, or upload your source
+  code.
+
+## Common Commands
 
 ```bash
-brew tap pathrule/tap
-brew install pathrule
+pathrule setup
+pathrule sync
+pathrule start
+pathrule status
 ```
 
-Upgrade:
+For diagnostics:
 
 ```bash
-brew upgrade pathrule
+pathrule doctor
 ```
 
+For scripted setup:
+
+```bash
+pathrule setup --json
+pathrule setup --workspace <workspace-id-or-name> --target all --yes
+```
+
+## Install Options
+
 ### npm
 
 ```bash
@@ -48,58 +72,41 @@ Upgrade:
 npm i -g @pathrule/cli@latest
 ```
 
-### Standalone
+### Homebrew
 
 ```bash
-curl -fsSL https://pathrule.io/install.sh | sh
+brew install sertanhelvaci/tap/pathrule
 ```
 
-The standalone installer must verify the published checksum and signature before
-placing the binary on `PATH`. The concrete signature manifest is owned by M34b
-release integrity.
-
-## First Run
+Upgrade:
 
 ```bash
-pathrule login
-pathrule setup --json
-pathrule setup --workspace <workspace-id-or-name> --target all --yes
-pathrule start
-pathrule doctor
+brew upgrade sertanhelvaci/tap/pathrule
 ```
 
-Run `pathrule start` to start the local Web bridge manually. Use `pathrule daemon autostart on`
-or `pathrule daemon autostart off` to toggle whether it starts when you sign in.
+## Authentication
 
-`pathrule login` opens the hosted Pathrule Web authorization flow:
+Most users do not need to run `pathrule login` manually. `pathrule setup`
+starts the hosted Pathrule authorization flow when the CLI is not signed in.
 
-```text
-One-time code: ABCD-EFGH
-A browser window should open. If not, visit https://app.pathrule.io/device?code=ABCD-EFGH.
+You can still sign in directly:
+
+```bash
+pathrule login
 ```
 
-## Compatibility Endpoint
+The login flow shows a one-time code and opens Pathrule Web in your browser.
 
-`pathrule update` reads:
+## Security
 
-```text
-https://app.pathrule.io/cli/versions.json
-```
+Pathrule is designed for team workspaces without taking custody of your
+repository:
 
-Expected shape:
-
-```json
-{
-  "latest_version": "0.5.0",
-  "min_supported_protocol_version": "0.5.0",
-  "upgrade_command": "brew upgrade pathrule",
-  "channels": {
-    "brew": "brew upgrade pathrule",
-    "npm": "npm i -g @pathrule/cli@latest",
-    "standalone": "curl -fsSL https://pathrule.io/install.sh | sh"
-  }
-}
-```
+- Your source code stays on your machine.
+- Cloud access uses user sessions, not embedded service keys.
+- Workspace permissions are enforced server-side and by database row-level
+  security.
+- The local bridge binds to loopback and is intended for local browser and CLI
+  workflows only.
 
-The endpoint is advisory for M31a. Production release gating, checksums,
-signature manifests, and installer integrity checks land in M34b.
+For more details, visit [pathrule.io](https://pathrule.io).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pathrule/cli",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Pathrule CLI",
   "license": "Proprietary",
   "type": "module",