ARC Visualizer
ARC Visualizer 是一个面向 ARC 流程的 VS Code 插件,用来连接 ARC src、Requirement 需求目录和用户指定的软件输出目录,并以 Canvas 和 Traceability 的形式展示编译结果。
使用前提
- VS Code
1.134.0+
- Python
3.11+
- 一个可用的
ARC src 目录,内含 main.py 和 requirements.txt
- 一个
Requirement 需求目录,内含 requirements.yaml 或 requirements.yml
- 一个用户指定的软件输出目录,最开始可以是空目录
- 可用的 OpenAI 兼容 API 配置
端到端流程
- 打开
ARC src 目录
- 运行
ARC Visualizer: Initialize ARC Environment
- 运行
ARC Visualizer: Open Software Directory,选择软件输出目录并自动绑定
- 运行
ARC Visualizer: Import Requirement Directory,导入需求目录
- 运行
ARC Visualizer: Open Canvas
- 点击 Canvas 右上角的
Run 开始编译
- 使用 Canvas、Traceability 和 Requirement Editor 查看结果
补充:如果进入软件输出目录的新窗口后找不到插件命令,通常是 VS Code 受限模式导致的。点击左下角“信任”后再执行命令。
三个目录的角色
ARC src 目录:ARC 的执行目录,初始化和编译都在这里发生
- 软件输出目录:结果落盘目录,
.arc 数据会写到这里
Requirement 目录:需求输入目录,提供需求树和参考素材
命令
ARC Visualizer: Open Software Directory
ARC Visualizer: Initialize ARC Environment
ARC Visualizer: Import Requirement Directory
ARC Visualizer: Open Canvas
ARC Visualizer: Run ARC Compile
ARC Visualizer: Stop ARC Run
ARC Visualizer: Open Requirement Editor
不建议把未在文档中列出的内部命令当作常规入口使用。
运行和输出
标准编译入口是点击 Canvas 右上角的 Run。
ARC Visualizer: Run ARC Compile 是等效命令入口。
编译进程在 ARC src 目录中启动,结果写入软件输出目录。
编译完成后,软件输出目录通常会包含:
.arc/requirement
.arc/node_sessions
.arc/traceability
.arc/processing_queue.json
Canvas 和 Traceability 会从这里读取最新状态。
跨平台说明
插件支持 Windows、Linux 和 macOS。
其中 ARC 编译依赖 Python 3.11+,停止运行在 Windows 上使用 taskkill,在 Linux/macOS 上使用进程信号。
打包
如果要发布插件,others/ 和 task.md 已经通过 .vscodeignore 排除,不会被 vsce package 打进去。
配置
插件会同步这些环境配置到 ARC src/.env:
OPENAI_API_KEY
OPENAI_BASE_URL
MODEL
ARC_OPENAI_API_MODE
VISUAL_API_KEY
VISUAL_BASE_URL
VISUAL_MODEL
ARC_DEBUG
ARC_STRUCTURED_OUTPUT_RETRY_COUNT
| |