🔱SCAST

基本能力

产品定位

SCAST是一个静态代码分析和可视化工具，旨在帮助开发者通过可视化图表理解代码结构和功能。

核心功能

1. 代码解析与静态分析：支持多种编程语言（JavaScript、TypeScript、C#、Python），将代码解析为AST。
2. 可视化生成：利用Mermaid和D3生成UML图、AST树图和流程图。
3. 代码检索：通过关键字（类名、方法名、字段名）检索源代码定义。
4. AI集成：支持与Ollama AI集成，提供更智能的代码分析。
5. 多种图表类型：包括力导向图、缩进树、径向树等D3图表。

适用场景

1. 代码理解与文档生成：通过可视化图表快速理解代码结构和功能。
2. 代码检索与问答：使用RAG方法通过关键字检索源代码，回答用户问题。
3. 教育与培训：用于教学和培训，帮助学习者理解代码逻辑。
4. 开发效率提升：通过可视化工具加速代码审查和重构。

工具列表

1. scast_analysis：分析代码并生成可视化图表，返回包含类和方法名称的关键字列表及功能解释。
2. scast_retriever：通过关键字检索源代码定义，支持RAG方法。

常见问题解答

1. 如何在线使用SCAST？：访问SCAST在线版。
2. 如何部署SCAST？：下载源码后运行npm run server，或作为MCP服务器集成到AI客户端。
3. 支持哪些编程语言？：目前支持JavaScript、TypeScript、C#和Python，未来计划支持Vue。

使用教程

使用依赖

1. 安装Node.js和npm。
2. 安装Ollama AI（可选，用于AI集成）。

安装教程

1. 克隆源码：git clone https://github.com/davidkingzyb/SCAST.git
2. 安装依赖：npm install
3. 配置MCP客户端：

{
  "mcpServers": {
    "scast":{
      "command":"node",
      "args":[
        "/YOUR_INSTALL_DIR/SCAST/mcp/index.js",
        "/YOUR_WORKSPACE/",
        "C:\\Users\\DKZ\\OTHER_ALLOWED_DIR\\",
      ]
    }
  }
}

调试方式

1. 启动服务器：npm run server
2. 访问本地服务：打开浏览器访问http://localhost:port（具体端口见启动日志）。
3. 检查日志：查看控制台输出以确认服务运行状态。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。