knowledge-lintv0.1.0

← All examples

Broken knowledge base

knowledge-lint lint broken-knowledge-base: an undeclared folder, a wrong type, a status outside the custom vocabulary, an invalid date, a broken related link, an unencrypted secret and a missing attachment. Errors make the run exit 1. The input shows the _types.yml.

Broken knowledge base

examples/output/lint-broken-knowledge-base.txt
# A knowledge base with deliberate mistakes, to show what knowledge-lint
# reports. It uses its own status vocabulary instead of the default.

status_values: [draft, stable, deprecated]
active_status: stable

categories:
  decisions:
    kind: knowledge_entry
    type: decision
    review_interval_days: 365
  glossary:
    kind: knowledge_entry
    type: glossary
    review_interval_days: 365
  secrets:
    kind: sops_secret
Checking broken-knowledge-base/secrets/api-token.yaml
  ERROR: file in a sops_secret category has no `sops:` metadata field — not SOPS-encrypted?
Checking broken-knowledge-base/decisions/2024-03-hosting.md
  WARNING: last_reviewed is 927 days old (> 365), but the entry is marked 'stable'
  ERROR: related link '../glossary/cdn.md' points to a file that doesn't exist
Checking broken-knowledge-base/decisions/2026-02-backups.md
  ERROR: status 'current' is not one of the allowed values (draft, stable, deprecated)
  ERROR: type 'process' does not match category 'decisions' (expected: 'decision')
Checking broken-knowledge-base/glossary/embedding.md
  WARNING: possible API key with prefix 'sk-' found — check whether this is a real secret
  ERROR: source is missing
  ERROR: last_reviewed '12.01.2026' is not a valid date (YYYY-MM-DD)
Checking broken-knowledge-base/meetings/
  ERROR: category 'meetings' is not declared in _types.yml
Checking broken-knowledge-base/_attachments.yml
  WARNING: attachment 'contract-scan' has no description
  ERROR: attachment 'contract-scan': path './assets/contract-2026.pdf' does not exist
  ERROR: attachment 'contract-scan': referenced_by entry 'decisions/2026-03-hosting-contract.md' points to a file that doesn't exist

0 of 3 knowledge entries are marked public.
9 error(s), 3 warning(s) found.
  • lint
  • errors
  • status vocabulary