跳到主要内容

入门指南

在5分钟内启动并运行 ArchiCore。

前提条件​

  • Node.js 18 或更高版本
  • npm 或 yarn
  • GitHub 账户（用于 GitHub 集成）

选项1：Web 界面​

通过 Web 界面是最简单的入门方式。

步骤1：创建账户​

  1. 访问 ArchiCore
  2. 点击 注册
  3. 使用邮箱注册或使用 GitHub 登录

步骤2：连接仓库​

  1. 点击侧边栏中的 添加项目
  2. 选择 GitHub 标签
  3. 点击 连接 GitHub 并授权 ArchiCore
  4. 从列表中选择一个仓库
  5. 选择分支并点击 添加项目

步骤3：等待索引​

ArchiCore 将自动索引您的代码库。这通常需要1-5分钟，取决于项目大小。

步骤4：开始探索​

索引完成后，您可以：

  • 查看架构可视化
  • 使用 AI 助手提问
  • 运行分析命令

选项2：CLI​

适合喜欢命令行的开发者。

步骤1：安装​

npm install -g archicore

步骤2：登录​

archicore login

这将打开浏览器窗口进行身份验证。

步骤3：运行 ArchiCore​

cd /您的项目路径
archicore

就这样！ArchiCore 将：

  1. 如果未初始化则自动初始化
  2. 询问是否索引您的项目：现在索引项目？[Y/n]
  3. 准备好后启动交互模式

步骤4：开始使用​

# 交互模式（推荐）
archicore

# 或直接运行命令
archicore search "认证逻辑"
archicore analyze src/auth/
一条命令设置

只需在项目目录中运行 archicore — 其他一切都是自动的！

下一步是什么？​

故障排除​

"命令未找到：archicore"​

确保 npm 全局 bin 在您的 PATH 中：

npm bin -g
export PATH="$(npm bin -g):$PATH"

"认证失败"​

  1. 运行 archicore logout
  2. 再次运行 archicore login
  3. 在浏览器中完成认证

"索引卡住"​

大型项目可能需要更长时间。检查进度：

archicore status

需要帮助？通过应用中的报告问题表单联系支持。