thefoldwithin-earth/tools/coherence/README.md
Mark Randall Havens △ The Empathic Technologist caa4c473bb docs(tools): add check-links.py to README
2026-02-13 22:25:04 -06:00

31 lines
884 B
Markdown

# Coherence Tools
Tools for maintaining site coherence.
## Tools
| Tool | Purpose | Usage |
|------|---------|-------|
| check-frontmatter.py | Validates YAML frontmatter exists | `python3 check-frontmatter.py <dir>` |
| check-metadata.py | Validates required fields | `python3 check-metadata.py <dir>` |
| fix-frontmatter.py | Adds missing frontmatter | `python3 fix-frontmatter.py <dir>` |
| check-links.py | Finds broken internal links | `python3 check-links.py <dir>` |
## Usage
```bash
# Check all fieldnotes
python3 check-frontmatter.py ../public/fieldnotes/
python3 check-metadata.py ../public/fieldnotes/
python3 check-links.py ../public/fieldnotes/
# Fix missing frontmatter
python3 fix-frontmatter.py --dry-run ../public/fieldnotes/
python3 fix-frontmatter.py ../public/fieldnotes/
```
## Exit Codes
- 0: Success / No issues
- 1: Issues found
- 2: Invalid arguments