Aidermacs 使用教程

Aidermacs 使用教程

aidermacs AI Pair Programming in Emacs with Aider 项目地址: https://gitcode.com/gh_mirrors/ai/aidermacs

1. 项目目录结构及介绍

Aidermacs 是一个将 AI 功能集成到 Emacs 编辑器中的开源项目。以下是项目的目录结构及其简要介绍：

aidermacs/
├── .gitignore                # 指定 Git 忽略的文件和目录
├── .elpaignore               # 指定 Elpa 忽略的文件和目录
├── CONTRIBUTING.md           # 贡献指南
├── CHANGELOG.md              # 更改日志
├── LICENSE                   # 项目许可证
├── README.md                 # 项目自述文件
├── aidermacs-backend-comint.el # 后端集成相关文件
├── aidermacs-backend-vterm.el # 后端集成相关文件
├── aidermacs-backends.el     # 后端管理相关文件
├── aidermacs-models.el       # 模型选择相关文件
├── aidermacs-output.el       # 输出管理相关文件
├── aidermacs.el              # 主程序文件
├── aidermacs.png             # 项目图标
└── introscreen.png           # 项目启动画面

• .gitignore 和 .elpaignore 文件用于管理版本控制和包管理器应忽略的文件。
• CONTRIBUTING.md 包含了为项目贡献代码的指南。
• CHANGELOG.md 记录了项目的版本更新和功能变更历史。
• LICENSE 文件说明了项目的许可协议。
• README.md 提供了项目的概述和使用说明。
• 其他 .el 文件是 Emacs Lisp 代码文件，包含了项目的核心功能。

2. 项目的启动文件介绍

Aidermacs 的启动主要依赖于 Emacs 的配置文件 init.el。以下是一个示例配置，它将 Aidermacs 集成到 Emacs 中，并设置了一些基本快捷键：

(use-package aidermacs
  :bind (("C-c a" . aidermacs-transient-menu))
  :config
  (setenv "ANTHROPIC_API_KEY" "sk-...")
  (setenv "OPENROUTER_API_KEY" (my-get-openrouter-api-key))
  :custom
  (aidermacs-use-architect-mode t)
  (aidermacs-default-model "sonnet"))

在上述配置中，C-c a 被绑定到 aidermacs-transient-menu，这是访问 Aidermacs 功能的主要入口。此外，还需要设置 API 密钥环境变量，这些可以在 .bashrc 或其他适合的位置设置。

3. 项目的配置文件介绍

Aidermacs 的配置主要通过两个方式完成：环境变量和 Emacs 配置文件。

• 环境变量：如上所述，ANTHROPIC_API_KEY 和 OPENROUTER_API_KEY 需要在系统的环境变量中设置，以确保 Aidermacs 可以访问必要的 API。

• Emacs 配置文件：init.el 是 Emacs 的主配置文件，用于加载 Aidermacs 和其他包，以及设置快捷键和自定义变量。以下是一些重要的自定义变量：

  (setq aidermacs-use-architect-mode t)   ; 启用架构模式
  (setq aidermacs-default-model "sonnet") ; 设置默认的 AI 模型
  

在配置文件中，可以进一步自定义 Aidermacs 的行为，以满足个人偏好和项目需求。

aidermacs AI Pair Programming in Emacs with Aider 项目地址: https://gitcode.com/gh_mirrors/ai/aidermacs