contextseed
v0.1.0
Published
Developer-focused CLI and AI-context system for generating and managing structured project documents.
Maintainers
Readme
ContextSeed
Turn AI project discussions into structured, reusable developer context and documentation.
What is ContextSeed?
ContextSeed is a developer-focused CLI and AI-context system designed to turn software planning discussions into structured, reusable project specifications. When planning projects with ChatGPT, Claude, Gemini, or other AI assistants, critical decisions and requirements often get scattered across dozens of chat messages. ContextSeed solves this by providing standardized, editable Markdown templates and prompts stored in a single AI_CONTEXT/ directory without requiring external AI API keys or cloud databases.
Quick Start
Generate a Product Requirements Document (PRD) directly in your project:
npx contextseed add prdThis creates AI_CONTEXT/PRD.md with instructions and structure ready to provide to your AI assistant.
Installation
No global installation is required. You can run ContextSeed on demand using npx:
npx contextseed <command>If you prefer to install it globally on your machine, you can run:
npm install -g contextseedCommands
ContextSeed provides a full suite of commands for managing project specifications and custom templates:
| Command | Description |
| :--- | :--- |
| npx contextseed | Launch the visual, interactive prompt menu. |
| npx contextseed init | Initialize ContextSeed configuration (.contextseed/config.json) and AI_CONTEXT/. |
| npx contextseed list | List all available templates with origin badges ([builtin], [user], [override]). |
| npx contextseed add <template> | Generate a single context document into AI_CONTEXT/. |
| npx contextseed edit [template] | Open a template in your default $EDITOR (creates a project override if built-in). |
| npx contextseed custom [name] | Scaffold a new custom template with YAML frontmatter. |
| npx contextseed remove <document> | Remove a generated document from AI_CONTEXT/ (keeps source template intact). |
| npx contextseed update | View instructions for updating ContextSeed and templates. |
| npx contextseed --help | Display help information and available options. |
Command Options
addOptions:-f, --force: Overwrite existing files without confirmation prompt.-o, --output <file>: Specify custom destination filename.-c, --context-dir <dir>: Target a custom context directory instead ofAI_CONTEXT/.
customOptions:-d, --description <desc>: Template description.-s, --scope <project\|user>: Save location (projectoruser).--no-editor: Skip opening the editor after scaffolding.
Templates
ContextSeed includes 10 built-in, production-grade templates located in templates/:
prd: Product Requirements Document (16-section standard + conversational extraction rules).trd: Technical Requirements Document (architecture, tech stack, data models, security, testing).ux: UX and Design System Specification (tokens, components, user journeys, accessibility).aimemory: AI Memory, decision ledger, and context continuity log.architecture: System Architecture and component design.database: Database Schema, relations, ER diagrams, and indexes.api: API Design, endpoints, request/response contracts, and error standards.readme: Standardized Project README documentation template.description: Project positioning, elevator pitch, and value proposition.gitignore: Standard.gitignorerules generator.
Universal AI Prompt
ContextSeed provides CONTEXTSEED.md, a universal, zero-tooling system prompt and specification file designed to be shared directly with any AI chat model, including ChatGPT, Google Gemini, Claude, and Perplexity.
How to use CONTEXTSEED.md:
- Start a project planning session in your favorite AI chat interface.
- Provide
CONTEXTSEED.mdas the system prompt or paste it into your chat session. - The AI model analyzes the conversation history, extracts confirmed technical decisions, and outputs the core trio:
PRD.md(Product Requirements Document)TRD.md(Technical Requirements Document)UIUX.md(UI/UX Design Specification)
The NPM/NPX CLI tool works alongside this universal prompt to manage modular templates, project overrides, and filesystem workflows.
Development
For developers contributing to or extending ContextSeed:
Prerequisites
- Node.js >= 18.0.0
- npm / pnpm / yarn
Setup & Build
# Clone the repository
git clone https://github.com/contextseed/contextseed.git
cd contextseed
# Install dependencies
npm install
# Run development mode (live TS execution)
npm run dev
# Compile TypeScript to dist/
npm run build
# Run automated tests (Vitest)
npm test
# Run tests in watch mode
npm run test:watchContributing
Contributions are welcome! If you would like to add new built-in templates, improve CLI commands, or enhance AI integrations:
- Fork the repository.
- Create your feature branch (
git checkout -b feature/new-template). - Ensure all tests pass (
npm test). - Commit your changes (
git commit -m 'Add new template'). - Push to the branch (
git push origin feature/new-template). - Open a Pull Request.
License
Apache License 2.0 © 2026 ContextSeed Contributors
