Skip to content

openalex-snapshot Documentation

DOI License: MIT CI GitHub release

This folder contains internet-facing documentation for openalex-snapshot.

Argument precedence (highest wins): CLI arguments > config subcommand section > config defaults section > built-in defaults.

Recommended page order:

  1. quickstart.md
  2. commands/check.md
  3. commands/config.md
  4. commands/all.md
  5. commands/download.md
  6. commands/verify_download.md
  7. commands/convert.md
  8. commands/verify.md
  9. commands/repair.md
  10. commands/index.md
  11. commands/verify_index.md
  12. commands/extract.md
  13. commands/schema.md
  14. commands/verify_schema.md
  15. commands/report.md
  16. commands/prune-reports.md
  17. commands/progress.md
  18. commands/skills.md
  19. operations/low-memory.md
  20. operations/cache-precompute.md
  21. operations/recovery.md
  22. troubleshooting.md