walnut-register-repo

Solid

Deep-explore current codebase and register it as a Walnut repository. Produces a rich profile: what the project does, architecture overview, key components, tech stack, and common workflows. Use when user says "register repo", "add this repo", "/walnut-register-repo", or wants to create a Walnut repository profile for the current project.

AI & Automation 32 stars 8 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
51
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Register Repository Explore this codebase and produce a rich, structured repository profile. ## Goal Create a YAML file at `~/.open-walnut/repositories/{slug}.yaml` that genuinely captures what this project is, how it works, and how to work with it. Someone reading this profile should understand the project without opening a single file. ## How to explore Start with a quick broad scan — directory structure, README, package manifest — to get the lay of the land. Based on what you find, decide what needs deeper investigation. Use sub-agents for parallel deep dives into areas you identify as important. You decide the exploration strategy. A React SPA needs different investigation than a microservice or a CLI tool. Go where the interesting stuff is. **Quality bar**: "A web application built with React" is useless. "Real-time collaborative document editor with CRDTs for conflict resolution, React frontend with ProseMirror, and WebSocket sync server" is what we want. ## Output Format Write the YAML to `~/.open-walnut/repositories/{slug}.yaml`: ```yaml name: Project Name description: >- 1-3 sentences. Specific about what it does, not generic. This shows in listings and the main agent's system prompt. tech_stack: [Lang, Framework, DB, ...] hosts: local: path: /absolute/path # use current working directory overview: | ## What What this project does — be specific. ## Why Why it exists — what problem, who uses it. ## How High-level how it works — t...

Details

Author
EvanZhang008
Repository
EvanZhang008/open-walnut
Created
6 months ago
Last Updated
4 days ago
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category