CLI Reference
betterspec propose
Create a new change proposal
betterspec propose
Create a new change proposal. A proposal is the starting point for any tracked change in your project.
Usage
betterspec propose [idea]Pass the idea inline as an argument, or omit it to be prompted interactively.
Options
| Option | Description |
|---|---|
-C, --cwd <path> | Run as if betterspec was started in the given path |
What it does
Creates a new change directory under betterspec/changes/ with the following files:
betterspec/changes/<change-slug>/
proposal.md
specs/
requirements.md
scenarios.md
design.md
tasks.md- proposal.md — High-level description of the change
- specs/requirements.md — Functional and non-functional requirements
- specs/scenarios.md — Usage scenarios and edge cases
- design.md — Technical design and approach
- tasks.md — Breakdown of implementation tasks
Examples
Inline idea:
$ betterspec propose "Add webhook support for build events"
Created change: add-webhook-support-for-build-events
betterspec/changes/add-webhook-support-for-build-events/proposal.md
betterspec/changes/add-webhook-support-for-build-events/specs/requirements.md
betterspec/changes/add-webhook-support-for-build-events/specs/scenarios.md
betterspec/changes/add-webhook-support-for-build-events/design.md
betterspec/changes/add-webhook-support-for-build-events/tasks.mdInteractive mode:
$ betterspec propose
? Describe your change idea: Add webhook support for build events
Created change: add-webhook-support-for-build-events