skills.rest
EvanZhang008
EvanZhang008COMMUNITY
Explore all skills by this author →
GitHub

walnut-register-repo

Generates a complete YAML profile for your current project's directory structure and metadata.

27|7|Updated Feb 24, 2026
Search Tags:#architecture#documentation#yaml#register#codebase-exploration#walnut#repository-profile
One-click install
npx skills add https://github.com/EvanZhang008/open-walnut --skill walnut-register-repo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: walnut-register-repo
Source: https://github.com/EvanZhang008/open-walnut/tree/main/src/data/skills/walnut-register-repo
Command: npx skills add https://github.com/EvanZhang008/open-walnut --skill walnut-register-repo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

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.

Core Features & Use Cases

  • Auto-generate a complete, standards-compliant repository profile including name, description, hosts, overview, architecture, tech stack, and common commands.
  • Provide a consistent YAML profile that can be deployed to ~/.open-walnut/repositories/{slug}.yaml for Open Walnut to consume.
  • Support future expansion for multiple hosts, tech stacks, and workflow templates.

Quick Start

Register the current project as a Walnut repository profile by running /walnut-register-repo.

Frequently Asked Questions about walnut-register-repo

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a repository profile for Walnut?▼

To auto-generate a repository profile for Walnut, run /walnut-register-repo. It extracts the project name, description, hosts, and architecture to produce a complete YAML profile for the Open Walnut system.

What is a Walnut repository profile used for?▼

A Walnut repository profile is a YAML file that provides new developers with project guidance, including architecture overview, tech stack, and common commands. It is deployed to ~/.open-walnut/repositories/ for Open Walnut to consume.

Can I create a repository profile for any codebase regardless of the programming language?▼

Yes, you can register repositories across multiple languages and project types. The process deep-explores the current codebase to extract its specific architecture and tech stack, applying consistently to local codebases.

What fields are included in the generated Walnut YAML profile?▼

The generated Walnut YAML profile includes name, description, hosts, overview, architecture, tech_stack, and common_commands. These fields provide comprehensive guidance for new developers navigating the project.

Do I need pyyaml to generate repository profiles?▼

Yes, pyyaml is a required dependency for generating repository profiles. It is utilized by the internal scripts to parse codebase metadata and output the final standards-compliant YAML configuration file.

Related Skills

Explore More Software Engineering Skills→
fcastrillofcastrillo

rai-discover-start

Detect project type, languages, and key directories into work/discovery/context.yaml.

Community
Intermediate
EvanZhang008EvanZhang008
27

walnut-manage-repos

Manage Open Walnut repository profiles via a YAML-based registry with CRUD operations.

Community
Intermediate
cute-baobaocute-baobao

project-overview

Generate a project architecture map with tech stack and data-flow overview.

Community
Advanced
evolv3aievolv3ai
3

docs-workflow

Automate creation, maintenance, and auditing of project documentation.

Community
Intermediate