shirushi

Shirushi - Document ID Manager

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

Commands

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.