Deskaid

🚀 使用說明

本項目提供了在 Codemaster 中進行代碼操作、運行示例、配置選項、日誌記錄、調試和類型檢查等功能的詳細說明。

🚀 快速開始

代碼操作界面

在 Codemaster 界面中使用以下命令進行初始化：

mcp init codemaster-config.toml

若要配置 Codemaster，請參考其文檔。

運行示例

運行示例項目，可按以下步驟操作：

cd examples
python3 run_example.py

✨ 主要特性

本項目支持多種配置選項，包括全局配置和項目特定配置，同時提供了日誌記錄、調試和類型檢查等功能。

📦 安裝指南

文檔中未提及安裝步驟，暫不提供相關內容。

💻 使用示例

基礎用法

代碼操作界面初始化

# 在 Codemaster 界面中使用此命令進行初始化
mcp init codemaster-config.toml

運行示例項目

# 進入示例項目目錄
cd examples
# 運行示例項目
python3 run_example.py

高級用法

調試服務器

# 運行帶調試器的服務器
PYTHONPATH=. mcp dev codemcp/__main__.py

類型檢查

# 進行類型檢查
./run_typecheck.sh

📚 詳細文檔

配置選項

全局配置

編輯 ~/.codemcprc 文件以設置全局選項，示例如下：

[global]
# 項目根目錄
project_root = "."
# 日誌級別
log_level = "INFO"

# 語言模型設置
[model]
# 溫度參數
temperature = 0.7
# 最大令牌數
max_tokens = 2048

項目特定配置

在項目根目錄中創建 codemcp.toml 文件進行項目特定配置，示例如下：

[commit]
# 提交消息模板
message_template = "feat: implement {feature} ({issue})"
# 分支名稱
branch_name = "develop"

# 提交選項
[git]
# 遠程倉庫
remote = "origin"
# 是否自動推送
push = true

# 日誌記錄
[logger]
# 是否啟用日誌記錄
enabled = true
# 日誌文件
file = "codemcp.log"
# 日誌級別
level = "INFO"

日誌記錄

日誌文件位於 ~/.codemcp/codemcp.log。日誌級別可以在全局配置文件 ~/.codemcprc 中設置，示例如下：

[logger]
# 日誌詳細程度，可以是 DEBUG, INFO, WARNING, ERROR, 或者 CRITICAL
verbosity = "INFO"

調試

運行帶調試器的服務器，使用以下命令：

PYTHONPATH=. mcp dev codemcp/__main__.py

類型檢查

項目使用 pyright 進行類型檢查，啟用了嚴格模式。類型檢查配置在 pyproject.toml 中。要進行類型檢查，請運行：

./run_typecheck.sh

🔧 技術細節

項目使用 pyright 進行類型檢查，並啟用了嚴格模式，類型檢查配置在 pyproject.toml 中。通過配置全局和項目特定的配置文件，可以靈活設置項目的各種參數，如日誌級別、提交消息模板等。同時，項目支持日誌記錄功能，方便開發者進行調試和問題排查。

📄 許可證

文檔中未提及許可證信息，暫不提供相關內容。