For AI agents: visit https://developers.sefaria.org/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Sefaria
HomeDocsAPI ReferenceGitHubDonateGet in TouchSefaria LibraryVoices on Sefaria
Sefaria
Docs
Sefaria LibraryVoices at SefariaDevelopersMore from Sefaria ›
Jump to Content
Sefaria
HomeDocsAPI ReferenceGitHubDonateGet in TouchSefaria LibraryVoices on Sefaria

TECHNICAL DOCS

  • Welcome to Sefaria's Technical Documentation
  • Projects Powered By Sefaria
  • Copyright and Data Use
  • The Structure of a Book in the Sefaria Library
    • Index and Versions
    • The Index Schema
      • JaggedArray and JaggedArray Nodes
      • SchemaNode
      • The Structure of a Simple Text
      • The Structure of a Complex Text
      • Node Titles
    • Alternate Structures
    • Commentaries
    • Terms
    • Lexicon
  • Text References
  • Categories
  • Topic Ontology
    • Linear Integer Programming For Topic Page Sources Selection
  • Formatting within Sefaria Texts
  • Additional API Endpoints
    • ElasticSearch Proxy API
  • The Sefaria Linker
    • Embed Linker v2 In Your Site
    • Embed Linker v3 on Your Site
    • How to Format Citations for the Linker
    • איך ליצור מראי מקורות להפניה - How to Format Citations (HE)
    • The Sefaria Linker API
    • The Sefaria Linker Async Task API
    • Websites Using the Linker
  • Sefaria GitHub
  • The Sefaria MCPs

local installation

  • Getting Started
  • Local Installation Instructions
    • Run Sefaria with Docker-Compose
  • Workflowy
  • Command-Line-Interface (CLI)
  • Technical Notes
    • Term Creation
    • Titles for Index
    • Category Creation

Dev Digest Archive

  • The Sefaria Developer Community Archive
  • All About Texts, Volunteering for Tests (June 2024, Issue 1)
  • Celery Queues, Local Install and the Shape API (September 2024, Issue 2)
  • Linear Programming, Topic Curation, and API Tips (December 2024, Issue 3)
  • Top Tech Tips, New Projects, and More! (March 2025, Issue 4)
  • Calendar API, a User-Requested feature, and More! (June 2025, Issue 5)
  • Accessibility, Interns, and the Passages API (September 2025, Issue 6)
  • Django middleware innovation & MCPs (January 2026, Issue 7)
  • Sefaria-Export, A Data Puzzle and Deep Wiki (April 2026, Issue 8)

SEFARIA RESEARCH

  • The Disambiguator
  • Patot
  • Beyond KMeans - PyCon 2024

about Sefaria

  • General FAQ
  • Guide to Contributing
    • How to Report a Mistake
Powered by 

Command-Line-Interface (CLI)

Learn more about Sefaria's Command-Line-Interface tool.

    • Understanding the Shell Script
    • Seeing all Object Properties and Functions
    • CLI Examples
      • Link Counts
      • Text Segments
      • Versions