Skip to content

ref42/Alfred

Repository files navigation

Alfred logo

Alfred

面向嵌入式与多芯片项目的 CLion 开发环境管家。

构建与发布

English

Alfred 将您当前的 CLion 项目设置和 IDE 配置保存为命名配置文件,在您切换芯片、工具链、SDK、调试器或开发板配置时,可随时在这些配置文件之间切换。

为什么选择 Alfred

CLion 将许多开发选项保存在项目和 IDE 设置中:工具链、CMake 预设、SDK 路径、调试器设置、嵌入式工具以及其他本地配置。一旦某套环境调试完成,事后手动重建既耗时又容易出错。

Alfred 将一个已知可用的 CLion 环境保存为命名配置文件。在环境正确时保存,设置变更时更新,需要该环境时随时切换回来。

平台支持

Alfred 是一个平台无关的 CLion 插件,同一个 alfred.zip 发布包可安装到 Windows、macOS 和 Linux 上的 CLion。

配置文件是本地 CLion 设置的快照,因此可能包含特定于当前机器的路径,例如编译器位置、SDK 路径、调试器路径或探针工具路径。在跨机器或跨操作系统的场景下,建议为每台机器单独保存配置文件,或在保存前在 CLion 中将这些路径统一规范化。

安装

从 GitHub Releases 本地安装

适用于从发布包直接安装的场景:

  1. 打开 Alfred Releases 页面。
  2. 从最新版本下载 alfred.zip
  3. 在 CLion 中打开 Settings | Plugins
  4. 点击齿轮图标。
  5. 选择 Install Plugin from Disk...
  6. 选中下载的 alfred.zip
  7. 根据提示重启 CLion。

从 Marketplace 安装

适用于 Alfred 已上架 JetBrains Marketplace 的场景:

  1. 打开 Settings | Plugins
  2. 选择 Marketplace 标签页。
  3. 搜索 Alfred
  4. 点击 Install
  5. 根据提示重启 CLion。

安装完成后,Alfred 入口位于:

Tools > Alfred

快速上手

  1. 打开您的 CLion 项目。
  2. 为某个目标环境配置 CLion。
  3. 前往 Tools > Alfred > Save Current Config as Profile...
  4. 输入配置文件名称,例如 arm-debug
  5. 为另一个环境修改 CLion 设置。
  6. 再保存一个配置文件,例如 riscv-release
  7. 使用 Tools > Alfred > Switch Profile... 选择所需环境。
  8. 关闭并重新打开 CLion 以激活切换后的配置文件。

日常工作流

保存新配置文件

操作路径:

Tools > Alfred > Save Current Config as Profile...

当您为新芯片、开发板、工具链、SDK、调试器或 CMake 设置完成配置,并希望将其保存为可复用的配置文件时使用。

配置文件名称会自动清理以确保在文件系统中合法,例如空格和特殊字符会被转换为 -

更新当前配置文件

操作路径:

Tools > Alfred > Update Active Profile

当您修改了当前正在使用的配置文件所包含的设置后使用,无需重新输入配置文件名称。

若尚未设置活动配置文件,Alfred 会提示您选择要更新的已保存配置文件。

切换配置文件

操作路径:

Tools > Alfred > Switch Profile...

选择一个已保存的配置文件,然后关闭并重新打开 CLion。Alfred 会在 CLion 关闭时应用配置文件,以便下次启动时干净地加载所选环境。

重启步骤是有意为之的。CLion 和 IntelliJ 平台的许多设置在 IDE 运行时保存于内存中。在运行时应用完整配置文件可能会被 IDE 覆盖,因此 Alfred 将切换操作暂存至下次启动时执行。

Alfred 保存的内容

Alfred 对通常构成 CLion 开发环境的项目和 IDE 配置进行快照:

  • 项目 .idea 设置。
  • CMakePresets.json
  • CMakeUserPresets.json
  • CLion 配置目录中的 CLion IDE 配置文件。

以下运行时/缓存数据不会被复制到配置文件中:

  • 已安装的插件。
  • 日志和临时文件。
  • 事件日志元数据。
  • 锁文件。
  • IDE 数据库文件。

配置文件存储位置

配置文件存储在您的 CLion 配置目录中,而非项目内部:

<CLion 配置目录>/alfred/profiles/

这样可以跨项目使用配置文件,同时避免将本地 IDE 快照污染到源码树中。

Alfred 还会自动迁移旧版存储在项目本地的配置文件:

<project>/clion-dev-envs/

若检测到上述目录,会自动执行迁移。

实践建议

  • 完成目标环境配置后,及时保存或更新配置文件。
  • 在切换到不同目标之前先切换配置文件。
  • 切换后重启 CLion,以确保所选的 IDE 和项目设置被完整加载。
  • 保持源码管理的项目文件与本地 CLion 配置文件数据分离。

许可证

Alfred 在 Apache License 2.0 下发布。详见 LICENSE

About

面向嵌入式与多芯片项目的 CLion 开发环境管家。A CLion dev environment butler for embedded and multi-chip projects.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages