Skip to main content

From requirements in any format to verified implementation

Project description

intake

From requirements in any format to verified implementation.

Python 3.12+ License: MIT

intake is an open-source CLI tool that acts as a universal bridge between real-world requirements and AI coding agents. It accepts requirements from multiple sources and formats — Jira exports, Confluence pages, PDFs, Markdown, YAML, images, DOCX, free text — and transforms them into a normalized, verifiable spec that any AI agent can consume.

It's not an IDE. It's not an agent. It doesn't generate code. intake is preparation infrastructure: the missing step between "we have some requirements somewhere" and "an agent implements with automatic verification."

intake = Chaotic requirements (N sources, N formats) → Executable spec → Any AI agent

How It Works

INGEST (parsers) → ANALYZE (LLM) → GENERATE (spec files) → VERIFY (acceptance checks) → EXPORT (agent-ready output)

intake processes requirements through a 5-phase pipeline:

  1. Ingest — Parse any input format into normalized ParsedContent
  2. Analyze — LLM extracts structured requirements, detects conflicts, deduplicates
  3. Generate — Produce 6 spec files + spec.lock.yaml
  4. Verify — Run executable acceptance checks against the implementation
  5. Export — Generate agent-ready output (architect, Claude Code, Cursor, generic)

The 6 Spec Files

File Purpose
requirements.md What to build. Functional and non-functional requirements in EARS format.
design.md How to build it. Architecture, interfaces, technical decisions.
tasks.md In what order. Atomic tasks with dependencies.
acceptance.yaml How to verify. Executable checks: commands, patterns, file existence.
context.md Project context for the agent: stack, conventions, current state.
sources.md Full traceability: every requirement mapped to its original source.

Installation

pip install intake-ai-cli

Requires Python 3.12+. The CLI command is intake.

Development Setup

git clone https://github.com/your-org/intake-cli.git
cd intake-cli
pip install -e ".[dev]"

Quick Start

# Check your environment
intake doctor

# Generate a spec from a single source
intake init "OAuth2 authentication system" -s requirements.md

# Generate from multiple sources
intake init "Payments feature" -s jira.json -s confluence.html -s notes.md

# Use a preset for quick configuration
intake init "API gateway" -s reqs.yaml --preset enterprise

# Export for a specific agent
intake init "User endpoint" -s reqs.pdf --format architect

# Quick mode for simple tasks (only context.md + tasks.md)
intake init "Fix login bug" -s notes.txt --mode quick

# Fetch requirements from a URL
intake init "API review" -s https://wiki.company.com/rfc/auth

# List discovered plugins
intake plugins list

# Track task progress
intake task list ./specs/auth-oauth2
intake task update ./specs/auth-oauth2 1 done --note "Implemented and tested"

Supported Input Formats

Format Extensions / Source Parser
Markdown .md Front matter, heading-based sections
Plain text .txt, stdin (-) Paragraph sections, Slack dumps
YAML / JSON .yaml, .yml, .json Structured requirements
PDF .pdf Text + tables via pdfplumber
DOCX .docx Text, tables, headings, metadata via python-docx
Jira export .json (auto-detected) Issues, comments, links, priorities
Confluence export .html (auto-detected) Clean Markdown via BS4 + markdownify
Images .png, .jpg, .webp, .gif LLM vision analysis
URLs http://, https:// Fetches page, converts HTML → Markdown
Slack export .json (auto-detected) Messages, threads, decisions, action items
GitHub Issues .json (auto-detected) Issues, labels, comments, cross-references

Format is auto-detected by file extension and content inspection. Jira, Slack, and GitHub Issues JSON exports are distinguished automatically from generic JSON files. Confluence HTML is distinguished from generic HTML.


Commands

Command Description Status
intake init Generate a spec from requirement sources Available
intake add Add sources to an existing spec (incremental) Available
intake verify Verify implementation against the spec Available
intake export Export spec to agent-ready format Available
intake show Show spec summary Available
intake list List all specs in the project Available
intake diff Compare two spec versions Available
intake doctor Check environment and configuration health Available
intake doctor --fix Auto-fix environment issues (install deps, create config) Available
intake plugins list List all discovered plugins (parsers, exporters) Available
intake plugins check Validate plugin compatibility Available
intake task list List tasks from a spec with current status Available
intake task update Update a task's status (pending/in_progress/done/blocked) Available

Configuration

intake works with zero configuration — only an LLM API key is needed. For customization, create a .intake.yaml:

llm:
  model: claude-sonnet-4
  max_cost_per_spec: 0.50
  temperature: 0.2

project:
  name: my-project
  language: en

spec:
  output_dir: ./specs
  requirements_format: ears    # ears | user-stories | bdd | free
  design_depth: moderate       # minimal | moderate | detailed
  task_granularity: medium     # coarse | medium | fine
  risk_assessment: true
  auto_mode: true              # auto-detect quick/standard/enterprise

export:
  default_format: generic      # architect | claude-code | cursor | kiro | generic

Presets

Skip the config file and use a preset:

intake init "My feature" -s reqs.md --preset minimal      # Fast, cheap, prototyping
intake init "My feature" -s reqs.md --preset standard      # Balanced (default)
intake init "My feature" -s reqs.md --preset enterprise    # Detailed, full traceability

Configuration Priority

CLI flags > .intake.yaml > preset > hardcoded defaults

Examples

See the examples/ directory for ready-to-run scenarios:

Example Description
from-markdown Single Markdown file with OAuth2 requirements
from-jira Jira JSON export with 3 issues
from-scratch Free-text meeting notes
multi-source Combining Markdown + Jira JSON + text notes

Architecture

src/intake/
├── cli.py                  # Click CLI — thin adapter, no logic
├── config/                 # Pydantic v2 models, presets, layered loader
│   ├── schema.py           #   7 config models (LLM, Project, Spec, Verification, Export, Security, Connectors)
│   ├── presets.py           #   minimal / standard / enterprise presets
│   ├── loader.py            #   Layered merge: defaults → preset → YAML → CLI
│   └── defaults.py          #   Centralized constants
├── plugins/                # Plugin system (v0.2.0)
│   ├── protocols.py         #   V2 protocols: ParserPlugin, ExporterPlugin, ConnectorPlugin
│   ├── discovery.py         #   Entry point scanning via importlib.metadata
│   └── hooks.py             #   Pipeline hook system (HookManager)
├── connectors/             # Connector infrastructure (Phase 2 prep)
│   └── base.py              #   ConnectorRegistry, ConnectorError
├── ingest/                 # Phase 1 — 11 parsers, registry, auto-detection
│   ├── base.py              #   ParsedContent dataclass + Parser Protocol
│   ├── registry.py          #   Auto-detection + plugin discovery + parser dispatch
│   ├── markdown.py          #   .md with YAML front matter
│   ├── plaintext.py         #   .txt, stdin, Slack dumps
│   ├── yaml_input.py        #   .yaml/.yml/.json structured input
│   ├── pdf.py               #   .pdf via pdfplumber
│   ├── docx.py              #   .docx via python-docx
│   ├── jira.py              #   Jira JSON exports (API + list format)
│   ├── confluence.py        #   Confluence HTML via BS4 + markdownify
│   ├── image.py             #   Image analysis via LLM vision
│   ├── url.py               #   HTTP/HTTPS URLs via httpx + markdownify
│   ├── slack.py             #   Slack workspace export JSON
│   └── github_issues.py     #   GitHub Issues JSON
├── analyze/                # Phase 2 — LLM orchestration (async)
│   ├── analyzer.py          #   Orchestrator: extraction → dedup → risk → design
│   ├── prompts.py           #   3 system prompts (extraction, risk, design)
│   ├── models.py            #   10 dataclasses for analysis pipeline
│   ├── complexity.py        #   Heuristic complexity classification (quick/standard/enterprise)
│   ├── extraction.py        #   LLM JSON → typed AnalysisResult
│   ├── dedup.py             #   Jaccard word similarity deduplication
│   ├── conflicts.py         #   Conflict validation
│   ├── questions.py         #   Open question validation
│   ├── risks.py             #   Risk assessment parsing
│   └── design.py            #   Design output parsing (tasks, checks)
├── generate/               # Phase 3 — Jinja2 template rendering
│   ├── spec_builder.py      #   Orchestrates 6 spec files + lock
│   ├── adaptive.py          #   AdaptiveSpecBuilder — mode-aware file selection
│   └── lock.py              #   spec.lock.yaml for reproducibility
├── verify/                 # Phase 4 — Acceptance check engine
│   ├── engine.py           #   4 check types: command, files_exist, pattern_*
│   └── reporter.py         #   Terminal (Rich), JSON, JUnit XML reporters
├── export/                 # Phase 5 — Agent-ready output
│   ├── base.py             #   Exporter Protocol
│   ├── registry.py         #   Plugin discovery + format-based dispatch
│   ├── architect.py        #   pipeline.yaml generation
│   └── generic.py          #   SPEC.md + verify.sh generation
├── diff/                   # Spec comparison
│   └── differ.py           #   Compare two specs by requirement/task IDs
├── doctor/                 # Environment health checks
│   └── checks.py            #   Python, API keys, deps, config validation
├── llm/                    # LiteLLM wrapper (used by analyze/ only)
│   └── adapter.py           #   Async completion, retry, cost tracking, budget
├── templates/              # Jinja2 templates for spec generation
│   ├── requirements.md.j2   #   FR, NFR, conflicts, open questions
│   ├── design.md.j2         #   Components, files, tech decisions
│   ├── tasks.md.j2          #   Task summary + status + detailed sections
│   ├── acceptance.yaml.j2   #   Executable acceptance checks
│   ├── context.md.j2        #   Project context for agents
│   └── sources.md.j2        #   Source traceability mapping
└── utils/                  # Shared utilities
    ├── file_detect.py       #   Extension-based format detection
    ├── project_detect.py    #   Auto-detect tech stack from project files
    ├── source_uri.py        #   URI parsing (jira://, github://, http://, files, text)
    ├── task_state.py         #   Task status tracking in tasks.md
    ├── cost.py              #   Cost accumulation with per-phase breakdown
    └── logging.py           #   structlog configuration

Key design principles:

  • Protocol over ABC — All extension points use typing.Protocol
  • Plugin-first architecture — Parsers and exporters discovered via entry points, manual fallback
  • Dataclasses for pipeline data, Pydantic for config — Never mixed
  • Async only in analyze/ — Everything else is synchronous
  • Offline mode — Parsing, verification, export, diff, doctor all work without LLM
  • Adaptive generation — Complexity auto-detection selects quick/standard/enterprise mode
  • No magic strings — All constants defined explicitly
  • Budget enforcement — LLM cost tracked per call with configurable limits

Integration

With architect

intake init "Auth system" -s reqs.md --format architect
architect pipeline specs/auth-system/pipeline.yaml

With Claude Code

intake init "Payments" -s reqs.pdf --format claude-code
# Generates CLAUDE.md + tasks + verify.sh

With CI/CD

# GitHub Actions
- name: Verify spec compliance
  run: |
    pip install intake-ai-cli
    intake verify specs/auth-system/ -p . --format junit

Development

# Run tests
python -m pytest tests/ -v

# Run tests with coverage
python -m pytest tests/ --cov=intake --cov-report=term-missing

# Lint
ruff check src/ tests/

# Format
ruff format src/ tests/

# Type check (strict)
mypy src/ --strict

Current test suite: 492 tests, 86% coverage, 0 mypy --strict errors, 0 ruff warnings.

Implementation Status

Phase Module Status
Phase 1 — Ingest ingest/ (11 parsers + plugin-based registry) Implemented
Phase 2 — Analyze analyze/ (orchestrator + 7 sub-modules + complexity) Implemented
Phase 3 — Generate generate/ (spec builder + adaptive builder + 6 templates + lock) Implemented
Phase 4 — Verify verify/ (engine + 3 reporters) Implemented
Phase 5 — Export export/ (architect + generic + plugin registry) Implemented
Plugins plugins/ (protocols + discovery + hooks) Implemented
Connectors connectors/ (registry infrastructure, no concrete connectors) Implemented
Standalone doctor/, config/, llm/, utils/ Implemented
Standalone diff/ (spec differ) Implemented
CLI 13 commands/subcommands wired end-to-end Implemented

Model Support

intake uses LiteLLM for LLM abstraction, supporting 100+ models:

  • Anthropic: Claude Sonnet, Claude Opus, Claude Haiku
  • OpenAI: GPT-4o, GPT-4, GPT-3.5
  • Google: Gemini Pro, Gemini Flash
  • Local models: Ollama, vLLM, etc.

Set your API key:

export ANTHROPIC_API_KEY=sk-ant-...
# or
export OPENAI_API_KEY=sk-...

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intake_ai_cli-0.2.0.tar.gz (190.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intake_ai_cli-0.2.0-py3-none-any.whl (114.9 kB view details)

Uploaded Python 3

File details

Details for the file intake_ai_cli-0.2.0.tar.gz.

File metadata

  • Download URL: intake_ai_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 190.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for intake_ai_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2083034fa22eccd84577cf40d8a5645a79fca924173d4d277c5d7c8f6a0055fa
MD5 2d96e4fba1f1f3f30c90293ea6a628c9
BLAKE2b-256 f9411a87108aab34fb3399b4c534b93106d45ea0baaa78ba621f253d95f70a0b

See more details on using hashes here.

File details

Details for the file intake_ai_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: intake_ai_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 114.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for intake_ai_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fde3ef733335fb7bb6e151b7447bdc74a4af46cdaff56a793d453189b8ac4213
MD5 2bf7248301e8f69b798911ffe294a2e8
BLAKE2b-256 8fd4ea31e17977cf8aa99b14b32aadec6a53ce05938db7703fc684e87cf19053

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page