Agent skill

shirushi

Document ID management for Git repositories. Validates, assigns, and tracks immutable doc_ids across Markdown/YAML files. Use when working with doc_id, document IDs, "@see docid" references, document integrity validation, or shirushi commands.

View SKILL.md on GitHub Repository
Stars 1
Forks 0

Install this agent skill to your Project

npx add-skill https://github.com/CAPHTECH/shirushi/tree/main/skills/shirushi

SKILL.md

Shirushi - Document ID Manager

Shirushi ensures consistent, immutable document IDs across Git repositories with CI integration.

Commands

Command Purpose
shirushi lint Validate doc_ids and index integrity
shirushi scan List documents with metadata
shirushi show <id> Get document info by doc_id
shirushi assign Assign IDs to new documents
shirushi rehash Recalculate content hashes

Common Workflows

Validate before commit

bash
shirushi lint --base HEAD~1

Find document by ID

bash
shirushi show PCE-SPEC-2025-0001-G

Add doc_id to new document

bash
shirushi assign docs/new-spec.md

List all documents

bash
shirushi scan --format table

Check for changes in PR

bash
shirushi lint --base origin/main --check-references

Configuration

Configuration is defined in .shirushi.yml:

yaml
id_format: "{COMP}-{KIND}-{YEAR4}-{SER4}-{CHK1}"
dimensions:
  COMP:
    type: enum
    values: ["API", "UI", "DB"]
  KIND:
    type: enum_from_doc_type
    mapping:
      spec: SPEC
      adr: ADR
  YEAR4:
    type: year
    digits: 4
  SER4:
    type: serial
    digits: 4
    scope: ["COMP", "KIND", "YEAR4"]
  CHK1:
    type: checksum
    algorithm: mod26AZ
    digits: 1

Document Format

Documents use YAML frontmatter:

markdown
---
doc_id: API-SPEC-2025-0001-G
title: API Specification
doc_type: spec
---

# Content here...

@see docid References

Reference documents in code comments:

typescript
// @see API-SPEC-2025-0001-G
function handleRequest() { ... }

Shirushi tracks these references and warns when referenced documents change.

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

mattpocock/skills

git-guardrails-claude-code

Set up Claude Code hooks to block dangerous git commands (push, reset --hard, clean, branch -D, etc.) before they execute. Use when user wants to prevent destructive git operations, add git safety hooks, or block git push/reset in Claude Code.

111,310 9,758
Explore
mattpocock/skills

scaffold-exercises

Create exercise directory structures with sections, problems, solutions, and explainers that pass linting. Use when user wants to scaffold exercises, create exercise stubs, or set up a new course section.

111,310 9,758
Explore
mattpocock/skills

handoff

Compact the current conversation into a handoff document for another agent to pick up.

111,310 9,758
Explore
mattpocock/skills

obsidian-vault

Search, create, and manage notes in the Obsidian vault with wikilinks and index notes. Use when user wants to find, create, or organize notes in Obsidian.

111,310 9,758
Explore
mattpocock/skills

edit-article

Edit and improve articles by restructuring sections, improving clarity, and tightening prose. Use when user wants to edit, revise, or improve an article draft.

111,310 9,758
Explore
mattpocock/skills

migrate-to-shoehorn

Migrate test files from `as` type assertions to @total-typescript/shoehorn. Use when user mentions shoehorn, wants to replace `as` in tests, or needs partial test data.

111,310 9,758
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results