Skip to content


Welcome to Scarf's documentation, your one-stop guide for understanding and leveraging our platform's powerful tools to track usage metrics for your open-source software projects.


Scarf provides open-source software maintainers with deep insights about their project's usage. With best-in-class open-source usage analytics and tracking capabilities, Scarf uncovers how and where your software is being utilized, which companies are relying on it, and much more. This data helps maintainers understand their project's reach, identify growth opportunities, and make informed strategic decisions. With its ethos firmly rooted in the open-source community, Scarf is not just a platform but a partner in your software project's journey toward success.

Documentation Sections Overview

  1. Getting Started Checklist: Preview the high-level Scarf set up process.
  2. Quick Start: Jumpstart your journey with Scarf. A concise guide to get you up and running with our platform quickly.
  3. Scarf Gateway: Understand the nuances of Scarf's secure and powerful gateway.
  4. Organizations: Learn how to manage and collaborate with your teams within Scarf's platform.
  5. Packages: Delve into the specifics of working with various Scarf package types, such as Docker, Helm, npm, Python, and more.
  6. Scarf SDKs: Discover how our Software Development Kits (SDKs) can accelerate your development process.
  7. Custom Telemetry: Track any custom behaviors by sending event data to Scarf from your code.
  8. Documentation Insights (Pixels): Uncover insights about your product's usage and onboarding through Scarf's cookie-free pixel tracking.
  9. Open Source Qualified Leads (OQLs): Identify organizations and individuals that have engaged with your OSS.
  10. Open Source Adoption Funnel Stages: Understand the level of engagement of potential leads.
  11. Data Export: Export your data for customized analysis. Explore the potential of data manipulation to suit your needs.
  12. Event Import: Import your data
  13. User Guide & Best Practices: Make a plan to use the data uncovered in your OQLs.
  14. Troubleshooting: Find solutions to common issues and questions.
  15. API Docs: Understand the capabilities of a specific API version and its available endpoints.


Our documentation is an open-source resource hosted on GitHub. We welcome and appreciate your contributions to make it even better.

For engaging discussions, interactive Q&A sessions, and to meet our dynamic community of staff, open-source maintainers, and end-users, join the Scarf-Community workspace on Slack.

Stay updated with Scarf's system status and uptime on our status page here.

Welcome aboard, and happy exploring!