@dt-workspace/cli

🚀 DT-Workspace CLI (v3.5.0)

DT-Workspace is a streamlined command-line tool that enables AI-driven document generation and project workspace management. Built with TypeScript for improved reliability and maintainability.

---

Features

- Initialize a new project workspace with standardized structure - Add and manage project details for better AI context - Generate AI-ready project documentation prompts by category - Pre-configured folder structure for comprehensive documentation - TypeScript-based for improved reliability

Website & Documentation (Coming Soon)

---

Installation

Using NPM

npm install -g @dt-workspace/cli

Using Yarn

yarn global add @dt-workspace/cli

Verify Installation:

dt-workspace --version

---

CLI Usage

Initialize a New Project

dt-workspace init [project_name]

Example:

dt-workspace init myProject

This command:

• Creates a new project folder with the specified name (defaults to "docs" if not provided)
• Sets up a standardized folder structure for documentation
• Creates a .dt-workspace config file at the root
• Initializes empty documentation files ready to be populated

Folder Structure Created

myProject/
├── idea.md
├── research.md
├── architecture.md
├── techstack.md
├── scope_of_work.md
├── backend/
│   ├── schema.md
│   ├── endpoints.md
│   ├── dependency.json
│   ├── controllers.json
│   ├── services.json
│   ├── middleware.json
│   └── events.json
├── features/
├── frontend/
│   ├── sitemap.md
│   ├── wireframes.md
│   ├── design_system.md
│   ├── dependency.json
│   ├── components.json
│   ├── pages.json
│   └── hooks.json
└── testing/
    └── testcases.md

---

Add Project Details

dt-workspace details

This command allows you to:

• Add or update your project name, description, and purpose
• Define the main features of your project
• Save these details for use in AI prompts
• Tailor the AI prompts to your specific project context

---

Generate Documentation Prompts

dt-workspace generate

This command:

• Opens an interactive prompt selection menu
• Lets you choose from different prompt categories:
  • Project prompts (scope of work, features, tech stack)
  • Backend prompts (schema, endpoints, controllers, services, etc.)
  • Frontend prompts (components, pages, hooks, design system, etc.)
• Copies the selected prompt to your clipboard for use with AI tools

These prompts guide AI tools to help you populate specific documentation files with structured, detailed content.

---

Help & Documentation

To view all available commands:

dt-workspace help

Example Output:

**DT-Workspace CLI - Help Guide**
------------------------------------
A command-line tool for managing workspace projects and documentation.

**Usage:**
  dt-workspace init [project_name]            # Create a new project workspace
  dt-workspace details                        # Add/update project details
  dt-workspace generate                       # Interactive prompt selection menu
  dt-workspace --version                      # Show CLI version
  dt-workspace help                           # Show this help message

**Commands:**
  init [project_name]
    - Creates a new workspace project with the specified name (defaults to "docs").
    - Sets up a structured documentation folder with predefined templates.
    - Creates a .dt-workspace config file in the current directory.
    - Example: dt-workspace init myProject

  details
    - Capture and save project details (name, description, purpose, features).
    - This information is used to personalize AI prompts.
    - Example: dt-workspace details

  generate
    - Opens an interactive menu to select prompt categories and specific prompts.
    - Available categories include project, backend, and frontend.
    - Copies the selected AI prompt to your clipboard.
    - Example: dt-workspace generate

  --version
    - Displays the current CLI version.

  help
    - Shows this help message.

**Workspace Structure:**
  The init command creates a folder structure with:
    - Project documentation (idea, research, architecture, etc.)
    - Backend documentation (schema, endpoints, services, controllers, etc.)
    - Frontend documentation (sitemap, wireframes, components, pages, etc.)
    - Testing documentation

------------------------------------
🚀 Happy coding with DT-Workspace CLI!

Author & Contributions

LinkedIn: Deepak Tiwari

---

License

This project is licensed under the DT-Workspace CLI Proprietary License. All rights reserved by Deepak Tiwari. The software may not be reproduced, distributed, or modified without explicit permission.