Wip Readme Format

该 Skill 是一个 Node CLI，用于把仓库 README.md 重排为 WIP Computer 标准格式：读取 package.json 与 SKILL.md 检测接口，生成含徽章、标题、功能列表、接口表和许可区块的 README，并把技术内容迁入 TECHNICAL.md；支持 --dry-run 预览与 --check 校验。

parkertoddbrooks

热度 62.49

最近更新 2026-05-17 14:08:53

分类：效率依赖：代码执行 / 读写文件应用场景：模板 / 工作流 / 文件转换

安装技能

复制下面的话术发给你的 Agent，它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill： npx secure-skills-cli add wip-readme-format

Metadata

name: wip-readme-format
description: Reformat any repo's README to follow the WIP Computer standard.
license: MIT
interface: ["cli","skill"]
metadata: {"display-name":"README Formatter","version":"1.0.0","homepage":"https://github.com/wipcomputer/wip-ai-devops-toolbox","author":"Parker Todd Brooks","category":"repo-management","capabilities":["readme-generation","readme-validation","section-staging"],"requires":{"bins":["node"]},"openclaw":{"requires":{"bins":["node"]},"install":[{"id":"node","kind":"node","package":"@wipcomputer/wip-readme-format","bins":["wip-readme-format"],"label":"Install via npm"}],"emoji":"📝"}}
compatibility: Requires node. Node.js 18+.

README Formatter

Reformats a repo's README to follow the WIP Computer standard. Agent-first, human-readable.

Commands

wip-readme-format /path/to/repo              # rewrite README.md
wip-readme-format /path/to/repo --dry-run    # preview without writing
wip-readme-format /path/to/repo --check      # validate, exit 0/1

What happens

Detects all interfaces (CLI, Module, MCP, OC Plugin, Skill, CC Hook)
Reads package.json for name, description, repo URL
Reads SKILL.md for features
Generates the README following the standard:
- WIP Computer header + interface badges
- Title + tagline
- "Teach Your AI" onboarding block
- Features list
- Interface coverage table (toolbox repos only)
- More Info links
- License block
Moves technical content to TECHNICAL.md (never deleted)

The standard

[badges]
# Tool Name
Tagline.

## Teach Your AI to [verb]
[onboarding prompt block]

## Features
[feature list]

## Interface Coverage (toolbox only)
[auto-generated table]

## More Info
- Technical Documentation ... link
- Universal Interface Spec ... link

## License
[standard block]

Interfaces

CLI, Skill