Skip to content

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 

README.md

MetaSpec Examples

MetaSpec uses interactive mode for toolkit creation, which provides the best experience by guiding you through the process step-by-step.

🚀 Quick Start

Interactive Mode (Recommended)

The interactive wizard asks questions and generates a complete toolkit:

metaspec init

# You'll be prompted for:
# 1. Toolkit name
# 2. Domain (generic, testing, api, design, data, or custom)
# 3. Entity definition
# 4. Commands
# 5. Dependencies

Template Mode (Fast)

Use the default template for quick start:

metaspec init my-spec-kit

# This generates a toolkit with:
# - Entity: Spec (name, version, description, status)
# - CLI Commands: init, check, show
# - Slash Commands: /genericspec:init, /genericspec:check, /genericspec:generate

With Spec-Kit Integration

Enable spec-driven development for the toolkit itself:

metaspec init my-spec-kit --spec-kit

# Adds:
# - specs/ directory
# - AI slash commands for development

📂 Example Generated Structure

After running metaspec init my-spec-kit, you get:

my-spec-kit/
├── README.md              # Toolkit documentation
├── AGENTS.md             # AI agent guide
├── pyproject.toml        # Python project config
├── .gitignore
├── memory/
│   └── constitution.md   # Design principles
├── scripts/
│   ├── init.sh          # Initialization script
│   └── validate.sh      # Validation script
├── templates/
│   └── spec-template.md # Spec file template
└── src/
    └── my_spec_kit/
        ├── __init__.py
        ├── cli.py       # CLI commands
        ├── parser.py    # YAML parser
        └── validator.py # Spec validator

🎯 Domain-Specific Examples

MetaSpec adapts to your domain. Here are common use cases:

API Testing Toolkit

metaspec init

# Select domain: "3. api"
# Entity: APITest
# Fields: endpoint, method, headers, body, assertions
# Commands: init, validate, run

Design System Toolkit

metaspec init

# Select domain: "4. design"
# Entity: Component
# Fields: name, category, props, variants, states
# Commands: init, validate, generate, preview

Testing Framework

metaspec init

# Select domain: "2. testing"
# Entity: TestCase
# Fields: name, description, steps, assertions
# Commands: init, run, report

Custom Domain

metaspec init

# Select domain: "6. custom"
# Enter domain: data-pipeline
# Define your own entity and commands

📖 Learning Resources

💡 Best Practices

  1. Use Interactive Mode First

    • Understand the toolkit structure
    • Get guided through domain-specific decisions
    • Generate working code immediately

  2. Iterate with --dry-run

    metaspec init my-kit --dry-run

  3. Customize After Generation

    • Generated toolkits are starting points
    • Add domain-specific logic
    • Extend with custom templates

  4. Use Built-in MetaSpec Commands

    cd my-spec-kit
# Use /metaspec.* commands in AI editor (Cursor/Claude)
# See AGENTS.md for complete workflow

Generated by MetaSpec - The meta-framework for spec-driven toolkits