Skip to main content

CLI scaffold generator for spec-driven AI agent documentation

Project description

tx-ai-agent-sdd

tx-ai-agent-sdd bootstraps a spec-driven workspace for AI-assisted software projects. It gives you a ready-to-use documentation skeleton, prompt files, workflow notes, conventions, and input templates.

What the package creates

After installation, tx-ai-agent-sdd init <path> generates:

  • docs/ with core artifacts: idea.md, vision.md, HLD.md, LLD.md, and tasklist.md
  • .ai/prompts/ with prompt templates for document generation
  • .ai/workflows/ for project workflow notes
  • .ai/conventions/ for coding and delivery conventions
  • inputs/ with example inputs for idea, vision, and user story stages
  • README.spec.md with a short workflow guide

Installation

From PyPI:

python -m pip install tx-ai-agent-sdd

From source:

python -m pip install .

Usage

Create a new scaffold:

tx-ai-agent-sdd init my-project

Show the installed CLI version:

tx-ai-agent-sdd --version

Copy the scaffold into an existing non-empty directory:

tx-ai-agent-sdd init my-project --force

Suggested workflow

  1. Fill in inputs/idea.input.example.md.
  2. Generate docs/idea.md.
  3. Use idea.md to produce docs/vision.md.
  4. Use a user story and vision.md to produce docs/HLD.md.
  5. Use HLD.md to produce docs/LLD.md.
  6. Use vision.md, HLD.md, LLD.md, workflows, and conventions to produce docs/tasklist.md.
  7. Run subsequent iterations through the workflow protocol.

Why it is useful

This package is a good fit if you want a repeatable way to start AI-assisted projects without rebuilding the same folder structure and document flow every time.

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

tx_ai_agent_sdd-0.1.0.tar.gz (48.9 kB view details)

Uploaded Source

Built Distribution

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

tx_ai_agent_sdd-0.1.0-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

Details for the file tx_ai_agent_sdd-0.1.0.tar.gz.

File metadata

  • Download URL: tx_ai_agent_sdd-0.1.0.tar.gz
  • Upload date:
  • Size: 48.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for tx_ai_agent_sdd-0.1.0.tar.gz
Algorithm Hash digest
SHA256 161b6ec98edda03bcdfc5e154f766a09dae6c93c7b8b98830515199f5362acc6
MD5 25eadb4d4afbb6ef21e3b022abdc1f6c
BLAKE2b-256 9fcef039d43f2a1b7625d4502886219ac0cc8f2f386623bd2f9cb6eb7ddd212e

See more details on using hashes here.

File details

Details for the file tx_ai_agent_sdd-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tx_ai_agent_sdd-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 92eda4a18e55b9311413a25c241f5cd163be252c3b0aa384542141619b3ab45a
MD5 24d5c4bf5edccd35f4d00845b1c3c105
BLAKE2b-256 f8fa8e41f6c11038273904e093ac4fb1d152cafe341efce7c7446bcecd6b86cc

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