@dt-workspace/cli

🚀 DT-Workspace CLI (v2.1.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
✔️ Generate AI-ready project documentation prompts
✔️ 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
• 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/
├── readme.md
├── techstack.md
└── manager-docs/
    ├── scope_of_work.md
    ├── features/
    │   ├── feature-1.md
    │   └── feature-2.md
    ├── db/
    │   ├── schema.md
    │   ├── procedures.md
    │   ├── functions_aggregation.md
    │   └── triggers.md
    ├── api/
    │   ├── endpoints.md
    │   └── swagger.md
    ├── ui/
    │   ├── design_system.md
    │   ├── sitemap.md
    │   └── storybook.md
    ├── testing/
    │   └── testcases.md
    └── implementation/
        ├── sprint-1.md
        └── sprint-2.md

---

📑 Generate Documentation Prompt

dt-workspace generate

✔ Copies the IT Project Manager prompt to your clipboard for use with AI tools to generate comprehensive project documentation.

This prompt guides AI tools to help you populate the documentation files with structured, detailed content covering:

• Scope of work definition
• Feature specifications
• Database documentation
• API documentation
• UI/UX design documentation
• Testing documentation
• Implementation planning

---

📌 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.

**Usage:**
  dt-workspace init <project_name>            # Create a new project
  dt-workspace generate                       # Copy Project Manager prompt to clipboard
  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.
    - Example: dt-workspace init myProject

  generate
    - Copies an IT Project Manager prompt to the clipboard.
    - Use this prompt with AI tools to create project documentation.

  --version
    - Displays the current CLI version.

  help
    - Shows this help message.

**Example Workflows:**
  1️. Create a new project:
     dt-workspace init myProject

  2️. Generate documentation:
     dt-workspace generate

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

---

📌 Development

This CLI tool is built with TypeScript for improved reliability and maintainability.

Building from Source

# Clone the repository
git clone https://github.com/yourusername/dt-workspace-cli.git

# Install dependencies
cd dt-workspace-cli
npm install

# Build the TypeScript code
npm run build

# Link for local development
npm link

Development Scripts

• npm run build - Compile TypeScript to JavaScript
• npm run dev - Watch for changes and recompile automatically

---

📌 Author & Contributions

👤 Author: Deepak Tiwari

🔗 LinkedIn: Deepak Tiwari

💡 Open for collaborations & contributions! If you find issues or have feature requests, feel free to contribute.

🛠 Contribute:

1. Fork this repository
2. Create a feature branch (feature-new-command)
3. Submit a pull request (PR)

---

📌 License

This project is licensed under the MIT License.

---

🚀 Start Building with DT-Workspace CLI!