Welcome to Software Heritage documentation#
Learn about our mission and our source code archive. Find out about how to make your first steps with the archive.
Our vast archive can be searched and accessed in multiple ways. Use it to reference unambiguously any part of a source code to your peers: fragment of code, directory, release, etc.
Explore our full collection of training content, trainer resources, and organizational strategy documents. Discover the ambassadors programme.
Develop or research using Software Heritage. Browse, access or import source code programmatically.
Enhance our collection, preservation, and querying processes.
Discover Software Heritage#
Learn about our mission and our source code archive. Find out about how to make your first steps with the archive.
Why an universal software archive?#
Software Heritage in practice#
Archive and reference source code#
There are multiple ways to add or update source code in Software Heritage archive. Some of them are automated: our tools crawl multiple software development plateforms to archive as many open projects as possible. Others require manual procedures.
Before anything…#
Save a code repository#
“Ready to go” options to save your code :
Seamlessly check if a repository that you are browsing is archived and up to date using our Software Heritage browser extensions
Automate the archival:
Deposit artefacts and/or metadata#
The deposit service allows a trusted partner to submit software source archives and its associated metadata to the Software Heritage archive. Metadata can be also submitted referencing a repository url (origin).
Save multiple projects at a time, save a forge#
Save a forge in 2 steps :
Save legacy source code#
Recovering and curating landmark legacy source code : how to save legacy code
Search, browse and reference#
Search and access the archive, or use it to reference unambiguously any part of a source code.
Make your code identifiable : get a PID for your source code
Choosing what type of Software Hash Identifier (SWHID) to use
Need help? Want to make a proposal? Ask the community using the users mailing-list
Learn and share#
Developers, software engineers, researchers, academic librarians, metadata curators, and software archivists: get trained on Software Heritage, or find the resources you need to train others.
Software Heritage advocates will also find documentation for a deeper understanding of the overall strategy.
Any feedback, any question? community-care@softwareheritage.org
Learning resources#
Find out learning resources for end-users and trainers, presentations, strategic documents, etc.
Ambassador program#
Use in your applications#
Interact with our source code archive from your applications or research projects.
Browse API#
Web API. Access the API overview or discover the full endpoints index
Data model and identifiers#
Software Hash IDentifiers (SWHID) specifications
Compute a SWHID locally using the swh identify command-line tool.
Deposit API#
Improve the universal archive#
There are many ways to help Software Heritage. However small or large, contributions are welcome and very much appreciated.
Developer documentation. Where you will find developer-oriented documentation to understand the SWH environment.
Contributing development skills:
Development mailing-list. Join the community
Contributing resources and infrastructure:
Table of contents#
- Development
- API reference
- swh.alter
- swh.auth
- swh.coarnotify
- swh.core
- swh.counters
- swh.dataportal
- swh.datasets
- swh.deposit
- swh.digestmap
- swh.export
- swh.fuse
- swh.graph
- swh.graph.libs
- Software Heritage GraphQL API
- Design
- swh.indexer
- swh.journal
- swh.lister
- swh.loader
- swh.model
- swh.objstorage
- swh.objstorage.replayer
- Software Heritage - Provenance
- Description
- swh.scanner
- swh.scheduler
- swh.scrubber
- swh.search
- swh.shard
- swh.storage
- swh.vault
- swh.web
- swh.web.client
- swh.webhooks
- Usage
- Resources
- Infrastructure
- About