diff --git a/PRD.md b/docs/historical/PRD.md similarity index 76% rename from PRD.md rename to docs/historical/PRD.md index 09a7017..e5289e7 100644 --- a/PRD.md +++ b/docs/historical/PRD.md @@ -1,4 +1,8 @@ -# QuickRunner PRD +# QuickRunner PRD (historical) + +> **Status:** Internal product-requirements notes from early development. For shipped +> behavior, install steps, and config, use [`README.md`](../../README.md) as the source +> of truth. This file is kept for design context only. ## Overview @@ -16,7 +20,7 @@ QuickRunner (`qr`) is a blazing-fast, AI-augmented CLI tool that takes natural l | Component | Choice | Rationale | |---|---|---| | Language | **Rust** | Speed, safety, single binary distribution, great CLI ecosystem (clap, crossterm) | -| AI Backend | **OpenAI-compatible + Anthropic-compatible** | User wires in any endpoint (FirePass, Cerebras, local, whatever) | +| AI Backend | **OpenAI-compatible + Anthropic-compatible** | User wires in any endpoint (proxy, local Ollama, cloud provider, etc.) | | Config format | TOML | Rust-native, human-readable | | Config override | Environment variables | Every config key has a `QR_` env var equivalent for cloud shells | @@ -43,8 +47,8 @@ Every subcommand has a 1-letter alias for speed: | `qr stats` | `qr s` | Stats | | `qr scan` | `qr x` | Rescan projects | | `qr init` | `qr i` | First-time setup | -| `qr do` | `qr d` | Natural language → router (v2) | -| `qr learn` | `qr l` | Learn current project (v2) | +| `qr do` | `qr d` | Natural language → router | +| `qr learn` | `qr l` | Learn current project | ## Features @@ -53,12 +57,12 @@ Every subcommand has a 1-letter alias for speed: Navigate to a project directory by fuzzy name. ``` -$ qr go orion -→ cd /Users/aanish/Development/orion-app +$ qr go demo +→ cd ~/projects/demo-app ``` **How it works:** -- On setup, user configures one or more project root directories (e.g., `~/Development`, `/Volumes/Delos/Development`) +- On setup, user configures one or more project root directories (e.g., `~/projects`, `/workspace`) - An hourly cron job (or on-demand `qr scan`) walks those directories up to `scan_depth` - Detection heuristic (in priority order): 1. `.git` present → project. Extract canonical name from git remote origin URL if available, fall back to directory name @@ -71,7 +75,7 @@ $ qr go orion **Config example:** ```toml [projects] -roots = ["~/Development", "/Volumes/Delos/Development"] +roots = ["~/projects", "/workspace"] scan_depth = 2 # how deep to look for project dirs ``` @@ -81,22 +85,22 @@ scan_depth = 2 # how deep to look for project dirs - Multiple matches → interactive picker - No match → "No project matching '' found. Run `qr scan` to refresh." -### 2. Script Runner — `qr run