yq-init-project

yq-init-project is a skill for Claude Code from rockyflux/yq-workflow. It costs 27 tokens per session (1,188 once invoked), scanned A, original, MIT.

A project-startup guide that creates or updates repository documentation for an AI coding assistant. It maps the project at the root and records more detailed information for individual modules.

In plain words
What is it for?
Use it when taking over an unfamiliar repository, documenting modules, recording entry points and tests, and keeping project context up to date.
Why use it?
It gives later work a shared map of the codebase instead of relying on scattered or repeated investigation.

Skill for Claude Code

Written for Claude Code: $ARGUMENTS substitution. Also seen: mentions CLAUDE.md.

Good fit Use it when taking over an unfamiliar repository, documenting modules, recording entry points and tests, and keeping project context up to date.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/rockyflux/yq-workflow/yq-init-project
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add rockyflux/yq-workflow --skill yq-init-project
Clone the repo
git clone --depth 1 https://github.com/rockyflux/yq-workflow

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for yq-init-project

README.md
[![agentmods](https://agentmods.dev/badge/skills/rockyflux/yq-workflow/yq-init-project/github.svg)](https://agentmods.dev/skills/rockyflux/yq-workflow/yq-init-project)
Your own site
<a href="https://agentmods.dev/skills/rockyflux/yq-workflow/yq-init-project"><img src="https://agentmods.dev/badge/skills/rockyflux/yq-workflow/yq-init-project/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for yq-init-project

Your own site · 80×15
<a href="https://agentmods.dev/skills/rockyflux/yq-workflow/yq-init-project"><img src="https://agentmods.dev/badge/skills/rockyflux/yq-workflow/yq-init-project.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 27 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,188 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00027 $0.01188
Opus 5 $0.00014 $0.00594
Sonnet 5 $0.00005 $0.00238
Haiku 4.5 $0.00003 $0.00119

Measured 8d ago against content hash 08f5aa758f11, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

yq-init-project scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 8d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

templates/yq-skills/yq-init-project/SKILL.md · 105 lines

What it actually says

YQ Init Project

Overview

初始化仓库级 AI 上下文与模块索引,让后续需求分析、代码解释和设计讨论都建立在统一导航基线上。

Core principle: 先把仓库地图画清楚,再进入具体任务。

用法

/init-project <项目摘要或名称>

When to Use

  • 第一次接手仓库,需要快速建立可导航的 AI 上下文
  • 仓库模块较多,后续任务容易因上下文分散而返工
  • 希望把根级与模块级说明沉淀为可持续更新的索引文件

Route Elsewhere

  • 主要是梳理需求范围和验收标准:转 yq-req-analysis
  • 主要是读代码、解释调用链或快速上手模块:转 yq-code-explain
  • 主要是画结构图、流程图或架构图:转 yq-drawio-diagram

目标

以“根级简明 + 模块级详尽”的策略初始化项目 AI 上下文,确保后续任务有统一、可导航、可增量维护的上下文基线:

  • 在仓库根生成/更新 CLAUDE.md(高层愿景、架构总览、模块索引、全局规范)。
  • 在识别的各模块目录生成/更新本地 CLAUDE.md(接口、依赖、入口、测试、关键文件等)。
  • 在信息充分时增强可读性(如结构图、导航信息);若上下文不足,应明确降级并说明原因。

Process

步骤 1:调用 get-current-datetime 子智能体获取当前时间戳。

步骤 2:调用一次 init-architect 子智能体,输入:

  • project_summary: $ARGUMENTS
  • current_timestamp: (来自步骤1的时间戳)

执行策略(Agent 自适应,无需用户传参)

  • 阶段 A:全仓清点(轻量) 快速统计文件与目录,识别模块根(package.jsonpyproject.tomlgo.modapps/*packages/*services/* 等)。
  • 阶段 B:模块优先扫描(中等) 对每个模块执行“入口 / 接口 / 依赖 / 测试 / 数据模型 / 质量工具”的定点读取与样本抽取。
  • 阶段 C:深度补捞(按需) 小仓库可扩大读取面;大仓库按高风险 / 高价值路径分批补扫。
  • 覆盖率度量与可续跑 输出“已扫描文件数 / 估算总文件数、已覆盖模块占比、忽略或跳过原因”,并列出“建议下一步深挖路径”。重复运行 /init-project 时按已有索引进行增量更新断点续扫

安全与边界

  • 只读/写文档与索引,不改源代码。
  • 默认忽略常见生成物与二进制大文件。
  • 主对话仅输出摘要,完整内容写入仓库文件。

Output

  • 在主对话中打印“初始化结果摘要”,至少包含:
    • 根级 CLAUDE.md 是否创建/更新、主要栏目概览。
    • 识别的模块数量及其路径列表。
    • 每个模块 CLAUDE.md 的生成/更新情况。
    • 若启用了增强可读性项:明确说明是否生成结构图、是否补充导航信息(含数量)。
    • 覆盖率与主要缺口。
    • 若未读全:说明“为何到此为止”,并给出可执行的下一步(例如“建议优先补扫:packages/auth/src/controllers”)。
  • 初始化完成后通常接 yq-req-analysisyq-code-explainyq-system-design
  • 如果需要把仓库结构、模块关系可视化,可配合 yq-drawio-diagram
  • 默认交给 yq-req-analysis,把仓库上下文转成可执行需求讨论
  • 如果当前目标是快速理解现有实现,改接 yq-code-explain
  • 如果已经明确要讨论方案和边界,接 yq-system-design
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 8d ago First seen · 105 lines · 27 tokens per session scan A 08f5aa758f11

Subscribe to this mod's changes

yq-init-project is a skill published in the GitHub repository rockyflux/yq-workflow (2 stars, last pushed yesterday), licensed MIT. It adds 27 tokens to every session and 1,188 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

recipe-create-meet-space

Create a Google Meet meeting space and share the join link.

googleworkspace/cli · 18 tokens

workthreads

SpecStory Workthreads - a weekly work-thread rollup across a team's repos from SpecStory coding histories (any agent - Claude Code, Codex, Cursor, Gemini, and more). It groups the window's sessions into threads of work per project and labels each new / open / recently closed, so a lead sees what shipped, what is still…

specstoryai/getspecstory · 126 tokens

atmos-config

Atmos root configuration: atmos.yaml discovery, precedence, deep merging, basepath, imports, minimal bootstrap, and routing to narrower Atmos skills.

cloudposse/atmos · 31 tokens

story-readiness

Validate that a story file is implementation-ready. Checks for embedded GDD requirements, ADR references, engine notes, clear acceptance criteria, and no open design questions. Produces READY / NEEDS WORK / BLOCKED verdict with specific gaps. Use when user says 'is this story ready', 'can I start on this story', 'is…

Donchitos/Claude-Code-Game-Studios · 77 tokens

autotask-creator

Rules for automation CRUD from the group-chat commander. The commander does not call mutation tools and does not edit cloud/autotasks files directly. It emits one or more top-level ... containers in its final text; the bus parses and applies them after the turn.

Orkas-AI/Orkas · 5 tokens

projects

List all managed projects with status, branch, open PRs, and open issue counts — portfolio-level view.

me2resh/apexyard · 24 tokens