@vividcodeai/pick 0.0.2-test → 0.1.6

package/README.md

@@ -0,0 +1,157 @@
+[中文文档](README.zh-CN.md)
+
+![Pick TUI](docs/image/tui-en.png)
+
+# Pick
+
+**Pick** is an AI coding assistant that runs in your terminal. It connects to multiple LLM providers (Anthropic, OpenAI, Google, Mistral, Bedrock, etc.), understands your codebase, and can read, write, edit files, run commands, search code, and more — all through natural language conversation.
+
+A Rust port of the pi AI coding agent, combining high performance with reliability.
+
+## Features
+
+- **Multi-provider LLM** — Anthropic, OpenAI, Google, Mistral, Bedrock, Azure OpenAI, Cloudflare, GitHub Copilot, Google Vertex
+- **4 run modes** — TUI (default), Interactive (REPL), Print/JSON (batch), RPC (JSON-RPC over stdio)
+- **Agent tool system** — read, write, edit, bash, grep, find, ls, webfetch
+- **Extensions** — dynamic library loading via lifecycle hooks
+- **MCP support** — Model Context Protocol servers for extending tool capabilities
+- **Session management** — JSONL-based persistence, fork/resume, compaction, branch summarization
+- **Plan / Build modes** — Read-only planning phase before making changes
+- **Sandbox isolation** — Windows restricted tokens, Linux bubblewrap, macOS Seatbelt
+- **Permission system** — Granular allow/deny/ask rules with audit trail
+- **Custom TUI** — Differential rendering, markdown, syntax highlighting, image display, undo/redo
+- **Skills & prompt templates** — Reusable instructions and system prompts
+- **Themes** — Customizable terminal UI themes
+- **Two-tier settings** — Global `~/.pick/settings.json` merged with project `.pick/settings.json`
+- **Auto-update** — Built-in update mechanism via `pick update`
+- **Session export** — Export conversations to HTML
+- **Cross-platform** — Windows, macOS, Linux
+
+## Architecture
+
+```text
+pick-tui (no deps on other pick crates)
+    ↑
+pick-ai  (no deps on other pick crates)
+    ↑
+pick-agent (depends on pick-ai, pick-tui)
+    ↑
+pick-cli (binary, depends on all) — produces `pick` executable
+pick-mcp (MCP protocol)
+pick-sandbox (process isolation)
+```
+
+- **pick-ai** — Unified multi-provider LLM abstraction with provider registry pattern
+- **pick-agent** — Agent loop, tool system, session/JSONL storage, extension loader
+- **pick-tui** — Crossterm-based terminal UI with custom differential rendering engine
+- **pick-cli** — CLI binary, argument parsing, settings, auth, all run modes
+- **pick-mcp** — Model Context Protocol client (stdio, SSE, streamable HTTP)
+- **pick-sandbox** — Platform-specific process isolation (Windows Job Objects, Linux bwrap, macOS Seatbelt)
+
+## Installation
+
+### Linux / macOS
+
+```bash
+curl -fsSL https://github.com/vividcodeai/pick/releases/latest/download/install.sh | sh
+```
+
+### Windows (PowerShell)
+
+```powershell
+irm https://github.com/vividcodeai/pick/releases/latest/download/install.ps1 | iex
+```
+
+### From source
+
+```bash
+git clone https://github.com/vividcodeai/pick.git
+cd pick
+cargo build --release
+./target/release/pick --help
+```
+
+## Quick Start
+
+```bash
+# Start TUI (default mode)
+pick
+
+# Start with a specific model and provider
+pick -m claude-sonnet-4-20250514 -p anthropic
+
+# One-shot question (print mode)
+pick -P "What does this project do?"
+
+# Interactive REPL mode
+pick --mode interactive
+
+# Resume a previous session
+pick -s <session-id>
+
+# List available models
+pick --list-models
+
+# Plan mode (read-only research before making changes)
+pick --agent-mode plan -P "How should I refactor this?"
+```
+
+## Configuration
+
+Settings are stored in two tiers:
+
+- **Global**: `~/.pick/settings.json`
+- **Project**: `.pick/settings.json` (project-local, overrides global)
+
+Example `.pick/settings.json`:
+
+```json
+{
+  "default_provider": "anthropic",
+  "default_model": "claude-sonnet-4-20250514",
+  "permission": {
+    "approval_policy": "on_request",
+    "permission_profile": ":workspace"
+  }
+}
+```
+
+## CLI Options
+
+| Flag | Description |
+|------|-------------|
+| `-m, --model` | Model to use |
+| `-p, --provider` | LLM provider |
+| `-s, --session` | Resume session by ID |
+| `-r, --resume` | Interactive session selector |
+| `--fork <ID>` | Fork a session |
+| `--mode` | Run mode: tui, interactive, print, json, rpc |
+| `--thinking <LEVEL>` | Thinking level: off, minimal, low, medium, high, xhigh |
+| `-P, --print` | Print mode (batch) |
+| `-e, --extension` | Load extension |
+| `--skill` | Load skill |
+| `--agent-mode` | build or plan |
+| `--list-models` | List available models |
+| `--export <FILE>` | Export session to HTML |
+| `--audit` | View permission audit trail |
+
+## Pros & Cons
+
+**Pros:**
+- Fast, native performance (Rust)
+- Wide LLM provider support
+- Rich TUI with markdown, images, syntax highlighting
+- Session persistence with compaction
+- Plan mode prevents accidental changes
+- Extensible via dynamic libraries and MCP
+- Built-in sandboxing for command execution
+- Granular permission control
+
+**Cons:**
+- Younger project, smaller community
+- Documentation still growing
+- Some features (e.g., sandbox on macOS) require platform-specific setup
+
+## License
+
+MIT

package/bin/pick.js

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+import { createRequire } from "module";
+import { spawn } from "child_process";
+import { existsSync } from "fs";
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+
+const PLATFORM_PACKAGES = {
+  "linux-x64": "@vividcodeai/pick-linux-x64",
+  "linux-arm64": "@vividcodeai/pick-linux-arm64",
+  "darwin-x64": "@vividcodeai/pick-darwin-x64",
+  "darwin-arm64": "@vividcodeai/pick-darwin-arm64",
+  "win32-x64": "@vividcodeai/pick-win32-x64",
+  "win32-arm64": "@vividcodeai/pick-win32-arm64",
+};
+
+const BINARY_NAME = process.platform === "win32" ? "pick.exe" : "pick";
+
+function getTargetTriple(platform, arch) {
+  if (platform === "linux" && arch === "x64") return "x86_64-unknown-linux-gnu";
+  if (platform === "linux" && arch === "arm64") return "aarch64-unknown-linux-gnu";
+  if (platform === "darwin" && arch === "x64") return "x86_64-apple-darwin";
+  if (platform === "darwin" && arch === "arm64") return "aarch64-apple-darwin";
+  if (platform === "win32" && arch === "x64") return "x86_64-pc-windows-msvc";
+  if (platform === "win32" && arch === "arm64") return "aarch64-pc-windows-msvc";
+  return null;
+}
+
+function main() {
+  const platform = process.platform;
+  const arch = process.arch;
+  const mapKey = `${platform}-${arch}`;
+  const pkgName = PLATFORM_PACKAGES[mapKey];
+
+  if (!pkgName) {
+    console.error(`Unsupported platform: ${platform} ${arch}`);
+    process.exit(1);
+  }
+
+  let pkgPath;
+  try {
+    pkgPath = dirname(require.resolve(`${pkgName}/package.json`));
+  } catch {
+    console.error(
+      `Platform package ${pkgName} not installed. Try: npm install -g ${pkgName}`
+    );
+    process.exit(1);
+  }
+
+  const binaryPath = join(pkgPath, "vendor", BINARY_NAME);
+  if (!existsSync(binaryPath)) {
+    console.error(`Binary not found at ${binaryPath}`);
+    process.exit(1);
+  }
+
+  const child = spawn(binaryPath, process.argv.slice(2), {
+    stdio: "inherit",
+    env: process.env,
+  });
+
+  child.on("exit", (code) => process.exit(code));
+}
+
+main();

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "@vividcodeai/pick",
-  "version": "0.0.2-test",
+  "version": "0.1.6",
+  "description": "Pick CLI - An AI coding assistant that runs locally on your computer",
   "license": "MIT",
-  "files": []
+  "bin": {
+    "pick": "bin/pick.js"
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=16"
+  },
+  "files": [
+    "bin/pick.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vividcode-ai/pick.git",
+    "directory": "npm/pick"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public",
+    "provenance": true
+  },
+  "optionalDependencies": {
+    "@vividcodeai/pick-linux-x64": "npm:@vividcodeai/pick@0.1.6-linux-x64",
+    "@vividcodeai/pick-linux-arm64": "npm:@vividcodeai/pick@0.1.6-linux-arm64",
+    "@vividcodeai/pick-darwin-x64": "npm:@vividcodeai/pick@0.1.6-darwin-x64",
+    "@vividcodeai/pick-darwin-arm64": "npm:@vividcodeai/pick@0.1.6-darwin-arm64",
+    "@vividcodeai/pick-win32-x64": "npm:@vividcodeai/pick@0.1.6-win32-x64",
+    "@vividcodeai/pick-win32-arm64": "npm:@vividcodeai/pick@0.1.6-win32-arm64"
+  }
 }