Skip to main content

Specsmith CLI

Forge clear specifications from product ideas. AI-powered agent for developers and builders.

PyPI version Python 3.9+ License: MIT

The Specsmith CLI is a thin client for AI-powered specification generation using the Specsmith platform. Run specsmith, describe what you need, and get structured, implementation-ready technical specs.

🚀 What is Specsmith?

Specsmith helps engineers move from rough ideas to actionable specifications. It asks clarifying questions, identifies ambiguities, and produces detailed specs designed to feed directly into AI coding agents or human implementation.

✨ Key Capabilities

  • 🧠 Structured Specs: From natural language to clear acceptance criteria & Definition of Done
  • 💬 Clarifying Conversations: Interactive chat that refines requirements before finalizing
  • 📁 File Handling: Create and update spec files right from the CLI
  • ⚡ Streaming Responses: Real-time feedback as the AI reasons through your request
  • 🎯 Simple Entry Point: Just run specsmith — no flags required

🎯 Perfect For

  • Product managers defining features
  • Engineers planning implementations
  • Architects documenting systems
  • DevOps & infra teams writing technical runbooks

📦 Installation

pip install specsmith-cli
specsmith --version

⚡ Quickstart

1. Get Your API Keys

Learn more at specsmith.ai or go straight to signup → Settings → API Keys → generate a new key pair.

2. Configure Authentication

Recommended:

specsmith setup

Advanced alternatives:

  • Env vars

    export SPECSMITH_ACCESS_KEY_ID="your-access-key-id"
    export SPECSMITH_ACCESS_KEY_TOKEN="your-access-key-token"
    
  • Config file

    mkdir -p ~/.specsmith
    cat > ~/.specsmith/credentials << EOF
    access_key_id=your-access-key-id
    access_key_token=your-access-key-token
    EOF
    

3. Test

specsmith test

4. Start Workinggit add 0p

specsmith

That’s it — describe what you need, and specsmith will generate detailed specifications.

🎨 Usage Examples

Interactive session:

specsmith

Example:

You: I need a real-time chat app

specsmith: Let’s cover scale, features, tech stack, and platforms.
...

File management:

# Inside a chat session
# ✓ Create new file: database-schema.sql? (y/n): y

Configuration:

specsmith config

🛠️ Advanced Features

  • Custom API Endpoint

    export SPECSMITH_API_URL="https://your.company/api"
    
  • Debug Mode

    specsmith --debug
    
  • Available Commands

    specsmith chat      # start chat (default)
    specsmith setup     # configure credentials
    specsmith test      # test connection
    specsmith config    # show current config
    specsmith version   # version info
    specsmith --help    # all options
    

🔧 Configuration Options

Variable Description Default
SPECSMITH_ACCESS_KEY_ID API key ID required
SPECSMITH_ACCESS_KEY_TOKEN API key token required
SPECSMITH_API_URL API endpoint https://api.specsmith.ai
SPECSMITH_DEBUG Enable debug logging false

Config sources (priority order):

  1. ~/.specsmith/credentials
  2. Env vars
  3. CLI args

🚀 Real-World Use Cases

specsmith
# "Plan a notification system for a mobile app with push + email"
specsmith
# "Design a REST API for a multi-tenant SaaS with RBAC"
specsmith
# "Specify a CI/CD pipeline for microservices on Kubernetes"
specsmith
# "Create a database schema for a social app with posts, comments, likes"

🔍 Troubleshooting

Auth Errors

specsmith test
specsmith setup

Connection Issues

curl -I https://api.specsmith.ai/health
specsmith test --debug

File Permissions

chmod 755 .

More help:

📄 License

MIT License — see LICENSE

🌟 Why specsmith?

Good code starts with good specs. specsmith makes your requirements:

  • Complete: No missing edge cases
  • Actionable: Ready for humans or AI agents
  • Consistent: Following best practices & standards
  • Contextual: Informed by your repo & architecture

Transform your workflow. Start with better specs.


Get Started • Signup • Docs

Made with ❤️ by specsmith

Metadata

Release files for specsmith-cli 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for specsmith-cli 0.1.5
File Size Uploaded
specsmith_cli-0.1.5.tar.gz 14.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for specsmith-cli 0.1.5
File Interpreter ABI Platform
specsmith_cli-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 30.5 kB

Release files / specsmith_cli-0.1.5.tar.gz

Download URL specsmith_cli-0.1.5.tar.gz
Size 14.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ce62570839f91d034288218643817d9a64fbb905278c318c0cf9dfad9ad0b7a2
BLAKE2b-256 checksum
How to use checksums
03a6484ac6b64c6373ef918579bddbdd7cbdfe6a638720a3ec648777ead5570f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 2, 2025.

Transparency log

Release files / specsmith_cli-0.1.5-py3-none-any.whl

Download URL specsmith_cli-0.1.5-py3-none-any.whl
Size 15.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
334508df011b81ae24a1d61d2734f4e885c5f87691c9e21a9a85493155dce9e8
BLAKE2b-256 checksum
How to use checksums
018a37a89e099df5a0218b7ccec6c6ed5772cc9ee25ac5a509b624cbdfdfcc33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 2, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page