Arcanist 使用教程

Arcanist 使用教程

1. 项目介绍

Arcanist 是一个命令行工具，由 Phacility 公司开发，用于简化代码审查和其他版本控制操作。它是一个封装脚本，集成了如 Differential（代码评审工具）、linter 和单元测试框架等，支持 Git、Mercurial 和 SVN 等多种版本控制系统。通过 Arcanist，你可以方便地执行诸如提交代码、查看审阅、运行集成测试等任务。

2. 项目快速启动

安装依赖

确保你的机器上已经安装了 PHP CLI。如果没有，可以从 PHP 官网 下载并安装。

获取 Arcanist

克隆 Arcanist 的源码到本地：

git clone https://github.com/zhihu/arcanist.git

添加到 PATH

将 arcanist/bin 目录添加到你的系统 PATH 环境变量中：

export PATH="$PATH:/path/to/your/arcanist/bin"

验证安装

在终端输入 arc，你应该能看到类似以下的提示：

Usage Exception: No command provided.
Try 'arc help'.

这说明安装成功了。如果遇到问题，可以参考 Arcanist 提供的相关平台指南，例如 Mac OS X 指南 或 Windows 指南。

升级 Arcanist

要更新到最新版本，执行：

arc upgrade

3. 应用案例和最佳实践

• 代码提交：使用 arc diff 创建一个新的代码审核请求。
• 自动化测试：集成 arc unit 命令，以自动运行项目中的单元测试。
• 代码审查：利用 arc land 来合并经过审核的更改至主分支。
• 环境一致性：鼓励团队成员共享配置文件或使用预定义的开发环境，以保证代码审查的一致性。

4. 典型生态项目

• Phabricator：Arcanist 的核心组件之一，提供了一个完整的代码管理和协作平台。
• libphutil：一个跨语言的库，为 Phabricator 及其相关工具提供辅助功能，包括 Arcanist。
• Differential：Phabricator 中的代码评审工具，可以通过 Arcanist 进行交互。

---

以上是 Arcanist 的基本使用教程，更多详细的命令和配置信息，可访问 Arcanist 的官方文档或使用 arc help 命令获取。祝你在使用过程中一切顺利！