better-spec/README.md

Spec-driven development toolkit that turns executable specifications into production-ready code

# Better Spec

> ⚠️ **Work in Progress**: This package is currently under active development and not yet ready for production use. Features and APIs are subject to change.

## Control, consistency, and high-level design.

[Better Spec](https://better-spec.com/) is a spec-driven development toolkit that transforms your architectural vision into production-ready code. Stop letting crucial design decisions get lost in translation. With Better Spec, you create executable specifications that serve as the single source of truth for your development team and AI coding assistants.

Define your system's "constitution," create detailed plans with first-class vendor integrations, and ensure every line of code directly traces back to your original blueprint. Move beyond documentation that goes stale—start building with specifications that execute.

## Installation

```bash
npm install -g better-spec
```

or with Bun:

```bash
bun add -g better-spec
```

## Usage (Coming Soon)

The Better Spec CLI tool is currently under development. Once released, it will provide:

- **Spec Management**: Create, validate, and manage your project specifications
- **Code Generation**: Generate production-ready code from your specifications
- **Traceability**: Track code changes back to specification requirements
- **AI Integration**: Seamless integration with AI coding assistants
- **Vendor Integrations**: First-class support for popular development tools and services

### Planned Commands

```bash
# Initialize a new Better Spec project
better-spec init

# Validate your specifications
better-spec validate

# Generate code from specifications
better-spec generate

# Check code compliance with specifications
better-spec check

# More commands coming soon...
```

## Documentation

Visit [https://better-spec.com](https://better-spec.com) for full documentation (coming soon).

## Contributing

We welcome contributions! Please see our [Contributing Guide](https://github.com/kriasoft/better-spec/blob/main/CONTRIBUTING.md) for details.

## License

MIT © 2025-present Kriasoft