Deskaid

🚀 Codemaster Usage Guide

This guide provides a detailed introduction to the usage, configuration, and debugging of Codemaster, helping you quickly get started and use this tool effectively.

🚀 Quick Start

Code Operation Interface

Use the following command in the Codemaster interface:

mcp init codemaster-config.toml

Refer to the Codemaster documentation for configuration details.

Running Examples

Run the example project:

cd examples
python3 run_example.py

✨ Features

Configuration Options

Global Configuration

Edit the ~/.codemcprc file to set global options:

[global]
project_root = "."
log_level = "INFO"

# Language model settings
[model]
temperature = 0.7
max_tokens = 2048

Project-Specific Configuration

Create a codemcp.toml file in the project root directory:

[commit]
message_template = "feat: implement {feature} ({issue})"
branch_name = "develop"

# Commit options
[git]
remote = "origin"
push = true

# Logging
[logger]
enabled = true
file = "codemcp.log"
level = "INFO"

Logging

The log file is located at ~/.codemcp/codemcp.log. The log level can be set in the global configuration file ~/.codemcprc:

[logger]
verbosity = "INFO"  # Can be DEBUG, INFO, WARNING, ERROR, or CRITICAL

Debugging

Run the server with a debugger:

PYTHONPATH=. mcp dev codemcp/__main__.py

Type Checking

The project uses pyright for type checking with strict mode enabled. The type checking configuration is in pyproject.toml. To perform type checking, run:

./run_typecheck.sh