Development

Development Documentation

Complete guide for contributors to DoPlan CLI development.

---

Building from Source

Prerequisites

• Go >= 1.23.0
• Git (for version detection)
• Make (optional, for build commands)

Quick Build

# Build for current platform
make build

# Or use Go directly
go build -o doplan ./cmd/doplan

Build for All Platforms

# Using Make
make build-all

# Or using build script
bash scripts/build.sh

# On Windows
scripts\build.bat

Build with Version

# Set version explicitly
VERSION=1.0.0 make build

# Or with Go (resolve module path dynamically to keep casing accurate)
MODULE_PATH=$(go list -m)
go build -ldflags "-X ${MODULE_PATH}/internal/version.Version=1.0.0" -o doplan ./cmd/doplan

---

Development Environment Setup

1. Clone Repository

git clone https://github.com/DoPlan-dev/CLI.git
cd CLI

2. Install Dependencies

go mod download

3. Build Project

make build

4. Verify Installation

./doplan --version

---

Project Structure for Contributors

Directory Structure

CLI/
├── cmd/doplan/          # Main application entry point
├── internal/
│   ├── cli/             # CLI command definitions
│   ├── tui/             # Terminal UI (Bubbletea)
│   ├── generator/       # Project generation logic
│   └── rules/           # Rules library management
├── pkg/models/          # Data models
├── scripts/             # Build and utility scripts
├── docs/                # Documentation
└── test/                # Test files

Key Files

• cmd/doplan/main.go - Application entry point
• internal/cli/root.go - CLI root command
• internal/tui/wizard.go - TUI wizard
• internal/generator/generator.go - Main generator
• internal/rules/rules.go - Rules extraction

---

Running Tests

Run All Tests

make test

# Or
go test ./...

Run Tests with Coverage

make test-coverage

# Or
go test -cover ./...

Run Specific Tests

go test -run TestName ./internal/generator

Run Integration Tests

go test -tags=integration ./...

---

Debugging

Debug Mode

Enable debug logging:

export DOPLAN_DEBUG=1
./doplan

Using Delve Debugger

# Install Delve
go install github.com/go-delve/delve/cmd/dlv@latest

# Debug
dlv debug ./cmd/doplan

Print Debugging

Add debug prints:

if os.Getenv("DOPLAN_DEBUG") == "1" {
    fmt.Printf("Debug: %v\n", value)
}

---

Release Process

1. Update Version

Update version in:

• internal/version/version.go
• package.json

2. Update CHANGELOG

Add release notes to CHANGELOG.md

3. Create Release Tag

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

4. GitHub Actions

The release workflow automatically:

• Builds binaries for all platforms
• Creates GitHub Release
• Uploads binaries and checksums

---

Development Workflow

1. Create Feature Branch

git checkout -b feature/your-feature

2. Make Changes

• Write code
• Add tests
• Update documentation

3. Test Changes

make test
make build

4. Commit Changes

Use Conventional Commits:

git commit -m "feat: add new feature"

5. Push and Create PR

git push origin feature/your-feature

Create pull request on GitHub.

---

Development Examples

Example 1: Adding a New Agent

1. Add Agent Definition:

   // In internal/generator/agents.go
   {
       Name: "New Agent",
       Role: "Agent role",
       // ...
   }

2. Create Agent Template:

   // In internal/generator/agents.go
   func generateNewAgent() string {
       // Agent template
   }

3. Test:

   go test ./internal/generator

---

Example 2: Adding a New Command

1. Add Command Definition:

   // In internal/generator/commands.go
   {
       Name: "newcommand",
       Trigger: "/newcommand",
       // ...
   }

2. Create Command Template:

   // In internal/generator/commands.go
   func generateNewCommand() string {
       // Command template
   }

3. Test:

   go test ./internal/generator

---

Example 3: Adding a New Rule

1. Add Rule File:

   internal/rules/library/XX-category/new-rule.md
   

2. Update Rules: Rules are automatically embedded via //go:embed

3. Test:

   go test ./internal/rules

---

Troubleshooting

Issue: Build Fails

Solution:

1. Check Go version: go version
2. Update dependencies: go mod download
3. Clean build: make clean && make build

---

Issue: Tests Fail

Solution:

1. Run tests individually: go test -v ./internal/generator
2. Check test files for issues
3. Verify test data

---

Issue: Binary Too Large

Solution:

1. Check embedded files size
2. Optimize rules library
3. Use compression if needed

---

Code Style

Formatting

make fmt

# Or
go fmt ./...

Linting

make lint

# Or
golangci-lint run

Style Guidelines

• Follow Effective Go
• Use gofmt for formatting
• Document exported functions
• Write tests for new code

---

Related Pages

• Contributing Guide - How to contribute
• API Reference - API documentation
• Project Structure - System architecture and structure
• Home - Wiki home page

---

Last Updated: 2025
Maintained By: Documentation Team