# Electrik

> Electrik is a Laravel SaaS starter kit: authentication, teams, and Stripe billing as a Composer package (`electrik/electrik` 5.x). Built on Electrik Slate 3. Docs: https://electrik.dev/docs

## Get started

- [Introduction](https://electrik.dev/docs/getting-started/introduction): What Electrik 5.x is.
- [Quickstart](https://electrik.dev/docs/getting-started/quickstart): Fastest path to a running app.
- [Installation](https://electrik.dev/docs/getting-started/installation): `electrik:install` deep dive.
- [Architecture](https://electrik.dev/docs/getting-started/architecture): Package vs App, teams as tenant.
- [AI & agents](https://electrik.dev/docs/getting-started/ai): Cursor/Claude with Electrik — AGENTS.md, llms.txt, skills, package-safe rules.
- [AGENTS.md on GitHub](https://github.com/electrikhq/electrik/blob/main/AGENTS.md): Package-root rules for coding agents.
- [Install page](https://electrik.dev/install): Marketing quickstart.

## Core concepts

- [Configuration](https://electrik.dev/docs/core-concepts/configuration): config/electrik.php and environment variables.
- [Auth & security](https://electrik.dev/docs/core-concepts/auth-security): Login, Socialite, magic link, 2FA, passkeys, sessions, and login alerts.
- [Teams & invites](https://electrik.dev/docs/core-concepts/teams-invites): Create and switch teams, branding, archive, invites, ownership, activity, webhooks.
- [Roles & permissions](https://electrik.dev/docs/core-concepts/roles-permissions): Spatie permissions with team context and the Electrik catalog.
- [Billing](https://electrik.dev/docs/core-concepts/billing): Stripe via Cashier on the team: plans, add-ons, usage, tax IDs, webhooks.
- [Plan features & seats](https://electrik.dev/docs/core-concepts/plan-features-seats): Gate features and member limits by Stripe price; ops editor for flags and add-ons.
- [Onboarding](https://electrik.dev/docs/core-concepts/onboarding): First-run wizard, env toggle, and helper commands.
- [Customization](https://electrik.dev/docs/core-concepts/customization): Override views carefully and lean on Slate for UI.

## Guides & reference

- [Local sandbox](https://electrik.dev/docs/guides/local-sandbox): Reset and run the Electrik sandbox app from the lab monorepo.
- [Stripe test mode](https://electrik.dev/docs/guides/stripe-test-mode): Develop billing against Stripe test keys and the Stripe CLI.
- [Feature gating](https://electrik.dev/docs/guides/feature-gating): Use plan_features to limit seats and capabilities.
- [Upgrading](https://electrik.dev/docs/guides/upgrading): How to upgrade Electrik 5.x and migrate from older lines.
- [Generators](https://electrik.dev/docs/guides/generators): Scaffold Livewire, models, and resources with electrik:make.
- [API tokens](https://electrik.dev/docs/guides/api-tokens): Personal vs team-scoped Sanctum tokens, abilities, and Electrik API routes.
- [Operator console](https://electrik.dev/docs/guides/operators-ops): ELECTRIK_OPERATOR_EMAILS and the /ops Slate console.
- [Billing providers](https://electrik.dev/docs/guides/billing-providers): Stripe Cashier is the supported billing processor.
- [Social login & magic link](https://electrik.dev/docs/guides/social-login): Google, GitHub, Apple, Microsoft Socialite and magic-link email sign-in.
- [Outbound webhooks](https://electrik.dev/docs/guides/outbound-webhooks): Team HTTPS endpoints Electrik calls on workspace events.
- [Internationalization](https://electrik.dev/docs/guides/i18n): Locales en/es/fr/ar/hi, Profile language, and RTL.
- [Artisan commands](https://electrik.dev/docs/reference/artisan-commands): Electrik console commands reference.
- [Routes & middleware](https://electrik.dev/docs/reference/routes-middleware): Route groups and middleware aliases Electrik registers.
- [Permissions catalog](https://electrik.dev/docs/reference/permissions-catalog): Default permission keys shipped in config/electrik.php.
- [Changelog](https://electrik.dev/docs/reference/changelog): Electrik release notes and where to find full history.
- [Roadmap](https://electrik.dev/docs/reference/roadmap): What Electrik is building next, and what we are not chasing.
- [Slate UI](https://electrik.dev/docs/ecosystem/slate-ui): Electrik is built on Slate — UI docs live on slate.electrik.dev.
- [Teamwork](https://electrik.dev/docs/ecosystem/teamwork): Electrik's teams engine is a Teamwork fork.
- [Agent / llms.txt](https://electrik.dev/docs/ecosystem/agent-llms): Machine-readable docs for coding agents — see AI & agents.

## Related

- [Resources](https://electrik.dev/resources): Laravel SaaS starter kit, SaaS boilerplate, and build guides.
- [Laravel SaaS starter kit](https://electrik.dev/resources/laravel-saas-starter-kit): Package-first starter guide.
- [SaaS boilerplate](https://electrik.dev/resources/saas-boilerplate): Zip dump vs Composer package.
- [Build a Laravel SaaS](https://electrik.dev/resources/build-laravel-saas): Package-first build path.
- [Slate UI docs](https://slate.electrik.dev): Blade components and tokens (do not re-host here).
- [License](https://electrik.dev/license): MIT (5.5+); older tags may be BSL.
- [Pricing](https://electrik.dev/pricing): Free MIT kit + Electrik Launch delivery.
- [GitHub](https://github.com/electrikhq/electrik)

## Machine-readable

- [llms.txt](https://electrik.dev/llms.txt): This index.
- [llms-full.txt](https://electrik.dev/llms-full.txt): Index plus concatenated markdown docs.
- Prefer `.md` URLs under `/docs/...md` when pasting into models.