Swark项目安装与配置指南

Swark项目安装与配置指南

swark Create architecture diagrams from code automatically using large language models (LLMs). 项目地址: https://gitcode.com/gh_mirrors/sw/swark

1. 项目基础介绍

Swark是一个开源项目，它是一个Visual Studio Code扩展，可以自动从代码中生成架构图，利用大型语言模型（LLMs）实现。Swark直接集成GitHub Copilot，无需认证或API密钥。它支持多种语言，无缝集成，注重隐私，并使用Mermaid.js框架生成图表。

主要编程语言：TypeScript（99.7%）、JavaScript（0.3%）。

2. 项目使用的关键技术和框架

• 大型语言模型（LLMs）：Swark使用LLMs来理解代码结构并生成架构图。
• GitHub Copilot：集成GitHub Copilot，允许通过VS Code的Language Model API进行LLM请求。
• Mermaid.js：用于生成和显示图表的流行的 diagram-as-code 框架。

3. 项目安装和配置

准备工作

在开始安装之前，请确保您已经完成了以下准备工作：

• 安装了Visual Studio Code。
• 安装了GitHub Copilot扩展（现在提供免费层级）。

安装步骤

1. 打开Visual Studio Code。
2. 转到“扩展市场”（点击左侧的扩展图标或使用快捷键Ctrl+Shift+X）。
3. 在搜索框中输入“Swark”并选择它。
4. 点击“安装”按钮来安装Swark扩展。
5. 安装完成后，您可以通过打开命令面板（Ctrl+Shift+P或Cmd+Shift+P）并输入“Swark: Create Architecture Diagram”来创建架构图。

配置

Swark扩展具有以下可配置的设置：

• swark.maxFiles：读取的最大文件数。
• swark.fileExtensions：包含在搜索中的文件扩展名列表。
• swark.excludePatterns：从文件搜索中排除的glob模式列表。
• swark.languageModel：用于图表生成要使用的语言模型。
• swark.fixMermaidCycles：自动修复生成的Mermaid图中的循环，以防止渲染失败。

您可以通过Visual Studio Code的设置界面或settings.json文件来配置这些设置。

在配置文件中，您可以这样设置：

{
    "swark.maxFiles": 50,
    "swark.fileExtensions": ["js", "ts", "jsx", "tsx", "java", "python", "ruby"],
    "swark.excludePatterns": ["**/node_modules/**", "**/.*"],
    "swark.languageModel": "github-copilot",
    "swark.fixMermaidCycles": true
}

确保根据您的需求调整这些设置。

以上步骤将引导您完成Swark项目的安装和基本配置。您现在可以开始生成代码的架构图了。

swark Create architecture diagrams from code automatically using large language models (LLMs). 项目地址: https://gitcode.com/gh_mirrors/sw/swark