@citemap/cli
v0.3.4
Published
Command-line tool for validating citemap.json files
Maintainers
Readme
@citemap/cli
Command-line tool for validating citemap.json files — schema checks, quality scoring, level assessment, and diagnostic recommendations.
Supports CiteMap v2.0 and v3.0.
Install
npm install -g @citemap/cliOr use with npx:
npx @citemap/cli validate ./citemap.jsonCommands
citemap validate <path>
Validate a citemap.json file against the schema. Shows errors, warnings, quality score, and level badge.
$ citemap validate .well-known/citemap.json
✓ Valid citemap.json v3.0
Level 3 ★★★
Quality Score: 85%
Completeness 100% [████████████████████]
Modules 100% [████████████████████]
Trust 50% [██████████░░░░░░░░░░]
All validations passed.citemap diagnose <path>
Full diagnostic analysis with module coverage, field coverage, next-level hints, and recommendations.
$ citemap diagnose .well-known/citemap.json
✓ Valid citemap.json v3.0
Level 2 ★★☆
Quality Scores:
Overall 78% [████████████████░░░░]
Completeness 100% [████████████████████]
Modules 100% [████████████████████]
Trust 25% [█████░░░░░░░░░░░░░░░]
Diagnosis:
Site type: local-business
Field coverage: 135/135 (100%)
Modules present: localBusiness
To reach Level 3:
→ Add a verification block with externalVerifiers or fieldConfidence
→ Add verifiedClaims with externally checkable identifiers (NPI, EIN, etc.)
Recommendations:
• Add a verification block with externalVerifiers or fieldConfidence to build trust
• To reach Level 3: Add verifiedClaims with externally checkable identifiers
✓ All validations passed.Other
citemap --version # Show version
citemap --help # Show usageExit Codes
0— Valid citemap1— Invalid citemap or error
Level System
The CLI displays the computed CiteMap Level as a badge:
| Level | Badge | Requirements |
|-------|-------|-------------|
| 1 | Level 1 ★☆☆ | Core profile (brand, lastVerified) |
| 2 | Level 2 ★★☆ | + at least 1 module + answerContent + citationContract |
| 3 | Level 3 ★★★ | + verification + verifiedClaims |
If a citemap claims a level via citemapLevel that doesn't match actual content, the CLI flags the mismatch.
Links
- CiteMap Spec
- GitHub
- @citemap/schema — Schema + TypeScript types
- @citemap/validator — Validation + quality scoring
License
MIT
