tinyspec

https://tinyspec.dev/docs
Admin
tinyspec is a lightweight spec-driven development framework and CLI for creating structured Markdown...
Tokens:11,078
Snippets:169
Trust Score:2.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install tinyspec skills with tinyspec init

Source: https://tinyspec.dev/docs/claude-code

Installs the four tinyspec skill files under .claude/skills/ in the current repository. Run this once during setup.

```bash
tinyspec init

```

--------------------------------

### Implementation Plan checklist example

Source: https://tinyspec.dev/docs/concepts

Example of a structured checklist for the Implementation Plan section, using task groups (A, B) and subtasks (A.1, A.2, B.1).

```markdown
- [ ] A: Set up database schema
  - [ ] A.1: Create users table migration
  - [ ] A.2: Add indexes for email and username
- [ ] B: Implement API endpoints
  - [ ] B.1: POST /users endpoint
  - [ ] B.2: GET /users/:id endpoint

```

--------------------------------

### Test Plan checklist example

Source: https://tinyspec.dev/docs/concepts

Example of an optional Test Plan section using Given/When/Then syntax.

```markdown
- [ ] T.1: User creation
  - **Given** no user with email "test@example.com" exists
  - **When** POST /users is called with valid data
  - **Then** a 201 response is returned
  - **And** the user appears in the database

```

--------------------------------

### Install tinyspec on macOS/Linux

Source: https://tinyspec.dev/docs/getting-started

Installs tinyspec on macOS or Linux. Detects the platform, downloads the correct binary, and installs it to ~/.local/bin.

```bash
curl -fsSL https://tinyspec.dev/install.sh | sh

```

--------------------------------

### Install tinyspec via curl script

Source: https://tinyspec.dev

Install tinyspec using the official installation script. This method is suitable for users who prefer a one-line installation without needing Rust.

```bash
curl -fsSL https://tinyspec.dev/install.sh | sh
```

--------------------------------

### Spec group directory examples

Source: https://tinyspec.dev/docs/concepts

Shows how specs can be organized into groups using subdirectories.

```text
.specs/v1/2026-02-18-14-30-auth.md
.specs/v1/2026-02-18-15-00-dashboard.md
.specs/v2/2026-02-19-09-00-redesign.md

```

--------------------------------

### Spec file naming example

Source: https://tinyspec.dev/docs/concepts

Shows the file naming convention for specs in the .specs/ directory, including a timestamp prefix.

```text
.specs/2026-02-18-14-30-my-feature.md

```

--------------------------------

### Install tinyspec on Windows

Source: https://tinyspec.dev/docs/getting-started

Installs tinyspec on Windows via PowerShell. Downloads the correct binary, installs it to %LOCALAPPDATA%\tinyspec, and adds it to PATH automatically.

```powershell
irm https://tinyspec.dev/install.ps1 | iex

```

--------------------------------

### tinyspec check example

Source: https://tinyspec.dev/docs/cli-reference

Example of marking task A.1 in spec my-feature as complete.

```bash
tinyspec check my-feature A.1

```

--------------------------------

### Install tinyspec with Cargo

Source: https://tinyspec.dev

Install tinyspec using Cargo, the Rust package manager. This is the primary installation method for users who have Rust installed.

```bash
cargo install tinyspec
```

--------------------------------

### Launch the dashboard with `tinyspec dashboard`

Source: https://tinyspec.dev/docs/dashboard

Run this command in the terminal to start the interactive dashboard TUI.

```bash
tinyspec dashboard

```

--------------------------------

### Implement a full plan with /tinyspec:do

Source: https://tinyspec.dev/docs/claude-code

Implements the full Implementation Plan for the named feature, working through task groups in order. Claude checks progress with tinyspec status, implements each group, marks subtasks complete with tinyspec check, verifies the build, and commits with a message referencing the spec and task group. If the spec lists multiple applications, Claude asks which repositories to focus on before starting.

```bash
/tinyspec:do my-feature

```

--------------------------------

### Front matter YAML example

Source: https://tinyspec.dev/docs/concepts

Shows the required YAML front matter for a tinyspec specification, including the tinySpec version, title, and optional applications list.

```yaml
---
tinySpec: v0
title: My Feature
applications:
  - my-app
---

```

--------------------------------

### Example template with {{title}} and ${date} variables

Source: https://tinyspec.dev/docs/configuration

Example template showing variable substitution with `{{title}}` and `${date}`. Variables inside fenced code blocks and inline code are not substituted; unknown variables are left as-is.

```markdown
---
tinySpec: v0
title: {{title}}
applications:
  -
---

# Background

Created on ${date}.

# Proposal

# Implementation Plan

# Test Plan

```

--------------------------------

### tinyspec status output format

Source: https://tinyspec.dev/docs/cli-reference

Example output format for the status command.

```text
my-feature: 5/12 tasks complete

```

--------------------------------

### Update tinyspec skills with tinyspec init --force

Source: https://tinyspec.dev/docs/claude-code

Updates the installed skill files to the latest version after upgrading tinyspec. Overwrites existing skill files.

```bash
tinyspec init --force

```

--------------------------------

### Example dashboard row format

Source: https://tinyspec.dev/docs/dashboard

Shows the format of a row in the list view: status icon, timestamp, spec name, progress bar, and task count.

```text
● 2026-02-18 my-feature  ██████░░░░  6/10

```

--------------------------------

### Implement a spec with Claude Code

Source: https://tinyspec.dev

Use the Claude Code slash command to implement the plan for 'my-feature'. This command starts the implementation based on the spec.

```claude-code
/tinyspec:do my-feature
```

--------------------------------

### Refine a spec with /tinyspec:refine

Source: https://tinyspec.dev/docs/claude-code

Starts collaborative spec refinement for the named feature. Claude reads the spec, asks clarifying questions, suggests improvements, scaffolds the Implementation Plan with task groups and subtasks, and optionally scaffolds a Test Plan with Given/When/Then syntax. Waits for your approval before writing changes; can be run multiple times to iterate.

```bash
/tinyspec:refine my-feature

```

--------------------------------

### Initialize a tinyspec project

Source: https://tinyspec.dev/docs/getting-started

Initializes a tinyspec project in the current repository. Creates skill files under .claude/skills/ and prints instructions for enabling shell tab completions.

```bash
cd your-project
tinyspec init

```

--------------------------------

### List templates with tinyspec templates

Source: https://tinyspec.dev/docs/configuration

List all available templates with their name and source (repo or user).

```bash
tinyspec templates

```

--------------------------------

### Initialize tinyspec in your project

Source: https://tinyspec.dev

Initialize tinyspec in your project. This sets up the necessary configuration and directory structure for using tinyspec.

```bash
tinyspec init
```

--------------------------------

### tinyspec init command

Source: https://tinyspec.dev/docs/cli-reference

Sets up Claude Code skills and shell completions in the current repository. Creates skill files under .claude/skills/ for the refine, work, task, and oneshot skills. Use --force to overwrite existing skill files.

```bash
tinyspec init [--force]

```

--------------------------------

### tinyspec new command

Source: https://tinyspec.dev/docs/cli-reference

Creates a timestamped Markdown file in .specs/. The spec name must be kebab-case. Use --template to select a named template; a default template is applied automatically if it exists.

```bash
tinyspec new <spec-name> [--template <name>]

```

--------------------------------

### Implement a single task with /tinyspec:task

Source: https://tinyspec.dev/docs/claude-code

Implements a single specific task (e.g., A.1) from the plan. Claude reads the spec, implements the task and its subtasks, marks it complete with tinyspec check, and verifies the work. If the task depends on uncompleted prior tasks, Claude asks how to proceed.

```bash
/tinyspec:task my-feature A.1

```

--------------------------------

### tinyspec init

Source: https://tinyspec.dev/docs/cli-reference

Initializes Claude Code skills and shell completions in the current repository.

```APIDOC
## tinyspec init

### Description
Set up Claude Code skills and shell completions in the current repository.

### Usage
```
tinyspec init [--force]
```

### Parameters
#### Flags
- `--force`, `-f` (boolean) - Optional - Overwrite existing skill files with the latest versions

### Description
Creates skill files under `.claude/skills/` for the refine, work, task, and oneshot skills. Prints shell-specific instructions for enabling tab completion.
```

--------------------------------

### Build tinyspec from source with cargo

Source: https://tinyspec.dev/docs/getting-started

Builds tinyspec from source using the Rust toolchain. Works on any platform via crates.io.

```bash
cargo install tinyspec

```

--------------------------------

### tinyspec config.yaml repositories mapping

Source: https://tinyspec.dev/docs/configuration

Global configuration file at ~/.tinyspec/config.yaml, created automatically by `tinyspec config set`. Maps repository names to absolute paths.

```yaml
repositories:
  frontend: /workspace/frontend
  backend: /workspace/backend

```

--------------------------------

### tinyspec view command

Source: https://tinyspec.dev/docs/cli-reference

Prints the full content of a spec. If the spec lists applications in its front matter, their names are resolved to folder paths via the config before printing.

```bash
tinyspec view <spec-name>

```

--------------------------------

### Generate and execute specs from a prompt with /tinyspec-oneshot

Source: https://tinyspec.dev/docs/claude-code

Generates and executes specs from a prompt. Claude plans a set of specs, presents them for approval, creates and populates each spec, then executes them all.

```bash
/tinyspec-oneshot Add dark mode support with a toggle in the header

```

--------------------------------

### tinyspec list command

Source: https://tinyspec.dev/docs/cli-reference

Lists all specs, showing each spec's name and title organized by group. Specs are sorted by filename for natural date ordering.

```bash
tinyspec list

```

--------------------------------

### Configure paths for multi-repo applications

Source: https://tinyspec.dev/docs/configuration

Configure paths for each application listed in the spec's `applications` front matter. These mappings are used by `tinyspec view` to replace application names with absolute paths.

```bash
tinyspec config set frontend /workspace/frontend
tinyspec config set backend /workspace/backend
tinyspec config set auth-service /workspace/auth-service

```

--------------------------------

### Create spec with --template flag

Source: https://tinyspec.dev/docs/configuration

Create a new spec using a specific template. The `--template` flag selects the template name; without it, the `default` template is applied.

```bash
tinyspec new my-feature --template my-template

```

--------------------------------

### Manage repository mappings with tinyspec config

Source: https://tinyspec.dev/docs/configuration

Commands to manage repository mappings in the config file. `set` adds or updates, `list` shows all, `remove` deletes a mapping.

```bash
tinyspec config set <name> <path>     # add or update a mapping
tinyspec config list                  # show all mappings
tinyspec config remove <name>         # remove a mapping

```

--------------------------------

### Create a new spec with tinyspec

Source: https://tinyspec.dev

Create a new specification file for a feature named 'my-feature'. This generates a Markdown spec with the standard sections.

```bash
tinyspec new my-feature
```

--------------------------------

### tinyspec new

Source: https://tinyspec.dev/docs/cli-reference

Creates a new spec file in the .specs directory.

```APIDOC
## tinyspec new

### Description
Create a new spec.

### Usage
```
tinyspec new <spec-name> [--template <name>]
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec. Must be kebab-case (lowercase letters, digits, and single hyphens). Use slash notation to create specs inside a group (e.g., `v1/my-feature`).

#### Flags
- `--template`, `-t` (string) - Optional - Use a named template instead of the default skeleton. If a template named `default` exists, it is applied automatically when no `--template` flag is given.

### Description
Creates a timestamped Markdown file in `.specs/`.
```

--------------------------------

### Spec front matter with applications for multi-repo

Source: https://tinyspec.dev/docs/configuration

Spec front matter listing multiple applications for multi-repo support. When `tinyspec view` runs, each application name is replaced with its configured folder path.

```yaml
---
tinySpec: v0
title: My Feature
applications:
  - frontend
  - backend
  - auth-service
---

```

--------------------------------

### tinyspec dashboard

Source: https://tinyspec.dev/docs/cli-reference

Launches the interactive TUI dashboard.

```APIDOC
## tinyspec dashboard

### Description
Launch the interactive TUI dashboard.

### Usage
```
tinyspec dashboard
```

### Description
Shows all specs with progress bars and status. See the Dashboard page for details.
```

--------------------------------

### tinyspec check command

Source: https://tinyspec.dev/docs/cli-reference

Marks a task as complete by changing - [ ] to - [x] for the given task ID, then auto-formats the file.

```bash
tinyspec check <spec-name> <task-id>

```

--------------------------------

### tinyspec templates

Source: https://tinyspec.dev/docs/cli-reference

Lists available templates.

```APIDOC
## tinyspec templates

### Description
List available templates.

### Usage
```
tinyspec templates
```

### Description
Shows template names and their source (repo-level or user-level).
```

--------------------------------

### tinyspec config

Source: https://tinyspec.dev/docs/cli-reference

Manages repository path mappings for multi-repo specs.

```APIDOC
## tinyspec config

### Description
Manage repository path mappings for multi-repo specs.

### Usage
```
tinyspec config set <repo-name> <path>
tinyspec config list
tinyspec config remove <repo-name>
```

### Parameters
#### Subcommands
- `set` - Set a repository path mapping. Arguments: `<repo-name>` (string, required), `<path>` (string, required).
- `list` - List all repository path mappings.
- `remove` - Remove a repository path mapping. Arguments: `<repo-name>` (string, required).

### Description
Config is stored at `~/.tinyspec/config.yaml`. These mappings are used by `tinyspec view` to resolve application names to folder paths.
```

--------------------------------

### tinyspec status command

Source: https://tinyspec.dev/docs/cli-reference

Shows completion progress. Without a spec name, shows status for all specs.

```bash
tinyspec status [<spec-name>]

```

--------------------------------

### tinyspec config commands

Source: https://tinyspec.dev/docs/cli-reference

Manages repository path mappings for multi-repo specs. Config is stored at ~/.tinyspec/config.yaml and used by tinyspec view to resolve application names to folder paths.

```bash
tinyspec config set <repo-name> <path>
tinyspec config list
tinyspec config remove <repo-name>

```

--------------------------------

### tinyspec edit command

Source: https://tinyspec.dev/docs/cli-reference

Opens a spec in your editor, using $EDITOR or falling back to vi. Remember to run tinyspec format after editing because the editor does not auto-format.

```bash
tinyspec edit <spec-name>

```

--------------------------------

### tinyspec view

Source: https://tinyspec.dev/docs/cli-reference

Prints the full content of a spec.

```APIDOC
## tinyspec view

### Description
Print the full content of a spec.

### Usage
```
tinyspec view <spec-name>
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec to view.

### Description
If the spec lists applications in its front matter, their names are resolved to folder paths via the config before printing.
```

--------------------------------

### tinyspec format command

Source: https://tinyspec.dev/docs/cli-reference

Normalizes Markdown formatting in a spec while preserving YAML front matter verbatim. The operation is idempotent. Use --all to format every spec in .specs/.

```bash
tinyspec format <spec-name>
tinyspec format --all

```

--------------------------------

### Execute all pending specs with /tinyspec:oneshot

Source: https://tinyspec.dev/docs/claude-code

Executes all pending specs in chronological order. Operates autonomously, resolving ambiguity via codebase patterns and only asking for truly blocking decisions.

```bash
/tinyspec:oneshot

```

--------------------------------

### tinyspec list

Source: https://tinyspec.dev/docs/cli-reference

Lists all specs organized by group.

```APIDOC
## tinyspec list

### Description
List all specs.

### Usage
```
tinyspec list
```

### Description
Shows each spec's name and title, organized by group. Specs are sorted by filename (which provides natural date ordering).
```

--------------------------------

### Create grouped spec command

Source: https://tinyspec.dev/docs/concepts

Command to create a new spec in a group using slash notation.

```bash
tinyspec new v1/auth

```

--------------------------------

### tinyspec edit

Source: https://tinyspec.dev/docs/cli-reference

Opens a spec in the user's editor.

```APIDOC
## tinyspec edit

### Description
Open a spec in your editor.

### Usage
```
tinyspec edit <spec-name>
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec to edit.

### Description
Uses `$EDITOR` (falls back to `vi`). Remember to run `tinyspec format` after editing, since the editor does not auto-format.
```

--------------------------------

### tinyspec new with group slash notation

Source: https://tinyspec.dev/docs/cli-reference

Creates a spec inside a group using slash notation, e.g., v1/my-feature.

```bash
tinyspec new v1/my-feature

```

--------------------------------

### tinyspec format

Source: https://tinyspec.dev/docs/cli-reference

Normalizes Markdown formatting in a spec or all specs.

```APIDOC
## tinyspec format

### Description
Normalize Markdown formatting in a spec.

### Usage
```
tinyspec format <spec-name>
tinyspec format --all
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Optional - The name of the spec to format. If omitted, `--all` must be used.

#### Flags
- `--all` (boolean) - Optional - Format every spec in `.specs/`.

### Description
Formats the Markdown body while preserving YAML front matter verbatim. The operation is idempotent. Commands like `new`, `check`, and `uncheck` auto-format, so you only need to run this manually after editing a spec file directly.
```

--------------------------------

### Check spec status with tinyspec status

Source: https://tinyspec.dev/docs/getting-started

Checks the status of a spec from the command line.

```bash
tinyspec status my-feature

```

--------------------------------

### tinyspec check

Source: https://tinyspec.dev/docs/cli-reference

Marks a task as complete in a spec.

```APIDOC
## tinyspec check

### Description
Mark a task as complete.

### Usage
```
tinyspec check <spec-name> <task-id>
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec.
- `<task-id>` (string) - Required - The ID of the task to mark as complete.

### Description
Changes `- [ ]` to `- [x]` for the given task ID. Auto-formats the file afterward.
```

--------------------------------

### tinyspec status

Source: https://tinyspec.dev/docs/cli-reference

Shows completion progress for a spec or all specs.

```APIDOC
## tinyspec status

### Description
Show completion progress.

### Usage
```
tinyspec status [<spec-name>]
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Optional - The name of the spec to show status for. If omitted, shows status for all specs.

### Description
Shows completion progress. Without a spec name, shows status for all specs. Output format: `my-feature: 5/12 tasks complete`.
```

--------------------------------

### tinyspec uncheck command

Source: https://tinyspec.dev/docs/cli-reference

Marks a task as incomplete by changing - [x] back to - [ ] for the given task ID, then auto-formats the file.

```bash
tinyspec uncheck <spec-name> <task-id>

```

--------------------------------

### Refine a spec with Claude Code

Source: https://tinyspec.dev

Use the Claude Code slash command to refine the specification for 'my-feature'. This command leverages AI to improve the spec.

```claude-code
/tinyspec:refine my-feature
```

--------------------------------

### tinyspec uncheck

Source: https://tinyspec.dev/docs/cli-reference

Marks a task as incomplete in a spec.

```APIDOC
## tinyspec uncheck

### Description
Mark a task as incomplete.

### Usage
```
tinyspec uncheck <spec-name> <task-id>
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec.
- `<task-id>` (string) - Required - The ID of the task to mark as incomplete.

### Description
Changes `- [x]` back to `- [ ]` for the given task ID. Auto-formats the file afterward.
```

--------------------------------

### tinyspec delete command

Source: https://tinyspec.dev/docs/cli-reference

Deletes a spec after prompting for confirmation.

```bash
tinyspec delete <spec-name>

```

--------------------------------

### tinyspec delete

Source: https://tinyspec.dev/docs/cli-reference

Deletes a spec after confirmation.

```APIDOC
## tinyspec delete

### Description
Delete a spec.

### Usage
```
tinyspec delete <spec-name>
```

### Parameters
#### Arguments
- `<spec-name>` (string) - Required - The name of the spec to delete.

### Description
Prompts for confirmation before removing the file.
```
Tokens:
Raw