swark

环境要求

• 已安装并可正常使用的 VS Code
• 已在 VS Code 中启用 GitHub Copilot（现已免费提供）
• 可访问 VS Code 扩展市场（marketplace.visualstudio.com）的网络环境

安装与启动步骤

1. 1安装 VS Code

   Swark 是一个 VS Code 扩展，需先安装并打开最新版 VS Code 作为运行载体。

2. 2准备 Copilot

   Swark 直接集成 GitHub Copilot，需先启用 Copilot，无需额外认证或 API key。

3. 3安装 Swark 扩展

   在 VS Code 扩展市场搜索 Swark 并安装，或打开市场页面 items?itemName=swark.swark 点击 Install。

4. 4运行生成命令

   打开命令面板，执行 Swark: Create Architecture Diagram；Mac 可按 cmd+shift+r，Windows 按 ctrl+shift+r。

5. 5选择代码文件夹

   在弹出的 Swark 文件搜索中选择要分析的文件夹，作为生成架构图的目标代码范围。

6. 6查看架构图

   等待几秒钟，VS Code 会自动打开一个新标签页，展示依据代码生成的架构图。

如何确认成功

几秒后 VS Code 自动弹出新标签页并显示生成的架构图，即表示运行成功。

常见问题

注意事项

• Swark 依赖 GitHub Copilot 调用大语言模型，使用前请确认 Copilot 已在该 VS Code 中生效。
• 无需在 Swark 中配置任何密钥、端口或路径，安装后即可直接调用命令生成架构图。
• 生成结果由 LLM 依据代码结构推断，图表内容会随所选文件夹范围不同而变化。