How do I install the Shirushi skill?

Run npx skillmds@latest add tomevault-io/shirushi in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Shirushi safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Shirushi?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Shirushi free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Shirushi?

tomevault-io (@tomevault-io) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Shirushi by tomevault-io — Agent Skill

Name: Shirushi
Author: tomevault-io

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. Use when this capability is needed.

tomevault-io Updated Sep 17, 2026

File contents

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

shirushi lint --base HEAD~1

Find document by ID

shirushi show PCE-SPEC-2025-0001-G

Add doc_id to new document

shirushi assign docs/new-spec.md

List all documents

shirushi scan --format table

Check for changes in PR

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

Configuration

Configuration is defined in .shirushi.yml:

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:

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

# Content here...

@see docid References

Reference documents in code comments:

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

Shirushi tracks these references and warns when referenced documents change.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

---name: shirushidescription: 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. Use when this capability is needed.---# Shirushi - Document ID ManagerShirushi 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```bashshirushi lint --base HEAD~1```### Find document by ID```bashshirushi show PCE-SPEC-2025-0001-G```### Add doc_id to new document```bashshirushi assign docs/new-spec.md```### List all documents```bashshirushi scan --format table```### Check for changes in PR```bashshirushi lint --base origin/main --check-references```## ConfigurationConfiguration is defined in `.shirushi.yml`:```yamlid_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 FormatDocuments use YAML frontmatter:```markdown---doc_id: API-SPEC-2025-0001-Gtitle: API Specificationdoc_type: spec---# Content here...```## @see docid ReferencesReference documents in code comments:```typescript// @see API-SPEC-2025-0001-Gfunction handleRequest() { ... }```Shirushi tracks these references and warns when referenced documents change.---> Converted and distributed by [TomeVault](https://tomevault.io/claim/caphtech) — claim your Tome and manage your conversions.

Frequently asked questions