# Runlight

> Runlight is open source web analytics that you install into your own app as a package with one route and a script tag. Every doc below is plain Markdown.

## Docs

- [Getting started](https://runlight.sh/docs/index.md): Runlight is web analytics that installs into your app. It takes five minutes to get from npm install to your first visit.
- [Install](https://runlight.sh/docs/install/index.md): Mount Runlight in Next.js, Nuxt, SvelteKit, Astro, Remix, Express, NestJS, Fastify, Koa, Hono, Bun, Deno, or Cloudflare Workers.
- [Tracking](https://runlight.sh/docs/tracking/index.md): The script counts some things on its own, and this page shows how to send your own events and change the settings on the script tag.
- [The dashboard](https://runlight.sh/docs/dashboard/index.md): This page covers what each number means and how to filter, compare, share, and watch it live.
- [Goals](https://runlight.sh/docs/goals/index.md): Goals count events, page visits, and clicks as conversions with their value, worked out from data you already have.
- [Short links](https://runlight.sh/docs/links/index.md): Short links on your own domain are counted like visits and can be imported from Umami, Dub, Bitly, Short.io, Rebrandly, or CSV.
- [AI sources and agents](https://runlight.sh/docs/ai/index.md): Runlight counts the people who arrive from ChatGPT and Claude, and it sees the AI agents that read your pages without running any JavaScript.
- [Email reports](https://runlight.sh/docs/reports/index.md): Runlight emails weekly or monthly summaries through your own email service, in each reader’s language.
- [Scheduled check](https://runlight.sh/docs/cron/index.md): One request an hour keeps salts, reports, retention, and daily totals up to date.
- [Ask your AI](https://runlight.sh/docs/mcp/index.md): Connect any MCP client, such as Claude or Cursor, to Runlight with a read-only token and ask about your stats in plain words.
- [Configuration](https://runlight.sh/docs/configuration/index.md): This page covers every option for runlight() and routes(), including stores and sites.
- [HTTP API](https://runlight.sh/docs/api/index.md): Everything the dashboard shows is JSON at /runlight/api, for your own scripts and tools.
- [Standalone server](https://runlight.sh/docs/server/index.md): The standalone server runs Runlight as its own app for any number of sites, with a sign-in, short links on your own domains, and email reports.
- [PHP](https://runlight.sh/docs/php/index.md): Runlight runs in PHP 8.2 or later, inside a Laravel, Symfony, or plain PHP app, or on a domain of its own on ordinary PHP hosting.
- [Python](https://runlight.sh/docs/python/index.md): Runlight runs in Python 3.11 or later, inside a Django, Flask, or FastAPI app or any WSGI or ASGI app, or as a server of its own.
- [WordPress](https://runlight.sh/docs/wordpress/index.md): Count a WordPress site with Runlight, and see when AI agents read it.
- [Drupal](https://runlight.sh/docs/drupal/index.md): Count a Drupal site with Runlight, and see when AI agents read it.
- [Craft CMS](https://runlight.sh/docs/craft/index.md): Count a Craft CMS site with Runlight, and see when AI agents read it.
- [Privacy](https://runlight.sh/docs/privacy/index.md): This page lists exactly what Runlight stores and never stores, and explains why a site using it needs no cookie banner.
- [Rails](https://runlight.sh/docs/rails/index.md): Runlight runs inside a Rails 7.2, 8.0, or 8.1 app, with its tables in the app's own database and its dashboard at /runlight.
- [Ruby](https://runlight.sh/docs/ruby/index.md): Runlight runs in Ruby 3.2 or later, inside a Rack app such as Sinatra, Hanami, or Roda, or on a domain of its own as a standalone server.

## Setup prompt

- [prompt.txt](https://runlight.sh/prompt.txt): instructions a coding agent can follow to add Runlight to an app