product-kit 1.0.6

CLI to scaffold Product Kit framework for requirement-driven design

product-kit

CLI to scaffold a new Product Kit project for requirement-driven design.

Command: prod

Installation

Quick Start (Recommended)

We recommend using UV - a fast Python package installer:

# Install UV first (if you don't have it)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install product-kit
uv tool install product-kit

# Use it
prod my-project

Alternative: Using pipx

pipx install product-kit
prod my-project

Alternative: Using pip

pip install product-kit
prod my-project

Usage

Interactive Mode (Recommended)

prod my-project

You'll be prompted for:

• Product name
• Product vision (one sentence)
• North Star metric
• Primary persona name
• Persona goal
• Strategic pillars (comma-separated)
• Whether to include GitHub Copilot agents
• Whether to include example content

Non-Interactive Mode

prod my-project --no-prompts

Uses sensible defaults for all options.

Specify Options

prod my-project \
  --product-name "My Awesome Product"

What Gets Created

my-product/
├── constitution.md              # Customized with your product name
├── context/
│   ├── product-vision.md        # Pre-filled with your vision
│   ├── personas.md              # Pre-filled with your persona
│   ├── glossary.md
│   └── market_research.md
├── inventory/
│   ├── feature-catalog.md
│   ├── tech-constraints.md
│   ├── data-model.md
│   └── product-map.md
├── templates/
│   ├── brd_template.md
│   ├── prd_template.md
│   └── epic_template.md
├── .github/
│   ├── copilot-instructions.md
│   └── agents/                  # Copilot agent configurations
├── .gitignore
├── README.md
├── QUICKSTART.md
├── ARCHITECTURE.md
└── LICENSE

Next Steps

After creating your project:

1. Navigate to your project:

   cd my-product
   

2. Initialize git (if needed):

   git init
   

3. Open in VS Code:

   code .
   

4. Customize your context:

   • Edit constitution.md with your product standards
   • Fill out context/ files with product details
   • Document current state in inventory/

5. Start using with Copilot:

   /productkit.clarify "your feature idea"
   

Requirements

• Python 3.8 or higher
• GitHub Copilot (for AI features)

Development

Setup

# Clone the repo
git clone https://github.com/yourusername/product-kit.git
cd product-kit/cli

# Install with UV
uv pip install -e ".[dev]"

# Or with pip
pip install -e ".[dev]"

Testing

# Run tests
pytest

# Run with coverage
pytest --cov=product_kit

Linting

# Format code
black src/

# Lint code
ruff check src/

Local Testing

# Install locally
uv pip install -e .

# Test the CLI
prod test-project

Publishing

Using UV

# Build the package
uv build

# Publish to PyPI
uv publish

Using Traditional Tools

# Build
python -m build

# Publish
twine upload dist/*

License

MIT

Support

For issues and questions:

• Issues: https://github.com/yourusername/product-kit/issues
• Documentation: https://github.com/yourusername/product-kit#readme