Skip to main content

Syntax

Description

The spec list command displays all specifications in your project. You can filter by priority, search by content, control archive visibility, and limit results. By default, the command:
  • Shows up to 50 specs
  • Excludes archived specs
  • Displays specs with their ID, title, priority, and file path
Use --grep for full-text search across spec titles and content, or use --priority to filter by priority level.

Options

number
Filter by priority level (0-4)Example: --priority 1Only shows specs with the specified priority:
  • 0 - Critical
  • 1 - High
  • 2 - Medium
  • 3 - Low
  • 4 - Lowest
string
Search specs by title or contentExample: --grep "authentication"Performs a full-text search across spec titles and markdown content. Case-insensitive by default.
boolean
Filter by archive statusExample: --archived true or --archived false
  • false (default) - Exclude archived specs
  • true - Show only archived specs
  • Omit to see all specs regardless of archive status
number
default:"50"
Maximum number of results to returnExample: --limit 100Useful for large projects with many specs. Increase to see more results.

Examples

List All Specs (Default)

Show all non-archived specs (up to 50):

Filter by Priority

Show only critical (priority 0) specs:

Search with Grep

Search for specs containing “auth”:
The grep search looks in both the title and the markdown content of specs.

Show Archived Specs

View only archived (deprecated) specs:

Combine Filters

Search for high-priority specs about “security”:

Increase Result Limit

Show up to 100 specs:
Useful for large projects with many specifications.

No Specs Found

When no specs match your filters:

JSON Output

Use the global --json flag for machine-readable output:

Common Workflows

Finding High-Priority Work

Identify critical and high-priority specs that need attention:
1

List critical specs

2

List high-priority specs

3

Review each spec

Find all specs related to a topic:
1

Search by keyword

2

Refine by priority

3

Review details

Auditing Archived Specs

Review deprecated specifications:
1

List archived specs

2

Review for removal

Decide if any can be permanently deleted
3

Clean up if needed

Filtering Logic

Important: When multiple filters are specified, they work as AND conditions. All filters must match for a spec to appear in results.
Examples:

Understanding Output

The default output format shows:

Spec ID

Unique identifier (e.g., SPEC-001)

Title

Human-readable spec name

Priority

0-4 priority level

File Path

Location in .sudocode/specs/

Common Questions

By default, spec list:
  • Limits to 50 results (use --limit to increase)
  • Excludes archived specs (use --archived false to explicitly exclude, or omit to see all)
Try:
The --grep option searches both:
  • Spec titles
  • Markdown content
It’s case-insensitive and looks for partial matches. For example:
Will match “Authentication”, “OAuth”, “auth-system”, etc.
Not directly with spec list. However, you can use grep to search for tags in content:
For more advanced filtering, use the JSON output and pipe to jq:
  • Archived specs (archived: true) are retained but hidden by default. They can be listed with --archived true.
  • Deleted specs are permanently removed from the database.
Archive specs when you want to keep them for reference but hide them from normal workflows.
Use spec show to see hierarchical relationships:
This will display parent and child specs in the relationship section.

Performance Tips

For large projects with hundreds of specs, consider these optimizations:
1

Use specific filters

Narrow results with --priority or --grep instead of listing everything
2

Increase limit if needed

Default limit of 50 is usually sufficient, but increase if necessary:
3

Use JSON for scripting

JSON output is efficient for programmatic processing:

Troubleshooting

Cause: No .sudocode/ directory foundSolution:
Possible causes:
  1. Specs are archived: sudocode spec list --archived false (default excludes archived)
  2. Specs don’t match filters: Remove filters to see all
  3. Database not synced: Run sudocode sync
Solution:
Cause: Search term might not match title or contentSolution:
  • Try broader search terms
  • Check spec content with sudocode spec show SPEC-ID
  • Verify spelling

spec create

Create a new spec

spec show

View spec details

spec update

Update existing spec

spec delete

Delete specs

issue list

List implementation issues

ready

Find ready work

Next Steps

1

List your specs

2

Filter by priority

3

View spec details

4

Create implementation issues

Specs Concept Guide

Learn more about specs and how they fit into sudocode’s workflow