Code Project Auto Analyzer
自动分析任意代码目录的结构与内容,识别项目主要功能、模块划分、技术栈,自动生成规范的项目介绍文档,包含基础功能、应用场景、实现原理三个核心部分。使用当需要快速了解陌生项目结构、生成项目README/介绍文档、梳理代码架构时触发。
MIT-0 · Free to use, modify, and redistribute. No attribution required.
⭐ 1 · 200 · 4 current installs · 4 all-time installs
by@ttjsndx
MIT-0
Security Scan
OpenClaw
Benign
high confidencePurpose & Capability
Name/description claim to analyze local code projects and produce documentation, and the included index.js implements exactly that: scanning files, detecting common manifest files, summarizing directories, and generating a Markdown report. No unrelated credentials, remote APIs, or unrelated binaries are requested.
Instruction Scope
SKILL.md instructs the agent to scan a specified local path and generate a doc. The implementation only reads project files (package.json, README.md, manifests) and directory entries (skips node_modules/venv and dotfiles), limits recursion depth, and optionally writes an output file. It does not instruct the agent to read unrelated system files, environment variables, or transmit data externally.
Install Mechanism
There is no automated install spec in the registry entry (instruction-only skill). README suggests cloning from a Git host, but that is a user-facing install hint rather than an automated download step. No archives or remote installers are executed by the skill itself.
Credentials
The skill declares no required environment variables, no credentials, and no config paths. The code only needs local filesystem access (Node.js runtime), which is proportionate to the stated functionality.
Persistence & Privilege
Skill flags show default behavior (always: false) and allow user invocation. It does not request permanent presence, nor does it modify other skills or system-wide settings. Autonomous invocation is allowed by platform default but is not combined with other red flags here.
Assessment
This skill appears coherent and implements exactly what it claims: scanning a local project directory and producing a Markdown introduction. Before installing or running it, consider: (1) it requires Node.js and filesystem read/write access — avoid pointing it at sensitive system or credential directories; (2) the README suggests cloning from a third‑party Git host (gitcode.com) — verify the source and integrity of the repository you install; (3) review the included index.js (present here) yourself if you have concerns — it performs only reads/writes and contains no network calls or shell execution. If you want extra caution, run it on a copy of the repository or in an isolated environment.Like a lobster shell, security has layers — review code before you run it.
Current versionv1.0.0
Download zipauto-doc-generatorcode-analysislatestproject-documentation
License
MIT-0
Free to use, modify, and redistribute. No attribution required.
SKILL.md
代码项目分析助手
功能说明
扫描指定代码目录,自动完成:
- 识别项目技术栈、依赖、核心入口文件
- 分析模块划分与目录结构职责
- 提炼项目核心功能、应用场景
- 总结核心实现原理与架构特点
- 输出标准化的项目介绍文档(支持Markdown格式)
触发关键词
- "分析这个项目"
- "生成项目介绍文档"
- "梳理代码结构"
- "这个项目是干啥的"
- "帮我看下这个代码库的架构"
使用方法
分析代码目录 <本地路径>
生成项目介绍文档到 <输出路径>
梳理 <路径> 的代码架构
支持的项目类型
- 前端项目(JS/TS/Vue/React等)
- 后端项目(Node.js/Python/Go/Java等)
- 工具类项目、脚本项目
依赖
- Node.js 18+
- 本地文件读取权限
Files
3 totalSelect a file
Select a file to preview.
Comments
Loading comments…
