# ASDM Workspace Installation

## Overview

This document provides instructions for installing and setting up the ASDM (AI-assisted Software Development Methodology) workspace. ASDM provides a suite of toolsets that enable AI-assisted software development, including context building, task planning & execution, prototype generation, and basic git operations.

The workspace includes four toolsets:

| Toolset ID | Name | Description |
|---|---|---|
| `basic-tools` | Basic Tools | Basic git operations (commit messages, commits, starting projects) |
| `context-builder` | Context Builder | Build comprehensive context for AI models to work with your codebase |
| `prd-builder` | PRD Builder | Plan and execute tasks for features, generating feature PRDs and task lists |
| `prototype-builder` | Prototype Builder | Rapidly generate frontend prototypes based on requirements and tech stack |

## 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
```

## Installation Steps

### 1. Verify ASDM workspace structure

Verify that the `.asdm` directory and its subdirectories exist:

```bash
# Required directories should already exist:
# .asdm/toolsets/basic-tools
# .asdm/toolsets/context-builder
# .asdm/toolsets/prd-builder
# .asdm/toolsets/prototype-builder
# .asdm/workspace/features
# .asdm/contexts
# .asdm/prototypes

mkdir -p .asdm/workspace/features .asdm/contexts .asdm/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.

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

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

# --- Basic Tools ---
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

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

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

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

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

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

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/`)

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

# --- Basic Tools ---
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

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

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

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

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

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

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 directly use the instruction files by copying their relative paths and entering prompts like:

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

Available instruction files:

| Toolset | Action File | Purpose |
|---|---|---|
| basic-tools | `asdm-start-project.md` | Start project in development mode |
| basic-tools | `asdm-git-commit-message.md` | Generate git commit message |
| basic-tools | `asdm-git-commit.md` | Commit changes |
| context-builder | `asdm-context-build.md` | Generate initial workspace context |
| context-builder | `asdm-context-update.md` | Update workspace context |
| prd-builder | `asdm-prd-planning.md` | Plan tasks for a feature |
| prd-builder | `asdm-prd-breakdown.md` | Break down tasks into PRDs |
| prd-builder | `asdm-prd-execution.md` | Execute a task |
| prototype-builder | `asdm-prototype-create.md` | Generate prototype from requirements |
| prototype-builder | `asdm-prototype-scaffold.md` | Scaffold a new project |

## Initializing the Workspace

After installation, initialize the workspace by following these steps in order:

### Step 1: Build workspace context

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

This generates comprehensive context files in `.asdm/contexts/`, enabling other toolsets to understand the codebase.

### Step 2: Start the project

```shell
Follow the instructions in .asdm/toolsets/basic-tools/actions/asdm-start-project.md
```

This detects the project type, installs dependencies, and starts the development server.

## Available Commands

Once installed, all slash commands are available:

| Command | Toolset | Description |
|---|---|---|
| `/asdm-start-project` | basic-tools | Start project in development mode |
| `/asdm-git-commit-message` | basic-tools | Generate git commit message |
| `/asdm-git-commit` | basic-tools | Commit changes with generated message |
| `/asdm-context-build` | context-builder | Generate initial workspace context |
| `/asdm-context-update` | context-builder | Update workspace context after changes |
| `/asdm-prd-planning` | prd-builder | Plan tasks for a new feature |
| `/asdm-prd-breakdown` | prd-builder | Break down tasks into detailed PRDs |
| `/asdm-prd-execution` | prd-builder | Execute a specific task |
| `/asdm-prototype-create` | prototype-builder | Generate a prototype from requirements |
| `/asdm-prototype-scaffold` | prototype-builder | Scaffold a project with specific tech stack |

## Workspace Directory Structure

```
.asdm/
├── contexts/                           ## Context Builder workspace
│   ├── index.md                        ## Workspace context index
│   ├── architecture.md                 ## System architecture
│   ├── api.md                          ## API definitions
│   ├── data-models.md                  ## Data models
│   ├── deployment.md                   ## Deployment config
│   ├── standard-project-structure.md   ## Project structure standards
│   └── standard-coding-style.md        ## Coding style standards
├── prototypes/                         ## Prototype Builder workspace
├── workspace/
│   └── features/                       ## PRD Builder workspace
│       ├── features-list.md            ## Feature tracking list
│       └── <feature-id>/
│           ├── feature-prd.md          ## Feature PRD
│           ├── task-list.md            ## Task list
│           └── <task-id>-prd.md        ## Task PRDs
└── toolsets/
    ├── basic-tools/                    ## Basic git operations
    ├── context-builder/                ## Context generation
    ├── prd-builder/                    ## Task planning & execution
    └── prototype-builder/             ## Prototype generation
```

## Verification

After installation, verify that:

1. The `.asdm/workspace/features`, `.asdm/contexts`, and `.asdm/prototypes` directories exist
2. Shortcut commands are created in the appropriate provider directory
3. All four toolset directories exist under `.asdm/toolsets/`

## Recommended Workflow

1. **Context** - Use `/asdm-context-build` to generate workspace context
2. **Planning** - Use `/asdm-prd-planning` to plan features and tasks
3. **Breakdown** - Use `/asdm-prd-breakdown` to break down tasks into detailed PRDs
4. **Execution** - Use `/asdm-prd-execution` to execute tasks
5. **Prototyping** - Use `/asdm-prototype-create` to generate UI prototypes
6. **Context Update** - Use `/asdm-context-update` after significant changes
7. **Commit** - Use `/asdm-git-commit-message` then `/asdm-git-commit` to commit work

## Notes

- This installation assumes you have permissions to create directories and files
- The actual command execution is handled by the AI model using the provided templates and instructions
- Customize provider-specific setup based on your actual AI coding assistant
- **For unsupported providers**: Use instruction files directly by referencing their relative paths

## Getting Help

- [ASDM Documentation](https://asdm.ai/docs)
- Individual toolset READMEs:
  - `.asdm/toolsets/basic-tools/README.md`
  - `.asdm/toolsets/context-builder/README.md`
  - `.asdm/toolsets/prd-builder/README.md`
  - `.asdm/toolsets/prototype-builder/README.md`
- Individual toolset INSTALL docs:
  - `.asdm/toolsets/basic-tools/INSTALL.md`
  - `.asdm/toolsets/context-builder/INSTALL.md`
  - `.asdm/toolsets/prd-builder/INSTALL.md`
  - `.asdm/toolsets/prototype-builder/INSTALL.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 the full ASDM workspace setup. For individual toolset details, refer to each toolset's INSTALL.md and README.md.*