onboard

Agent Skills › leamsigc/ShortsGenerator › onboard

GitHub

用于快速上手新代码库，通过扫描项目结构、阅读关键文档及检查 Git 状态，生成包含工作流概览、依赖关系、部署状态和待办事项的项目当前状态摘要。

skills/onboard/SKILL.md leamsigc/ShortsGenerator

接入新项目或新仓库需要了解代码库整体架构和现状

npx skills add leamsigc/ShortsGenerator --skill onboard -g -y

More Options

Use without installing

npx skills use leamsigc/ShortsGenerator@onboard

指定 Agent (Claude Code)

npx skills add leamsigc/ShortsGenerator --skill onboard -a claude-code -g -y

安装 repo 全部 skill

npx skills add leamsigc/ShortsGenerator --all -g -y

预览 repo 内 skill

npx skills add leamsigc/ShortsGenerator --list

Frontmatter

{
    "name": "onboard",
    "description": "Onboard into this workflows codebase and provide a summary of its current state"
}

Onboard into this workflows codebase and provide a summary of its current state.

Steps

Scan the project structure
- List all top-level files and directories
- List all workflows in workflows/
- List all plans in .agent/plans/
Read key files
- CLAUDE.md — project conventions and rules
- CATALOG.md — workflow index and status
- README.md — project overview
- requirements.txt — shared Python dependencies
- .env.example — shared environment variables
For each workflow in workflows/:
- Read its README.md for what it does
- Check if it has tests
- Note its deploy target and current state
Check git state (if git is initialized)
- git status — any uncommitted changes?
- git log -5 --oneline — recent activity
- Current branch
Provide a summary:
- What this project is (standalone workflows collection)
- How many workflows exist and their statuses (from CATALOG.md)
- Which workflows are planned but not yet built
- Which workflows are deployed
- Any uncommitted changes or work in progress
- Conventions to follow (from CLAUDE.md)