docs(guides): restore CLI-USAGE and README from origin/main
These files were accidentally deleted in commit 926a82db.
CLI-USAGE.md contains essential terminal-only usage documentation.
README.md provides the index for all guides.
Co-Authored-By: Claude Opus 4.6 <[email protected]>
This commit is contained in:
co-authored by
Claude Opus 4.6
parent
fbe1b74cbc
commit
8b47b538f3
+5
-33
@@ -74,16 +74,16 @@ All commands below should be run from the `apps/backend/` directory:
|
||||
source .venv/bin/activate
|
||||
|
||||
# Create a spec interactively
|
||||
python runners/spec_runner.py --interactive
|
||||
python spec_runner.py --interactive
|
||||
|
||||
# Or with a task description
|
||||
python runners/spec_runner.py --task "Add user authentication with OAuth"
|
||||
python spec_runner.py --task "Add user authentication with OAuth"
|
||||
|
||||
# Force a specific complexity level
|
||||
python runners/spec_runner.py --task "Fix button color" --complexity simple
|
||||
python spec_runner.py --task "Fix button color" --complexity simple
|
||||
|
||||
# Continue an interrupted spec
|
||||
python runners/spec_runner.py --continue 001-feature
|
||||
python spec_runner.py --continue 001-feature
|
||||
```
|
||||
|
||||
### Complexity Tiers
|
||||
@@ -182,35 +182,7 @@ python validate_spec.py --spec-dir specs/001-feature --checkpoint all
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Copy `.env.example` to `.env` and configure as needed:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
### Core Settings
|
||||
|
||||
| Variable | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `CLAUDE_CODE_OAUTH_TOKEN` | Yes | OAuth token from `claude setup-token` |
|
||||
| `AUTO_BUILD_MODEL` | No | Model override (default: claude-opus-4-6) |
|
||||
| `DEFAULT_BRANCH` | No | Base branch for worktrees (auto-detects main/master) |
|
||||
| `DEBUG` | No | Enable debug logging (default: false) |
|
||||
|
||||
### Integrations
|
||||
|
||||
| Variable | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `LINEAR_API_KEY` | No | Linear API key for task sync |
|
||||
| `GITLAB_TOKEN` | No | GitLab Personal Access Token |
|
||||
| `GITLAB_INSTANCE_URL` | No | GitLab instance URL (defaults to gitlab.com) |
|
||||
|
||||
### Memory Layer (Graphiti)
|
||||
|
||||
| Variable | Required | Description |
|
||||
|----------|----------|-------------|
|
||||
| `GRAPHITI_ENABLED` | No | Enable Memory Layer (default: true) |
|
||||
| `GRAPHITI_LLM_PROVIDER` | No | LLM provider: openai, anthropic, ollama, google, openrouter |
|
||||
| `GRAPHITI_EMBEDDER_PROVIDER` | No | Embedder: openai, voyage, ollama, google, openrouter |
|
||||
|
||||
See `.env.example` for complete configuration options including provider-specific settings.
|
||||
| `AUTO_BUILD_MODEL` | No | Model override (default: claude-opus-4-5-20251101) |
|
||||
|
||||
@@ -7,8 +7,6 @@ Detailed documentation for Auto Claude setup and usage.
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| **[CLI-USAGE.md](CLI-USAGE.md)** | Terminal-only usage for power users, headless servers, and CI/CD |
|
||||
| **[windows-development.md](windows-development.md)** | Windows-specific development guide (file encoding, paths, line endings) |
|
||||
| **[linux.md](linux.md)** | Linux-specific installation and build guide (Flatpak, AppImage) |
|
||||
|
||||
## Quick Links
|
||||
|
||||
|
||||
Reference in New Issue
Block a user