dt-workspace CLI

Transform Your SOW into Production-Ready Documentation in Minutes

Stop writing documentation manually. Let AI do it.

The Problem

Every software project starts with a Statement of Work—but turning that SOW into comprehensive technical documentation takes days or weeks of manual effort.

• API contracts written inconsistently across teams
• Database schemas documented differently by each developer
• BDD test scenarios created as an afterthought
• ER diagrams that are always outdated
• Technical specs that don't match implementation

The result? Delayed project kickoffs, miscommunication between teams, and documentation that's obsolete before development begins.

The Solution

dt-workspace uses AI (Claude Code or Google Gemini) to analyze your SOW and automatically generate:

• Structured module documentation
• API contracts with request/response schemas
• Database schema definitions
• BDD/Gherkin feature files
• ER diagrams (Mermaid, PlantUML, or ASCII)
• Development timelines
• Error handling specifications

One command. Complete documentation. Production-ready.

Who Benefits

| Role | Value | |------|-------| | Developers | Focus on building, not documenting. Get consistent API contracts and database schemas from day one. | | Tech Leads | Enforce documentation standards across all projects. Every module follows the same structure. | | Project Managers | Accelerate project kickoffs. Transform weeks of documentation into a single afternoon. | | Executives | Reduce time-to-market. Faster documentation means faster development cycles. |

Key Features

| Feature | Description | |---------|-------------| | AI-Powered Analysis | Claude Code or Gemini CLI analyzes your SOW and extracts modules, features, and technical requirements | | Architecture Presets | Choose from microservices (NestJS/Kafka), monolith, or serverless (AWS Lambda) templates | | BDD Test Generation | Automatic Gherkin feature files for every module and feature | | ER Diagrams | Generate entity-relationship diagrams in Mermaid, PlantUML, or ASCII formats | | Customizable Templates | Export and modify Handlebars templates to match your organization's standards | | Multi-AI Support | Switch between Claude and Gemini with a single command |

Quick Start

Installation

npm install -g @dt-workspace/cli

Prerequisites: Node.js 18+ and either Claude Code CLI or Gemini CLI

Generate Documentation in 4 Steps

# 1. Verify AI provider and CLI version
dt-workspace doctor

# 2. Initialize project configuration
dt-workspace init

# 3. Generate documentation skeleton from your SOW
dt-workspace scaffold

# 4. Fill placeholders with AI-generated content
dt-workspace populate

Commands Reference

| Command | Alias | Description | |---------|-------|-------------| | init | - | Create .dt-workspace config file | | scaffold | generate | Generate documentation skeleton from SOW | | populate | complete | Fill placeholders with AI-generated content | | doctor | check | Check AI provider and CLI version | | upgrade | - | Upgrade CLI to latest version | | provider | switch | Switch between Claude and Gemini | | presets | - | List available architecture templates | | export | templates | Export templates for customization | | timeline | - | Generate development timeline | | diagram | er-diagram | Generate ER diagrams | | diagram:convert | convert-diagram | Convert diagrams between formats | | sync | restore | Rebuild config from filesystem | | clean | - | Delete generated docs and reset config |

What Gets Generated

workflows/
├── README.md                      # Project overview with links
├── er-diagram.md                  # Global ER diagram
│
├── web-application/
│   ├── timeline.md                # Development sequence & dependencies
│   │
│   └── user-management/
│       ├── README.md              # Module overview
│       ├── user-flows.md          # User journey documentation
│       ├── technical-specs.md     # Implementation details
│       ├── api-contracts.md       # Endpoint definitions
│       ├── database-schema.md     # Table structures
│       ├── er-diagram.md          # Module relationships
│       ├── realtime-events.md     # WebSocket/Kafka events
│       ├── error-handling.md      # Error codes & handling
│       │
│       └── features/
│           ├── user-registration.feature
│           ├── user-login.feature
│           └── profile-management.feature

Architecture Presets

| Preset | Stack | Best For | |--------|-------|----------| | microservices | NestJS, Kafka, PostgreSQL, WebSocket | Distributed systems, event-driven architecture | | monolith | Single application, REST APIs | Smaller teams, rapid prototyping | | serverless | AWS Lambda, DynamoDB, API Gateway | Cloud-native, pay-per-use scaling | | supabase | PostgreSQL, RLS, Edge Functions, Realtime | Rapid MVP, real-time apps | | firebase | Firestore, Cloud Functions, Hosting | Mobile-first, Google ecosystem | | nextjs-fullstack | App Router, Server Components, Actions | Modern React fullstack | | graphql-federation | Apollo Federation, Subgraphs | Unified graph from services | | kubernetes | Helm, Istio, HPA | Enterprise container orchestration | | event-sourcing | CQRS, Event Store, Projections | Audit trails, financial systems |

dt-workspace scaffold --preset serverless
dt-workspace presets  # View all presets

Custom Templates

Modify documentation structure to match your organization's standards:

# Export built-in templates
dt-workspace export --preset microservices

# Templates saved to .dt-templates/
# Edit Handlebars files as needed
# Your customizations apply to all future generations

SOW Format

Your Statement of Work should follow this structure:

# Project Name - Statement of Work

## Platform: Web Application

### User Management
User authentication and profile management.

**Features:**
- User registration with email verification
- Login/logout with session management
- Profile editing and avatar upload

**Technical Requirements:**
- Backend: UserService, AuthService
- Databases: PostgreSQL (users), Redis (sessions)
- Events: user.created, user.updated

Impact

| Before | After | |--------|-------| | Days writing API contracts | Minutes with AI generation | | Inconsistent documentation across teams | Standardized structure for every project | | Outdated ER diagrams | Diagrams generated from actual schemas | | BDD tests as an afterthought | Feature files from day one | | Manual format conversion | One command to switch diagram formats |

Support

• NPM Package
• GitHub Repository
• Report Issues

License

MIT © Deepak Tiwari

Stop documenting. Start building.