specrails-core 5.5.1 → 6.0.0

package/docs/deployment.md

@@ -1,234 +0,0 @@
-# Deployment
-
-SpecRails runs locally — no cloud infrastructure required. Choose the setup that fits your workflow.
-
-## Options at a glance
-
-| Option | Best for | Setup time |
-|--------|----------|------------|
-| [Plugin](#plugin-recommended) | Quick start, individual developers | ~1 minute |
-| [Local (npx)](#local-npx) | Any supported provider, full offline control | ~2 minutes |
-| [Local (git clone)](#local-git-clone) | Customization, contributing | ~5 minutes |
-| [Docker](#docker) | Reproducible environments, teams | ~5 minutes |
-| [CI/CD](#cicd-github-actions) | Automated workflows, GitHub Actions | ~10 minutes |
-
----
-
-## Plugin (recommended)
-
-The fastest way to get started. No Node.js required.
-
-```bash
-claude plugin install sr
-/specrails:setup
-```
-
-**Requirements:** Claude Code, git
-
----
-
-## Local — npx
-
-For Claude Code, Codex CLI, Gemini CLI, or Kimi Code users who need full
-control over agent files.
-
-```bash
-npx specrails-core@latest init --root-dir .
-```
-
-This will:
-1. Scaffold a `.claude/` directory in your project
-2. Install agent templates and the `/specrails:setup` wizard
-
-After install, open Claude Code or Codex and run `/specrails:setup` to configure.
-
-**Requirements:** Node.js ≥20.19.0 and one supported AI CLI
-
----
-
-## Local — git clone
-
-Clone the repository for full control and the ability to customize agents.
-
-```bash
-git clone https://github.com/fjpulidop/specrails-core
-cd specrails-core
-npm install
-npm run build
-node bin/specrails-core.mjs init --root-dir <your-project>
-```
-
-### Updating
-
-```bash
-git pull origin main
-npm install
-```
-
-See [Updating](./updating.md) for details on preserving local customizations during updates.
-
----
-
-## Docker
-
-Run SpecRails in a container for portable, reproducible environments.
-
-### Quick start
-
-```bash
-docker run -it \
-  -e ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \
-  -v $(pwd):/workspace \
-  ghcr.io/specrails-ai/specrails:latest \
-  setup
-```
-
-### docker-compose
-
-Create a `docker-compose.yml` in your project root:
-
-```yaml
-services:
-  specrails:
-    image: ghcr.io/specrails-ai/specrails:latest
-    environment:
-      - ANTHROPIC_API_KEY=${ANTHROPIC_API_KEY}
-    volumes:
-      - .:/workspace
-    working_dir: /workspace
-```
-
-Then run:
-
-```bash
-docker compose run specrails setup
-```
-
-### Building locally
-
-```bash
-git clone https://github.com/fjpulidop/specrails-core
-cd specrails-core
-docker build -t specrails:local .
-docker run -it \
-  -e ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \
-  -v $(pwd):/workspace \
-  specrails:local setup
-```
-
----
-
-## CI/CD — GitHub Actions
-
-Automate SpecRails workflows in your GitHub Actions pipeline.
-
-### Prerequisites
-
-1. Add `ANTHROPIC_API_KEY` to your repository secrets
-2. (Optional) Add `GITHUB_TOKEN` with write access for PR creation
-
-### Basic workflow
-
-```yaml
-# .github/workflows/specrails.yml
-name: SpecRails AI Review
-
-on:
-  pull_request:
-    types: [opened, synchronize]
-
-jobs:
-  review:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.19.0'
-
-      - name: Install SpecRails
-        run: npm install -g specrails
-
-      - name: Run AI review
-        env:
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: specrails review --pr ${{ github.event.pull_request.number }}
-```
-
-### Scheduled batch implementation
-
-```yaml
-name: SpecRails Batch Implement
-
-on:
-  schedule:
-    - cron: '0 9 * * 1-5'   # Weekdays at 9am UTC
-  workflow_dispatch:
-
-jobs:
-  implement:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.19.0'
-
-      - name: Install SpecRails
-        run: npm install -g specrails
-
-      - name: Run batch implementation
-        env:
-          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: specrails sr:batch-implement --max 3
-```
-
----
-
-## Environment variables
-
-| Variable | Required | Description |
-|----------|----------|-------------|
-| `ANTHROPIC_API_KEY` | Yes | Your Claude API key |
-| `GITHUB_TOKEN` | For PR creation | GitHub personal access token or Actions token |
-| `SPECRAILS_LOG_LEVEL` | No | `debug`, `info` (default), `warn`, `error` |
-| `SPECRAILS_MODEL` | No | Override default model (e.g. `claude-opus-4-8`) |
-
----
-
-## Troubleshooting
-
-### Permission errors on macOS
-
-```bash
-sudo npm install -g specrails
-# or use a node version manager (nvm, volta) to avoid sudo
-```
-
-### Docker volume permissions
-
-If agents cannot write files inside the container:
-
-```bash
-docker run -it \
-  --user $(id -u):$(id -g) \
-  -v $(pwd):/workspace \
-  ghcr.io/specrails-ai/specrails:latest
-```
-
-### API key not found
-
-Ensure `ANTHROPIC_API_KEY` is exported in your shell:
-
-```bash
-export ANTHROPIC_API_KEY=sk-ant-...
-# Add to ~/.zshrc or ~/.bashrc to persist
-```

package/docs/getting-started.md

@@ -1,122 +0,0 @@
-# Getting Started
-
-Get SpecRails running in your project in under 5 minutes.
-
-## What is SpecRails?
-
-SpecRails installs a **product-driven development workflow** into any
-repository. It gives Claude Code, Codex CLI, Gemini CLI, or Kimi Code a team of
-specialized AI roles — an architect, developers, layer reviewers, a reviewer,
-and a product manager — that work together to go from idea to shipped PR
-automatically.
-
-Think of it as hiring a full engineering team that lives inside your CLI.
-
-## Prerequisites
-
-You need:
-
-- **Git** — your project must be a git repository
-- One supported AI CLI: Claude Code, Codex CLI, Gemini CLI, or Kimi Code
-
-Optional (recommended):
-
-- **[GitHub CLI](https://cli.github.com/)** (`gh`) — for automatic PR creation and issue tracking
-
-See the [Codex guide](user-docs/getting-started-codex.md) or
-[Kimi guide](user-docs/getting-started-kimi.md) for provider-specific setup.
-
-## Install
-
-**Plugin method (recommended) — no Node.js required**
-
-```bash
-claude plugin install sr
-```
-
-**Scaffold method (all providers, or full offline control)**
-
-```bash
-npx specrails-core@latest init --root-dir <your-project>
-```
-
-See [installation.md](installation.md) for full details on both methods and when to use each.
-
-## Installation Tiers
-
-### Quick Install (default via TUI)
-
-When you run `npx specrails-core@latest init`, the TUI installer lets you choose **Quick** tier. This places agents, commands, rules, and settings directly — no AI interaction required:
-
-1. Select agents to install
-2. Choose a model preset
-3. Provide a brief product description
-
-Agents are ready to use immediately after install. Open the selected provider
-CLI and start working.
-
-> Quick install excludes VPC personas and persona-dependent agents/commands (sr-product-manager, sr-product-analyst). These require the full enrichment process.
-
-### Full Install (via `/specrails:enrich`)
-
-For deeper customization, choose **Full** tier or run `/specrails:enrich` after a Quick install:
-
-```
-/specrails:enrich
-```
-
-The full 5-phase wizard provides deep stack analysis, researched user personas, and fully adapted agents:
-
-| Phase | What happens |
-|-------|-------------|
-| **1. Analyze** | Detects your tech stack, architecture layers, CI commands, and conventions |
-| **2. Personas** | Researches your competitive landscape and generates full VPC user personas |
-| **3. Configure** | Asks about your backlog provider, git workflow, and which agents to enable |
-| **4. Generate** | Generates your project data files (`.specrails/`) with project-specific context |
-| **5. Cleanup** | Removes the wizard scaffolding, leaving only your tailored workflow files |
-
-Full install adds VPC personas, sr-product-manager, sr-product-analyst, and persona-dependent commands.
-
-After either tier, your `/specrails:*` commands are live.
-
-## Your first feature
-
-Let's implement something. Pick an issue from your backlog, or describe a feature:
-
-```
-/specrails:implement "add a health check endpoint"
-```
-
-SpecRails will:
-
-1. **Architect** analyzes the request and designs the implementation
-2. **Developer** writes the code across all layers
-3. **Test Writer** generates tests for the new code
-4. **Doc Sync** updates your changelog and docs
-5. **Security Reviewer** scans for secrets and vulnerabilities
-6. **Reviewer** runs your full CI suite and fixes any issues
-7. Creates a **Pull Request** ready for human review
-
-That's it. One command, full pipeline.
-
-## Useful commands for newcomers
-
-Once you have a feature running, a few commands help you understand what's happening and why:
-
-- `/specrails:why "question"` — search agent explanation records in plain language. Ask why a design decision was made, why a library was chosen, or why a particular pattern is used. Agents record their reasoning as they work.
-- `/specrails:get-backlog-specs` — see your prioritized backlog with safe implementation ordering. Good first stop before picking what to build next.
-- `/specrails:compat-check #N` — check whether an issue's implementation would break existing API consumers before you commit to it.
-
-## What's next?
-
-Now that you're running, learn how the system thinks:
-
-- [Core Concepts](concepts.md) — understand the pipeline architecture and product-driven approach
-- [Agents](agents.md) — meet each agent and understand their role
-- [Workflows & Commands](workflows.md) — master the full command set
-
----
-
-**Looking for step-by-step guides?** See [Quick Start](user-docs/quick-start.md) for a walkthrough of your first feature, or [Installation](user-docs/installation.md) for detailed install options including Codex support.
-
-[← Back to Docs](README.md) · [Core Concepts →](concepts.md)