@brnbco/specmill
v0.1.2
Published
Industrial-strength CLI that expands a requirements.md file into full .cursor spec docs with Azure OpenAI (o3-mini)
Maintainers
Readme
@brnbco/specmill

Industrial-strength CLI that expands a requirements.md file into full .cursor spec docs with Azure OpenAI (o3-mini).
Overview
specmill takes a requirements file (typically Markdown) and uses Azure OpenAI's language models to automatically generate a comprehensive set of specification documents commonly used in software development workflows, particularly those involving AI pair programmers like Cursor.
It generates files such as:
.cursor/PRD.md.cursor/USER_STORIES.md.cursor/TECH_STORIES.md.cursor/ARCHITECTURE.md(with Mermaid diagrams).cursor/TECH_STACK.md.cursor/INFRASTRUCTURE.md(with Mermaid diagrams).cursor/IMPLEMENTATION_PLAN.md.cursor/FILE_STRUCTURE.md.cursor/RULES.md
Installation
npm install -g @brnbco/specmill
# or
yarn global add @brnbco/specmillAlternatively, you can use it directly without global installation:
npx @brnbco/specmill [options] [requirements_file]Usage
specmill [options] [requirements_file]Arguments:
requirements_file: Path to the input requirements file (defaults torequirements.md).
Options:
-o, --outdir <dir>: Output directory for generated spec files (defaults to.cursor).-m, --model <deployment>: Azure OpenAI deployment name (defaults too3-miniorAZURE_OPENAI_DEPLOYMENTenv var).-v, --api-version <ver>: Azure OpenAI API version (defaults to2024-02-15-preview).-h, --help: Display help for command.
Environment Variables:
AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint URL (required).AZURE_OPENAI_API_KEY: Your Azure OpenAI API key (required).AZURE_OPENAI_DEPLOYMENT: Default model deployment name (optional, overrides-mdefault).
You can place these variables in a .env file in the directory where you run specmill.
Example:
# Generate specs from my_app_requirements.md into the ./specs directory
specmill -o ./specs my_app_requirements.mdDevelopment
- Clone the repository.
- Install dependencies:
npm install - Build the project:
npm run build - Run in development mode:
npm run dev -- [options] [requirements_file]
Contributing
Contributions are welcome! Please open an issue or submit a pull request.
License
This project is licensed under the MIT License.
