# ASDM Workspace Installation Guide

## Overview

This document provides instructions for installing and setting up all ASDM toolsets in this workspace. The workspace includes four toolsets:

| Toolset | ID | Description |
|---------|----|-------------|
| Basic Tools | `basic-tools` | Git operations (commit messages, commits) and project startup |
| Context Builder | `context-builder` | Build comprehensive context for AI models to understand your codebase |
| PRD Builder | `prd-builder` | Plan and execute feature tasks with PRD documents and task tracking |
| Prototype Builder | `prototype-builder` | Rapidly generate frontend prototypes from requirements |

## AI Guided Installation

To install all toolsets using AI Guided Installation, copy and paste the following prompt into your AI Coding tool's chat window:

```shell
Follow instructions in .workspace/INSTALL.md
```

To install an individual toolset, use its specific INSTALL.md:

```shell
Follow instructions in .asdm/toolsets/<toolset-id>/INSTALL.md
```

## Installation Steps

### 1. Create workspace directories

Create the directory structure required by all toolsets:

```bash
mkdir -p .asdm/contexts
mkdir -p .asdm/workspace/features
mkdir -p .asdm/prototypes
```

These directories are used by:

- **Context Builder**: `.asdm/contexts/` - stores generated context files
- **PRD Builder**: `.asdm/workspace/features/` - stores feature PRDs and task lists
- **Prototype Builder**: `.asdm/prototypes/` - stores generated prototypes

### 2. Detect the current Agentic Engine provider

Detect the current AI coding assistant provider using the following guidelines:

- If `.claude` directory exists, use **Claude Code**
- If `.github` directory exists, use **GitHub Copilot**
- If `.codebuddy` directory exists, use **Tencent CodeBuddy**
- If no such folder is found, prompt the user to select a provider manually

### 3. Create shortcut commands for all toolsets

Create shortcut commands in the appropriate location based on the detected provider. The installation process is consistent across all providers - we use `cat` to concatenate provider-specific frontmatter with the actual instruction content.

#### For Claude Code (` .claude/commands/`)

Claude Code uses Markdown files with Frontmatter metadata for slash commands. Create commands by concatenating Claude-specific frontmatter with instruction content:

```bash
mkdir -p .claude/commands/

# === Basic Tools ===

# Start Project command
cat > .claude/commands/asdm-start-project.md << 'EOF'
---
description: "Detect workspace context and start the project in development mode"
argument-hint: "[optional: specific environment]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-start-project.md >> .claude/commands/asdm-start-project.md

# Generate Git Commit Message command
cat > .claude/commands/asdm-git-commit-message.md << 'EOF'
---
description: "Generate a standard git commit message based on current changes"
argument-hint: "[optional: custom scope or context]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md >> .claude/commands/asdm-git-commit-message.md

# Git Commit command
cat > .claude/commands/asdm-git-commit.md << 'EOF'
---
description: "Commit changes to the current branch with generated commit message"
argument-hint: "[optional: specific files to commit]"
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit.md >> .claude/commands/asdm-git-commit.md

# === Context Builder ===

# Context Generation command
cat > .claude/commands/asdm-context-build.md << 'EOF'
---
description: "Generate initial context for the workspace"
argument-hint: "[additional prompt]"
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-build.md >> .claude/commands/asdm-context-build.md

# Context Update command
cat > .claude/commands/asdm-context-update.md << 'EOF'
---
description: "Update existing context when workspace changes"
argument-hint: "[additional prompt]"
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-update.md >> .claude/commands/asdm-context-update.md

# === PRD Builder ===

# Task Planning command
cat > .claude/commands/asdm-prd-planning.md << 'EOF'
---
description: "Plan tasks for a workspace feature"
argument-hint: "[feature description]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md >> .claude/commands/asdm-prd-planning.md

# Task Breakdown command
cat > .claude/commands/asdm-prd-breakdown.md << 'EOF'
---
description: "Break down tasks for a workspace feature"
argument-hint: "[feature ID or name]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md >> .claude/commands/asdm-prd-breakdown.md

# Task Execution command
cat > .claude/commands/asdm-prd-execution.md << 'EOF'
---
description: "Execute tasks for a workspace feature"
argument-hint: "[task ID]"
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md >> .claude/commands/asdm-prd-execution.md

# === Prototype Builder ===

# Prototype Create command
cat > .claude/commands/asdm-prototype-create.md << 'EOF'
---
description: "Generate a complete prototype from requirements"
argument-hint: "[requirements description]"
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md >> .claude/commands/asdm-prototype-create.md

# Prototype Scaffold command
cat > .claude/commands/asdm-prototype-scaffold.md << 'EOF'
---
description: "Scaffold a new project with specific tech stack"
argument-hint: "[project name]"
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md >> .claude/commands/asdm-prototype-scaffold.md
```

#### For GitHub Copilot (` .github/prompts/`)

GitHub Copilot uses `.prompt.md` files with YAML frontmatter. Create prompt files by concatenating GitHub-specific frontmatter with instruction content:

```bash
mkdir -p .github/prompts/

# === Basic Tools ===

# Start Project prompt
cat > .github/prompts/asdm-start-project.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Detect workspace context and start the project in development mode'
argument-hint: 'Enter optional environment or leave blank'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-start-project.md >> .github/prompts/asdm-start-project.prompt.md

# Generate Git Commit Message prompt
cat > .github/prompts/asdm-git-commit-message.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate a standard git commit message based on current changes'
argument-hint: 'Enter optional scope or context'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md >> .github/prompts/asdm-git-commit-message.prompt.md

# Git Commit prompt
cat > .github/prompts/asdm-git-commit.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Commit changes to the current branch with generated commit message'
argument-hint: 'Enter optional specific files to commit'
---

EOF
cat .asdm/toolsets/basic-tools/actions/asdm-git-commit.md >> .github/prompts/asdm-git-commit.prompt.md

# === Context Builder ===

# Context Generation prompt
cat > .github/prompts/asdm-context-build.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate initial context for the workspace'
argument-hint: 'Enter additional prompt'
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-build.md >> .github/prompts/asdm-context-build.prompt.md

# Context Update prompt
cat > .github/prompts/asdm-context-update.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Update existing context when workspace changes'
argument-hint: 'Enter additional prompt'
---

EOF
cat .asdm/toolsets/context-builder/actions/asdm-context-update.md >> .github/prompts/asdm-context-update.prompt.md

# === PRD Builder ===

# Task Planning prompt
cat > .github/prompts/asdm-prd-planning.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Plan tasks for a workspace feature'
argument-hint: 'Enter feature description'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md >> .github/prompts/asdm-prd-planning.prompt.md

# Task Breakdown prompt
cat > .github/prompts/asdm-prd-breakdown.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Break down tasks for a workspace feature'
argument-hint: 'Enter feature ID or name'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md >> .github/prompts/asdm-prd-breakdown.prompt.md

# Task Execution prompt
cat > .github/prompts/asdm-prd-execution.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Execute tasks for a workspace feature'
argument-hint: 'Enter task ID'
---

EOF
cat .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md >> .github/prompts/asdm-prd-execution.prompt.md

# === Prototype Builder ===

# Prototype Create prompt
cat > .github/prompts/asdm-prototype-create.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Generate a complete prototype from requirements'
argument-hint: 'Enter requirements description'
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md >> .github/prompts/asdm-prototype-create.prompt.md

# Prototype Scaffold prompt
cat > .github/prompts/asdm-prototype-scaffold.prompt.md << 'EOF'
---
agent: 'agent'
description: 'Scaffold a new project with specific tech stack'
argument-hint: 'Enter project name'
---

EOF
cat .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md >> .github/prompts/asdm-prototype-scaffold.prompt.md
```

#### For Tencent CodeBuddy (` .codebuddy/commands/`)

CodeBuddy doesn't support frontmatter, so simply copy the instruction files as-is:

```bash
mkdir -p .codebuddy/commands/

# === Basic Tools ===
cp .asdm/toolsets/basic-tools/actions/asdm-start-project.md .codebuddy/commands/
cp .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md .codebuddy/commands/
cp .asdm/toolsets/basic-tools/actions/asdm-git-commit.md .codebuddy/commands/

# === Context Builder ===
cp .asdm/toolsets/context-builder/actions/asdm-context-build.md .codebuddy/commands/
cp .asdm/toolsets/context-builder/actions/asdm-context-update.md .codebuddy/commands/

# === PRD Builder ===
cp .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md .codebuddy/commands/
cp .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md .codebuddy/commands/
cp .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md .codebuddy/commands/

# === Prototype Builder ===
cp .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md .codebuddy/commands/
cp .asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md .codebuddy/commands/
```

### 4. Manual Usage for Other Providers

If your AI coding assistant provider is not detected, you can still use the toolsets manually by copying instruction file relative paths and pasting them into your AI assistant's chat window:

```
Follow the instructions in {relative path to instruction file}
```

Available instruction files:

| Toolset | Action | File |
|---------|--------|------|
| Basic Tools | Start Project | `.asdm/toolsets/basic-tools/actions/asdm-start-project.md` |
| Basic Tools | Generate Commit Message | `.asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md` |
| Basic Tools | Git Commit | `.asdm/toolsets/basic-tools/actions/asdm-git-commit.md` |
| Context Builder | Context Build | `.asdm/toolsets/context-builder/actions/asdm-context-build.md` |
| Context Builder | Context Update | `.asdm/toolsets/context-builder/actions/asdm-context-update.md` |
| PRD Builder | Task Planning | `.asdm/toolsets/prd-builder/actions/asdm-prd-planning.md` |
| PRD Builder | Task Breakdown | `.asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md` |
| PRD Builder | Task Execution | `.asdm/toolsets/prd-builder/actions/asdm-prd-execution.md` |
| Prototype Builder | Prototype Create | `.asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md` |
| Prototype Builder | Prototype Scaffold | `.asdm/toolsets/prototype-builder/actions/asdm-prototype-scaffold.md` |

## Available Commands

Once installed, the following commands are available:

| Command | Toolset | Description |
|---------|---------|-------------|
| `/asdm-start-project` | Basic Tools | Start the project in development mode |
| `/asdm-git-commit-message` | Basic Tools | Generate a standard git commit message |
| `/asdm-git-commit` | Basic Tools | Commit changes with generated commit message |
| `/asdm-context-build` | Context Builder | Generate initial context for the workspace |
| `/asdm-context-update` | Context Builder | Update existing context when workspace changes |
| `/asdm-prd-planning` | PRD Builder | Plan tasks for a new feature |
| `/asdm-prd-breakdown` | PRD Builder | Break down tasks into detailed PRD documents |
| `/asdm-prd-execution` | PRD Builder | Execute a specific task |
| `/asdm-prototype-create` | Prototype Builder | Generate a complete prototype from requirements |
| `/asdm-prototype-scaffold` | Prototype Builder | Scaffold a new project with specific tech stack |

## Recommended Workflow

For best results, follow this workflow after installation:

### Step 1: Build Context (Context Builder)

```shell
Follow the instructions in .asdm/toolsets/context-builder/actions/asdm-context-build.md
```

This generates comprehensive context files that other toolsets can reference.

### Step 2: Plan Features (PRD Builder)

```shell
Follow the instructions in .asdm/toolsets/prd-builder/actions/asdm-prd-planning.md
```

### Step 3: Break Down and Execute Tasks (PRD Builder)

```shell
Follow the instructions in .asdm/toolsets/prd-builder/actions/asdm-prd-breakdown.md
Follow the instructions in .asdm/toolsets/prd-builder/actions/asdm-prd-execution.md
```

### Step 4: Create Prototypes (Prototype Builder)

```shell
Follow the instructions in .asdm/toolsets/prototype-builder/actions/asdm-prototype-create.md
```

### Step 5: Commit Changes (Basic Tools)

```shell
Follow the instructions in .asdm/toolsets/basic-tools/actions/asdm-git-commit-message.md
Follow the instructions in .asdm/toolsets/basic-tools/actions/asdm-git-commit.md
```

## Verification

After installation, verify that:

1. Workspace directories exist:
   - `.asdm/contexts/`
   - `.asdm/workspace/features/`
   - `.asdm/prototypes/`
2. Shortcut commands are created in the appropriate provider directory
3. Toolset files are located in `.asdm/toolsets/<toolset-id>/`

## Workspace Structure

```
.asdm/
├── contexts/                          # Context Builder output
│   ├── index.md
│   ├── standard-project-structure.md
│   ├── standard-coding-style.md
│   ├── data-models.md
│   ├── deployment.md
│   ├── api.md
│   └── architecture.md
├── workspace/
│   └── features/                      # PRD Builder output
│       ├── <feature-id>-<feature-name>/
│       │   ├── feature-prd.md
│       │   ├── task-list.md
│       │   └── <task-id>-<task-name>-prd.md
│       └── features-list.md
├── prototypes/                        # Prototype Builder output
└── toolsets/                          # Toolset source files
    ├── basic-tools/
    ├── context-builder/
    ├── prd-builder/
    └── prototype-builder/
```

## Notes

- This installation process assumes you have the necessary permissions to create directories and files
- The actual implementation of commands is handled by the AI model using templates and instructions in each toolset
- Customize provider-specific setup based on your actual AI coding assistant
- Each toolset ID should be used consistently when referring to toolsets in commands and documentation
- Context Builder provides context injection for other toolsets - run it first for best results

## Getting Help

For issues with ASDM toolsets, refer to:

- [ASDM Documentation](https://asdm.ai/docs)
- Individual toolset READMEs in `.asdm/toolsets/<toolset-id>/README.md`

## License

Copyright (c) 2026 LeansoftX.com & iSoftStone. All rights reserved.

Licensed under the PROPRIETARY SOFTWARE LICENSE. See [LICENSE](LICENSE) in the project root for license information.

---

*This installation document covers all ASDM toolsets in this workspace. Use individual toolset INSTALL.md files for toolset-specific installation details.*