Common Workflows

CodeBuddy Code is deeply integrated into daily development workflows. This guide shows how to maximize the value of the AI assistant in various scenarios.

Note: All command examples in this document are based on the actual features of the current version. If a feature is not yet implemented, it will be clearly noted in the relevant sections.

📸 Image Analysis Feature

Supported Image Types

• Screenshots: Interface design, error messages, code snippets

• Architecture Diagrams: System design, flowcharts, UML diagrams

• Design Mockups: UI design, wireframes

• Documents: Handwritten notes, whiteboard content

Usage Methods

1. Drag and Drop Upload

codebuddy
> Analyze this interface design
[Drag image to terminal] # Automatically recognize and process image file

2. File Path Reference

codebuddy
> Implement a React component based on this design mockup @/path/to/design.png
# Or drag the image file to the terminal

3. Clipboard Paste

# macOS
pbpaste | codebuddy -p "What does this error message mean?"

# Linux (requires xclip)
xclip -selection clipboard -o | codebuddy -p "Analyze this architecture diagram"

Practical Scenarios

🎨 UI Implementation

> Implement a responsive navigation bar based on this design mockup
[Upload design image]

AI: I see this is a modern-style navigation bar design, including:
- Left-side logo
- Central navigation menu
- Right-side user avatar and notification button
- Mobile hamburger menu

Let me implement this design for you...

🐛 Error Diagnosis

> What is the cause of this error?
[Upload error screenshot]

AI: From the screenshot, this is a TypeScript type error:
"Property 'user' does not exist on type 'AuthState'"

Issue analysis:
1. The AuthState interface lacks a user property definition
2. It could be that the type definition for the state manager is incomplete

Solution:...

📊 Architecture Analysis

> Help me optimize this system architecture
[Upload architecture diagram]

AI: This is a microservices architecture diagram, and I noticed several points for optimization:

1. **Single Point of Failure Risk**: The API Gateway lacks high availability design
2. **Data Consistency**: Direct database access between services may cause data inconsistencies
3. **Lack of Monitoring**: There is no service monitoring or distributed tracing

Optimization recommendations:...

🔄 --resume Recovery Feature

What is Resume?

The Resume feature allows you to:

• Restore the context of previous conversations

• Continue unfinished tasks

• Maintain work state across different terminal sessions on the same device

Note: Session data is stored locally on the device and does not support synchronization across devices.

Basic Usage

# Restore the most recent conversation
codebuddy --resume

# Restore a specific session
codebuddy --resume session-id-12345

# Interactive session selection
codebuddy --resume

Session Management

Local Session Recovery

# Interactively select the session to restore (only local sessions shown)
codebuddy --resume

# Restore a specific session (if you know the session ID)
codebuddy --resume session-abc123

# Start a new session with a specific session ID
codebuddy --session-id "550e8400-e29b-41d4-a716-446655440000"

# Continue the most recent conversation
codebuddy --continue

Session Storage Explanation:

• Session data is stored in the local device's user directory

• Each device maintains its own session history

• Session IDs are unique to each device, and the same session ID may exist on different devices

Practical Scenarios

📱 Multi-Terminal Development (Same Device)

# In terminal window A
codebuddy --session-id "mobile-app-dev-session"
> Start developing a React Native application
[Do some development work]

# In terminal window B on the same device
codebuddy --resume mobile-app-dev-session
> Continue the previous React Native development, now adding navigation functionality

Limitation Explanation: Session data is stored only on the local device and cannot be synchronized across devices. For cross-device collaboration, it is recommended to use a code repository and document progress.

🔄 Task Switching

# Developing Feature A
codebuddy -p "Implement user registration feature"
[Under development...]

# Urgent bug needs fixing
codebuddy -p "Fix the styling issue on the login page"
[Fix complete]

# Return to Feature A
codebuddy --resume
> Continue developing the user registration feature

💡 Cross-Device Collaboration Suggestions

Since sessions are not synchronized across devices, the following collaboration methods are recommended:

# Method 1: Use Git commit history to record progress
git add . && git commit -m "WIP: Implement user registration feature - form validation complete"
git push origin feature/user-registration

# Method 2: Record progress in the project
echo "## Current Progress\n- [x] Form validation\n- [ ] API integration\n- [ ] Error handling" > PROGRESS.md
git add PROGRESS.md && git commit -m "Update development progress"

# Method 3: Use CodeBuddy to generate work summary
codebuddy -p "Summarize current development progress and next steps" --output-format json > work-summary.json

🔧 Advanced Workflows

1. Code Review Process

Automated Code Review

# Review a single file
codebuddy -p "Review the code quality of this file" src/components/UserForm.tsx

# Review an entire commit
git diff HEAD~1 | codebuddy -p "Review the code changes in this commit"

# Review a Pull Request
gh pr diff 123 | codebuddy -p "Analyze the impact and risks of this PR"

Team Collaboration Review

# Generate a review report (JSON format for easier processing)
codebuddy -p "Generate a detailed code review report" --output-format json > report.json

# Check coding standards
codebuddy -p "Check if the src/ directory follows the team's coding standards"

2. Intelligent Refactoring Workflow

Incremental Refactoring

codebuddy -p "Create a refactoring plan: Migrate Class components to Hooks"

AI will provide:

• 📋 Refactoring task list

• ⚡ Priority sorting

• 🔍 Risk assessment

• 📝 Detailed steps

Batch Refactoring

# Refactor an entire directory
codebuddy -p "Convert all Class components in src/components to function components"

# Update API calls
codebuddy -p "Replace all axios calls with fetch API"

3. Test-Driven Development (TDD)

Test-First Process

codebuddy -p "I want to implement a shopping cart feature, please write test cases first"

Test Coverage Improvement

# Analyze test coverage
npm run test:coverage | codebuddy -p "Analyze the test coverage report and suggest improvements"

# Add tests for uncovered code
codebuddy -p "Add unit tests for src/utils/validation.js"

4. Performance Optimization Workflow

Performance Analysis

# Analyze bundle size
npm run build:analyze | codebuddy -p "Analyze the bundle size and suggest optimization"

# Analyze runtime performance
codebuddy -p "Analyze this performance report"
# Note: Provide performance analysis images via drag and drop or paste

Optimization Implementation

codebuddy -p "Create a performance optimization plan for React application"

🎯 Professional Scenario Applications

Frontend Development

# Component development
codebuddy -p "Create a reusable Table component with sorting and pagination"

# State management
codebuddy -p "Refactor this component to use Zustand instead of Redux"

# Style optimization
codebuddy -p "Convert these CSS styles to Tailwind CSS"

Backend Development

# API design
codebuddy -p "Design RESTful API interfaces for a blog system"

# Database optimization
cat slow-query.sql | codebuddy -p "Optimize the performance of this SQL query"

# Microservices architecture
codebuddy -p "Design a microservices architecture for an e-commerce system"

DevOps

# CI/CD configuration
codebuddy -p "Create GitHub Actions workflow for automated deployment"

# Docker containerization
codebuddy -p "Create a Dockerfile for this Node.js application"

# Monitoring and alerts
codebuddy -p "Design application monitoring and alerting strategy"

💡 Efficiency Improvement Tips

1. Use Aliases to Simplify Commands

# Add to ~/.bashrc or ~/.zshrc
alias cb="codebuddy"
alias cbp="codebuddy -p"
alias cbr="codebuddy --resume"

# Usage
cb "Quickly analyze this error"
cbp "Design database schema"
cbr  # Resume the last session

2. Configuration Management

# View current configuration
codebuddy config list

# Set default model
codebuddy config set model gpt-5

# Get specific configuration
codebuddy config get model

3. Batch Operations

# Batch file processing
find src/ -name "*.js" | xargs -I {} codebuddy -p "Add JSDoc comments to {}"

# Batch code review
git diff --name-only | xargs codebuddy -p "Check the code quality of these files"

🚀 Next Steps

After mastering these workflows, you can:

• Explore IDE Integration - Seamlessly use in your editor

• Learn MCP Extensions - Add custom tools and services

• View Full Command Reference - Master all built-in features

---

The art of workflows is about finding what works best for you ✨

---