weld-cli 0.4.0

Human-in-the-loop coding harness: plan, review, iterate, commit with transcript provenance

Human-in-the-loop coding harness with transcript provenance

Weld generates structured prompts for AI-assisted development workflows. Instead of ad-hoc prompting, weld provides templates for: research → plan → implement → review → commit.

Why Weld?

• Structured Prompts: Generate focused prompts for research, planning, and review
• Full Auditability: Every AI interaction linked via transcript gists in commits
• Codebase Discovery: Analyze existing codebases before making changes
• Spec Refinement: Interview-style Q&A to improve specifications

Spec Doc  -->  Research Prompt  -->  Plan Prompt  -->  Review  -->  Commit
                                                                  + transcript

Table of Contents

• Quickstart
• Installation
• Workflow Overview
• Commands Reference
• Configuration
• Developer Guide
• Exit Codes
• Requirements

---

Quickstart

Get running in under 5 minutes:

# 1. Install weld globally
uv tool install weld-cli    # or: pipx install weld-cli

# 2. Initialize in your project
cd /path/to/your-project
weld init

# 3. Check your environment
weld doctor

# 4. Research a specification (generates prompt, runs Claude)
weld research specs/my-feature.md -o research.md

# 5. Generate a plan from your spec
weld plan specs/my-feature.md -o plan.md

# 6. Execute the plan interactively
weld implement plan.md

# 7. Review a document against the codebase
weld review plan.md --apply

# 8. Review code changes before committing
weld review --diff --staged

# 9. Commit with transcript provenance (auto-generates message)
weld commit --all

---

Installation

Prerequisites

• Python 3.11+
• uv or pipx - For global CLI installation
• git - Version control
• gh - GitHub CLI (authenticated)
• claude - Claude Code CLI (AI provider)
• claude-code-transcripts - For transcript gist generation (optional)

Install from PyPI (Recommended)

Install weld as a global CLI tool:

# Using uv (recommended)
uv tool install weld-cli

# Or using pipx
pipx install weld-cli

# Verify installation
weld --help

Now weld is available system-wide. Use it in any project:

cd /path/to/your-project
weld init
weld doctor

Verify Toolchain

# Check all required dependencies
weld doctor

This validates:

• Required: git, gh (GitHub CLI authenticated)
• Optional: claude, claude-code-transcripts

Install from Source (Development)

For contributing to weld or running the latest unreleased code:

git clone https://github.com/ametel01/weld-cli.git && cd weld-cli

# Option 1: Install globally from source
uv tool install .

# Option 2: Development setup with editable install
make setup
eval $(make venv-eval)
weld --help

---

Workflow Overview

Weld provides prompts for a structured development workflow:

1. Discovery (optional)  | Analyze existing codebase architecture
2. Interview (optional)  | Refine specification through Q&A
3. Research              | Deep dive into implementation approach
4. Planning              | Generate step-by-step implementation plan
5. Implement             | Execute plan steps interactively
6. Review                | Validate documents against codebase
7. Commit                | Create commit with transcript link

Key Concepts

• Prompt Generation: Weld creates structured prompts that you run in Claude Code
• History Tracking: Commands log their inputs/outputs to .weld/<command>/history.jsonl
• Transcript: A Claude Code session record, published as a GitHub gist and linked in commit messages

---

Commands Reference

Global Options

All commands support these global options:

Option	Short	Description
--version	-V	Show version and exit
--verbose	-v	Increase verbosity (-v for verbose, -vv for debug)
--quiet	-q	Suppress non-error output
--json		Output in JSON format for automation
--no-color		Disable colored output
--dry-run		Preview effects without applying changes
--debug		Enable file-based debug logging to .weld/debug.log

---

weld init

Initialize weld in the current git repository.

weld init

Creates:

• .weld/config.toml - Configuration file

Exit codes:

• 0 - Success
• 2 - Missing or unauthenticated tool
• 3 - Not a git repository

---

weld plan <input> [--output <path>]

Generate an implementation plan from a specification.

weld plan specs/feature.md                     # Writes to .weld/plan/feature-{timestamp}.md
weld plan specs/feature.md --output plan.md    # Explicit output path
weld plan specs/feature.md -o plan.md --quiet  # Suppress streaming

Options:

• --output, -o - Path to write the plan (optional, defaults to .weld/plan/)
• --quiet, -q - Suppress streaming output

The command:

1. Reads the specification file
2. Generates a planning prompt
3. Runs Claude to create the plan
4. Writes the result to the output file

Plan Format

Plans follow a hierarchical Phase → Step structure:

## Phase 1: <Title>

Brief description of what this phase accomplishes.

### Phase Validation
\`\`\`bash
# Command(s) to verify the entire phase is complete
\`\`\`

### Step 1: <Title>

#### Goal
What this step accomplishes.

#### Files
- `path/to/file.py` - What changes to make

#### Validation
\`\`\`bash
# Command to verify this step works
\`\`\`

#### Failure modes
- What could go wrong and how to detect it

---

### Step 2: <Title>
...

## Phase 2: <Title>

### Step 1: <Title>
(Step numbers restart at 1 for each phase)
...

Phase guidelines:

• Each phase is a logical milestone (e.g., "Data Models", "Core Logic", "CLI Integration")
• Phases are incremental - each builds on the foundation of previous phases
• Include Phase Validation to verify the entire phase works before moving on

Step guidelines:

• Step numbers restart at 1 within each phase
• Each step should be atomic and independently verifiable
• Include specific file paths and validation commands

---

weld implement <plan>

Interactively execute a phased implementation plan.

weld implement plan.md                # Interactive menu to select phase/step
weld implement plan.md --phase 2      # Start at phase 2
weld implement plan.md --step 3       # Start at step 3 of current phase
weld implement plan.md --phase 2 --step 1  # Non-interactive: specific step

Options:

• --phase, -p - Start at a specific phase number
• --step, -s - Start at a specific step number
• --quiet, -q - Suppress streaming output

Features:

• Interactive mode: Arrow-key navigable menu for selecting phases/steps
• Non-interactive mode: Use --phase and --step flags for CI/automation
• Progress tracking: Steps are marked complete with [COMPLETE] in the plan file
• Graceful interruption: Ctrl+C preserves progress (completed steps stay marked)

The command:

1. Parses the plan to extract phases and steps
2. Shows an interactive menu (or jumps to specified step)
3. Generates implementation prompts for each step
4. Runs Claude to implement the step
5. Marks the step complete in the plan file

---

weld research <input> [--output <path>]

Research a specification before planning.

weld research specs/feature.md                      # Writes to .weld/research/feature-{timestamp}.md
weld research specs/feature.md --output research.md # Explicit output path
weld research specs/feature.md -o research.md --focus "security concerns"

Options:

• --output, -o - Path to write research (optional, defaults to .weld/research/)
• --focus, -f - Specific areas to focus on
• --quiet, -q - Suppress streaming output

The research prompt guides Claude to analyze:

• Architecture and existing patterns
• Dependencies and integration points
• Risks and open questions

---

weld discover [--output <path>]

Analyze codebase and generate architecture documentation.

weld discover                                  # Writes to .weld/discover/{timestamp}.md
weld discover --output docs/architecture.md    # Explicit output path
weld discover -o docs/arch.md --focus "authentication system"
weld discover --prompt-only                    # Just show the prompt

Options:

• --output, -o - Path to write discover output (optional, defaults to .weld/discover/)
• --focus, -f - Specific areas to focus on
• --prompt-only - Output prompt without running Claude
• --quiet, -q - Suppress streaming output

The discover prompt covers:

• High-level architecture
• Directory structure
• Key files and entry points
• Testing patterns
• Security considerations

---

weld discover show

Show a previously generated discover prompt.

weld discover show

---

weld interview <file>

Refine a specification through interactive Q&A.

weld interview specs/feature.md
weld interview specs/feature.md --focus "edge cases"

Options:

• --focus, -f - Topic to focus questions on

Outputs a prompt for Claude Code that:

1. Asks in-depth questions using the AskUserQuestion tool
2. Covers implementation, UI/UX, edge cases, tradeoffs
3. Rewrites the specification when complete

---

weld review [<file>] [--diff] [--apply]

Review documents or code changes.

Document review (verifies docs against codebase):

weld review plan.md                    # Review document accuracy
weld review plan.md --apply            # Apply corrections in place
weld review plan.md --focus "security" # Focus review on specific topic
weld review research.md --prompt-only  # Just show the prompt

Code review (reviews git diff for issues):

weld review --diff                     # Review all uncommitted changes
weld review --diff --staged            # Review only staged changes
weld review --diff --apply             # Review and fix all issues directly
weld review --diff --focus "error handling"  # Focus review on specific topic
weld review --diff --prompt-only       # Generate prompt without running

Options:

• --diff, -d - Review git diff instead of a document
• --staged, -s - Review only staged changes (requires --diff)
• --focus, -f - Topic to focus the review on
• --apply - Apply corrections/fixes directly
• --prompt-only - Output prompt without running Claude
• --quiet, -q - Suppress streaming output
• --timeout, -t - Timeout in seconds for Claude (default: 1800 from config)

Document reviews check for:

• Errors and inaccuracies
• Missing implementations
• Gaps in coverage
• Wrong evaluations

Code reviews check for:

• Bugs and logic errors
• Security vulnerabilities
• Missing implementations
• Test issues (assertions, coverage)
• Significant improvements needed

---

weld commit [--all] [--no-split]

Auto-generate commit message(s) from diff, update CHANGELOG, and commit with transcript.

Automatically analyzes the diff and creates multiple logical commits when appropriate (e.g., separating typo fixes from version updates from documentation changes).

weld commit --all               # Stage all changes, auto-split into logical commits
weld commit                     # Commit only staged changes
weld commit --no-split          # Force single commit (disable auto-split)
weld commit --edit              # Review/edit commit message in $EDITOR
weld commit --skip-transcript   # Skip transcript generation
weld commit --skip-changelog    # Skip CHANGELOG.md update

Options:

• --all, -a - Stage all changes before committing
• --no-split - Force single commit (disable automatic splitting)
• --edit, -e - Edit generated message in $EDITOR before commit
• --skip-transcript - Skip transcript generation
• --skip-changelog - Skip CHANGELOG.md update
• --quiet, -q - Suppress Claude streaming output

The final commit message includes a transcript trailer:

Implement user auth

Claude-Transcript: https://gist.github.com/...

Exit codes:

• 0 - Committed
• 1 - Weld not initialized
• 20 - No changes to commit
• 21 - Claude failed to generate message
• 22 - Git commit failed
• 23 - Failed to parse Claude response
• 24 - Editor error

---

weld doctor

Check environment and dependencies.

weld doctor

Validates:

• Required tools: git, gh (GitHub CLI)
• Optional tools: claude, claude-code-transcripts

Exit codes:

• 0 - All required dependencies available
• 2 - Required dependencies missing

---

Configuration

Configuration lives in .weld/config.toml:

[project]
name = "your-project"

[claude]
exec = "claude"          # Claude CLI path
model = "claude-sonnet-4-20250514"  # Default model (optional)
timeout = 1800           # Timeout in seconds for AI operations (30 min default)

[claude.transcripts]
exec = "claude-code-transcripts"
visibility = "secret"    # or "public"

[git]
commit_trailer_key = "Claude-Transcript"

---

Developer Guide

Architecture

Weld follows a simple layered architecture:

src/weld/
├── cli.py              # Typer app entry point, global options
├── config.py           # Configuration management
├── output.py           # Console output formatting
├── logging.py          # Logging configuration
├── validation.py       # Input validation
│
├── commands/           # CLI command modules
│   ├── init.py         # weld init
│   ├── plan.py         # weld plan
│   ├── implement.py    # weld implement
│   ├── research.py     # weld research
│   ├── discover.py     # weld discover
│   ├── interview.py    # weld interview
│   ├── doc_review.py   # weld review
│   ├── commit.py       # weld commit
│   └── doctor.py       # weld doctor
│
├── core/               # Business logic
│   ├── history.py      # JSONL command history tracking
│   ├── weld_dir.py     # .weld directory utilities
│   ├── plan_parser.py  # Plan parsing and completion tracking
│   ├── discover_engine.py    # Codebase discovery prompts
│   ├── interview_engine.py   # Specification refinement
│   └── doc_review_engine.py  # Document review prompts
│
├── services/           # External integrations
│   ├── git.py          # Git operations
│   ├── claude.py       # Claude CLI integration
│   ├── transcripts.py  # Transcript gist generation
│   └── filesystem.py   # File system operations
│
└── models/             # Pydantic data models
    ├── discover.py     # DiscoverMeta
    └── issues.py       # Issue, Issues

Key Design Patterns

• Commands delegate to core: commands/*.py handle CLI parsing, then call core/*.py for logic
• Services wrap external CLIs: All subprocess calls go through services/ (never shell=True)
• JSONL history: Each command logs to .weld/<command>/history.jsonl

Project Structure

weld-cli/
├── pyproject.toml      # Package configuration
├── Makefile            # Build automation
├── src/
│   └── weld/           # Main package
├── tests/              # Test suite
│   ├── conftest.py     # Pytest fixtures
│   ├── test_cli.py
│   ├── test_claude.py
│   ├── test_history.py
│   └── ...
└── .weld/              # Created per-project
    ├── config.toml
    ├── debug.log       # Debug log (with --debug)
    ├── plan/
    │   └── history.jsonl
    ├── research/
    │   └── history.jsonl
    ├── discover/
    │   └── history.jsonl
    └── reviews/        # Backup of reviewed docs

Data Models

DiscoverMeta

Metadata for discover artifacts.

class DiscoverMeta(BaseModel):
    discover_id: str
    created_at: datetime
    focus: list[str]

Issues

Review result from AI provider.

class Issue(BaseModel):
    severity: Literal["blocker", "major", "minor"]
    file: str
    hint: str

class Issues(BaseModel):
    pass_: bool = Field(alias="pass")
    issues: list[Issue]

Development Commands

# Essential commands
make setup          # First-time setup
make check          # All quality checks
make test           # Run tests
make ci             # Full CI pipeline

# Testing
make test-unit      # Unit tests only
make test-cli       # CLI integration tests
make test-cov       # Tests with coverage

# Code quality
make lint-fix       # Auto-fix linting
make format         # Format code
make typecheck      # Run pyright

---

Exit Codes

Code	Meaning
0	Success
1	General error / file not found / weld not initialized
2	Dependency missing / unauthenticated gh
3	Not a git repository
12	AI provider invocation failed
20	No changes to commit
21	Transcript generation failed
22	Git commit failed

---

Requirements

For using weld:

• Python 3.11+
• uv or pipx (for global installation)
• git
• gh (GitHub CLI, authenticated)
• claude (Claude Code CLI)

Python dependencies (installed automatically):

• typer, rich - CLI framework
• pydantic - Data validation
• simple-term-menu - Interactive menus for weld implement

Optional:

• claude-code-transcripts (for transcript gist generation)

For development:

• make (build automation)
• uv (package manager)

---

License

See LICENSE for details.