Thunderbolt
$git clone https://github.com/thunderbird/thunderboltInstalls into the current project.
Install thunderbolt by running `git clone https://github.com/thunderbird/thunderbolt`, then use it for the current task and follow its documentation at https://github.com/thunderbird/thunderbolt.
| 1 | # Thunderbolt [](https://github.com/thunderbird/thunderbolt/actions/workflows/ci.yml) |
| 2 | |
| 3 | **AI You Control: Choose your models. Own your data. Eliminate vendor lock-in.** |
| 4 | |
| 5 |  |
| 6 | |
| 7 | > [!IMPORTANT] |
| 8 | > ⚠️ **We are excited about the amount of interest Thunderbolt has been getting and want to clarify that it is still early and under active development**. Currently, we are targeting enterprise customers that want to deploy it on-prem. We encourage you to self-host it and try it out, but there are a few caveats we are still working on: |
| 9 | > |
| 10 | > - While we eventually plan to make Thunderbolt fully offline-first, it currently depends on authentication and search functionality (though you can disable search on the integrations screen in the app). You can [deploy your own backend with Docker](./deploy/README.md) and sign up in order to test it locally. |
| 11 | > - You’ll need to add your own model providers - we don’t yet have a public inference endpoint. We recommend using Thunderbolt with [Ollama](https://ollama.com) or [llama.cpp](https://github.com/ggml-org/llama.cpp) if you want free local inference, or you can add API keys for any OpenAI-compatible model provider in the settings. |
| 12 | |
| 13 | Thunderbolt is an open-source, cross-platform AI client that can be deployed on-prem anywhere. |
| 14 | |
| 15 | - 🌐 Available on all major desktop and mobile platforms: web, iOS, Android, Mac, Linux, and Windows. |
| 16 | - 🧠 Compatible with frontier, local, and on-prem models. |
| 17 | - 🙋 Enterprise features, support, and FDEs available. |
| 18 | |
| 19 | **Thunderbolt is under active development, currently undergoing a security audit, and preparing for enterprise production readiness.** |
| 20 | |
| 21 | ## Get Started Locally |
| 22 | |
| 23 | ```sh |
| 24 | make doctor # verify your tools — prints exact install commands for anything missing |
| 25 | make setup # install frontend + backend dependencies, wire up agent symlinks |
| 26 | make up # start Postgres + PowerSync in Docker |
| 27 | make run # start the backend (:8000) and frontend (:1420) |
| 28 | ``` |
| 29 | |
| 30 | For self-hosting with Docker Compose or Kubernetes, see [`deploy/README.md`](./deploy/README.md). For full dev-environment details, see [`docs/development/quick-start.md`](./docs/development/quick-start.md). |
| 31 | |
| 32 | ## Need Help? |
| 33 | |
| 34 | Found a bug? Have an idea? |
| 35 | |
| 36 | - We're actively working on our docs, community, and roadmap. For now, the best way to get in touch is to [File an issue](https://github.com/thunderbird/thunderbolt/issues). |
| 37 | |
| 38 | ## Contributing |
| 39 | |
| 40 | We welcome contributions from everyone. |
| 41 | |
| 42 | - **Development**: The [development guide](./docs/development/quick-start.md) will help you get started. |
| 43 | - Make sure to check out the [Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). |
| 44 | |
| 45 | ## Documentation |
| 46 | |
| 47 | - [FAQ](./docs/faq.md) - Frequently asked questions |
| 48 | - [Deployment](./deploy/README.md) - Self-host with Docker Compose or Kubernetes |
| 49 | - [Development](./docs/development/quick-start.md) - Quick start, setup, and testing |
| 50 | - [Architecture](./docs/architecture/README.md) - System architecture and diagrams |
| 51 | - [Storybook](./docs/dev-tooling/storybook.md) - Build, test, and document components |
| 52 | - [Vite Bundle Analyzer](./docs/dev-tooling/vite-bundle-analyzer.md) - Analyze frontend bundle size |
| 53 | - [Tauri Signing Keys](./docs/features/tauri-signing-keys.md) - Generate and manage signing keys for releases |
| 54 | - [Release Process](./RELEASE.md) - Instructions for creating and publishing new releases |
| 55 | - [Telemetry](./TELEMETRY.md) - Information about data collection and privacy policy |
| 56 | |
| 57 | ## Code of Conduct |
| 58 | |
| 59 | Please read our [Code of Conduct](./CODE_OF_CONDUCT.md). All participants in the Thunderbolt community agree to follow these guidelines and [Mozilla's Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). |
| 60 | |
| 61 | ## Security |
| 62 | |
| 63 | If you discover a security vulnerability, please report it responsibly via our [vulnerability reporting fo |