Documentation
citesync keeps software citation files in step with the metadata in your repository. Use the command line for repeatable checks, or generate files in the browser playground without installing Python.
Start here
- Install citesync, then run
citesync checkin your repository. - Create a CITATION.cff from package metadata when you do not have one yet.
- Use the playground to paste a file or enter project details, review the results and download citation files.
Work with a repository
- Check that files agree and understand findings and exit codes.
- Update citation files while preserving comments and unmapped metadata.
- Require selected fields, such as authors, licences or a release DOI.
- Keep software and dataset metadata separate, including their licences.
- Set up a pre-commit hook to catch metadata drift before committing.
- Export citations for publications, websites and reference managers.
- Cite software with Pandoc or Quarto.
Reference
- Configuration: source files, required values and other settings.
- Supported files: which formats citesync reads, checks and writes.
- Rules: findings and how to address them.
- Output formats: JSON, GitHub annotations and SARIF.
- Contribution records: carrying people and roles between tools.