rune-onboard

Generate CLAUDE.md and .rune project context files by scanning a codebase.

1|Updated Mar 22, 2026
One-click install
npx skills add https://github.com/dangvu008/VietTruyen --skill rune-onboard-dangvu008
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rune-onboard
Source: https://github.com/dangvu008/VietTruyen/tree/main/.agents/skills/rune-onboard
Command: npx skills add https://github.com/dangvu008/VietTruyen --skill rune-onboard-dangvu008

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? New AI sessions on an undocumented repository start with zero context, forcing developers to re-explain the tech stack, conventions, and commands every time. This Skill scans the codebase once and generates persistent project context files so every future session starts informed. ## Core Features & Use Cases - Automated Tech Stack Detection: Scans config files (package.json, pyproject.toml, Cargo.toml, go.mod) to identify language, framework, package manager, test framework, and linter without guessing. - Context File Generation: Creates CLAUDE.md plus a .rune/ directory containing conventions, decisions, progress, session-log, instincts, contract, INVARIANTS.md, and a human-readable DEVELOPER-GUIDE.md. - Invariant Seeding: Runs bundled Node.js scripts to detect danger zones, shared constants, state machines, and mirrored literal tuples, writing them to .rune/INVARIANTS.md with merge-safe re-runs. - Use Case: A developer clones an unfamiliar legacy repository with no documentation. Running the onboard flow produces a complete CLAUDE.md with verified build/test commands and a developer guide, so both AI sessions and new team members start with full context. ## Quick Start Ask the AI to run the rune onboard flow on this repository to scan the codebase and generate CLAUDE.md and the .rune context directory.

Frequently Asked Questions about rune-onboard

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

FAQPage Schema
How do I generate a CLAUDE.md file for an existing project?

Run the onboard flow on the project root. It scans config files and entry points, detects the tech stack and conventions, then writes CLAUDE.md with verified install, dev, build, test, and lint commands. Existing CLAUDE.md content is merged, not overwritten.

What files does rune onboard create in a repository?

It creates CLAUDE.md at the project root and a .rune/ directory containing conventions.md, decisions.md, progress.md, session-log.md, instincts.md, contract.md, INVARIANTS.md, and DEVELOPER-GUIDE.md. Existing files are skipped to preserve manual content.

Does the onboarding scan work with Python projects?

Yes. It detects Python environment markers including .venv, poetry.lock, uv.lock, .python-version, conda-meta, and Pipfile.lock, then records the detected environment in CLAUDE.md and adds Python-specific guidance to the developer guide.

Will re-running onboarding overwrite my manual edits?

No. Existing .rune/ files are skipped with an INFO log, CLAUDE.md manual sections marked with HTML comments are preserved, and INVARIANTS.md user edits above the auto-detected section are never overwritten on re-runs.

What happens when the project is too ambiguous to auto-detect?

When tech stack detection yields multiple unknown fields or the repo lacks standard config files, the skill suggests an interview mode that asks 5-8 targeted questions and stores answers as high-confidence entries in .rune/conventions.md.