← Back to Skills Marketplace
805
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install project-summary
Description
Generate an instant codebase overview — language, framework, architecture, entry points, and key files
Usage Guidance
This skill is coherent and lightweight: it simply inspects files in a repository to produce a summary and does not request credentials or install anything. Before running it, ensure the repository doesn't contain secrets or private credentials you don't want inspected or summarized (for example .env files or keys committed to the repo). Review the generated summary before sharing it externally. If you rely on a private framework-detection table referenced in the doc ('readme-generator'), ask where that logic lives if you need exact framework-matching behavior.
Capability Analysis
Type: OpenClaw Skill
Name: project-summary
Version: 1.0.0
The skill bundle aims to generate a project summary, which is a benign purpose. However, the `SKILL.md` file contains direct `bash` and `powershell` commands (`find`, `ls`, `grep`) embedded within the instructions for the AI agent. While these commands are used for legitimate information gathering (e.g., detecting languages, entry points, test files) and are read-only in nature, their direct inclusion as executable instructions for an AI agent represents a potential shell injection vulnerability. If the agent executes these commands without robust sandboxing or input sanitization, a malicious project could craft file names or content to exploit this capability, even though the commands provided in this skill are not themselves malicious.
Capability Assessment
Purpose & Capability
The name/description match the runtime instructions: the SKILL.md describes scanning repository manifests, configs, source directories, CI files, and tests to produce a summary. It declares no binaries, env vars, or installs that would be unrelated to summarizing a codebase.
Instruction Scope
The instructions direct the agent to read many repo files and to run local shell commands (find, grep, sed, ls, PowerShell equivalents) which is appropriate for codebase analysis. It does not instruct data transmission to external endpoints. Caution: reading the whole repository can surface secrets or sensitive files if present; the skill notes skip patterns for common generated dirs but will still read root and config files (CI, Dockerfile, etc.). It also references an external 'readme-generator' skill for framework detection, which is an external dependency in logic but not code.
Install Mechanism
No install spec and no code files are present (instruction-only). Nothing is written to disk or downloaded by the skill itself, which minimizes install-time risk.
Credentials
The skill requires no environment variables, credentials, or config paths. Its only I/O is reading repository files and running local inspection commands, which is proportionate to the stated goal.
Persistence & Privilege
always:false and there are no instructions to modify agent or system configuration. The skill can be invoked autonomously by agents (platform default) but that is not combined here with additional privileges or credential access.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install project-summary - After installation, invoke the skill by name or use
/project-summary - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release: Instantly generate a structured codebase summary for fast onboarding and AI context.
- Scans project root files for language, framework, and architecture patterns
- Detects entry points, key files, and directory structure
- Summarizes test setup and CI/CD pipeline if present
- Catalogs top dependencies and their purpose
- Handles edge cases (monorepos, large/multi-language repos, missing manifests)
- Outputs a concise Markdown summary suitable for developers or agents
Metadata
Frequently Asked Questions
What is Project Summary?
Generate an instant codebase overview — language, framework, architecture, entry points, and key files. It is an AI Agent Skill for Claude Code / OpenClaw, with 805 downloads so far.
How do I install Project Summary?
Run "/install project-summary" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Project Summary free?
Yes, Project Summary is completely free (open-source). You can download, install and use it at no cost.
Which platforms does Project Summary support?
Project Summary is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Project Summary?
It is built and maintained by Fratua (@fratua); the current version is v1.0.0.
More Skills