# myflames

> myflames is an open-source performance workspace for MySQL, MariaDB, and Percona Server for MySQL. Use the desktop app on macOS or the Windows x64 preview to follow a question from the query plan to the SQL, schema, and server behind it: inspect EXPLAIN ANALYZE plans as flame graphs, Visual Explain diagrams, execution trees and bar charts, compare before and after plans, and share the evidence with your team.

## Start here
- [Installation & first steps](https://myflames.io/docs/quickstart.md): myflames is a desktop performance workspace for MySQL, MariaDB and Percona Server. You can start with a saved JSON execution plan without connecting to a server.
- [How-to guides](https://myflames.io/docs/howto.md): Follow these steps to try common tasks in the desktop app. Shortcuts show macOS keys first, then Windows and Linux keys.
- [Why myflames](https://myflames.io/docs/motivation.md): Performance work is a sequence of questions. Where does this statement spend time? Which operator deserves attention? What changed between the two runs? What was the server doing at the same time?

## Workflows
- [Execution plans & comparison](https://myflames.io/docs/plans.md): An execution plan describes how the engine will get a result. A timed plan also records what happened while the statement ran. myflames turns exported JSON into multiple views of the same plan.
- [Query editor & slow queries](https://myflames.io/docs/queries.md): The Query editor combines multi-tab SQL sessions, schema browsing, completion, formatting and result exports. Each tab has a dedicated session, so transaction state belongs to that tab.
- [Server diagnostics & operations](https://myflames.io/docs/server.md): Use the Server place to connect query behavior with server evidence. The data available depends on the engine, version, effective privileges and instrumentation that is already enabled.
- [Schemas & version comparison](https://myflames.io/docs/schemas.md): Database diagram helps you explore the relationships in a schema. Schema versions lets you save definitions locally and compare them with another version, a file, or a live database.
- [Learn the algorithms](https://myflames.io/docs/learn.md): Learn explains query-engine algorithms through guided animations. A lesson advances one idea at a time, with simplified code beside the drawing and a short Check yourself quiz at the end.

## Reference
- [Connection policies & write safety](https://myflames.io/docs/safety.md): myflames includes features that change server state. Choose the connection's policy to match the environment before using those features.
- [Engine & platform compatibility](https://myflames.io/docs/compatibility.md): Desktop: macOS Apple Silicon; Windows x64 is a preview. A Linux or macOS Intel desktop binary is not advertised in the checked release.

## Community
- [Contribute to myflames](https://myflames.io/docs/contributing.md): Start with the public repository, open issues and the project's roadmap. Check whether your idea fits the direction before implementing a large feature.

## Release notes
- [Release notes](https://myflames.io/docs/release-notes.md): What changed in each version of myflames, newest first. Changes that are merged but not released yet are listed in CHANGELOG.md.
- [myflames 3.4.1](https://myflames.io/docs/release-notes-3-4-1.md): myflames 3.4.1 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.4.0](https://myflames.io/docs/release-notes-3-4-0.md): myflames 3.4.0 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.3.4](https://myflames.io/docs/release-notes-3-3-4.md): myflames 3.3.4 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.3.3](https://myflames.io/docs/release-notes-3-3-3.md): myflames 3.3.3 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.3.2](https://myflames.io/docs/release-notes-3-3-2.md): myflames 3.3.2 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.3.1](https://myflames.io/docs/release-notes-3-3-1.md): myflames 3.3.1 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.3.0](https://myflames.io/docs/release-notes-3-3-0.md): myflames 3.3.0 is available for macOS on Apple Silicon and, as an unsigned preview, for Windows x64.
- [myflames 3.2.0](https://myflames.io/docs/release-notes-3-2-0.md): myflames 3.2.0 is available as a desktop app for macOS on Apple Silicon and as a Python package (Python 3.7 or later).
- [myflames 3.1.1](https://myflames.io/docs/release-notes-3-1-1.md): myflames 3.1.1 is available as a desktop app for macOS on Apple Silicon and as a Python package (Python 3.7 or later).
- [myflames 3.1.0](https://myflames.io/docs/release-notes-3-1-0.md): myflames 3.1.0 is available as a desktop app for macOS on Apple Silicon and as a Python package (Python 3.7 or later).
- [myflames 3.0.0](https://myflames.io/docs/release-notes-3-0-0.md): myflames 3.0.0 is available as a Python package (Python 3.7 or later) with a local workspace that runs in the browser.

## Downloads
- [Download myflames](https://myflames.io/download.html): verified macOS and Windows installers, checksummed and served from this site.
- [Full documentation for LLMs](https://myflames.io/llms-full.txt): the chapters and release notes above, in handbook order, in one plain-text file.

## Optional
- [Project README](https://myflames.io/docs/ref-readme.md): myflames is an open-source performance workspace for MySQL, MariaDB, and Percona Server for MySQL. Follow a question from the query plan to the SQL, schema, and server behind it. Inspect operator timings, compare before and after plans…
- [Contributing guide](https://myflames.io/docs/ref-contributing.md): Thank you for your interest in contributing to myflames! This guide will help you get set up and make your first contribution.
- [Roadmap](https://myflames.io/docs/ref-roadmap.md): myflames is a desktop workspace that shows what MySQL and MariaDB are doing, starting from the query plan. Raw EXPLAIN ANALYZE FORMAT=JSON is verbose and hard to read. myflames parses and analyzes a plan once, then shows it many ways…
- [Developer reference](https://myflames.io/docs/ref-developer-reference.md): This is the detailed contract per feature; AGENTS.md has the rules. Read the relevant section before changing behavior, output formats, UI integration, or feature-specific tests.
- [Query workspace reference](https://myflames.io/docs/ref-query-workspace.md): This guide covers query investigations in the myflames Performance workspace (myflames ui): exploring and comparing plans, capturing queries from a database, and the Server views that find the statement to investigate. The workspace uses…
- [Visual Explain reference](https://myflames.io/docs/ref-visual-explain-reference.md): Diagram and Workbench now share one renderer: Visual Explain, implemented in myflames/outputworkbench.py and myflames/workbench.js. --type diagram and outputdiagram.renderdiagram remain compatibility aliases. See the Visual Explain guide…
- [Desktop reference](https://myflames.io/docs/ref-desktop.md): The desktop app uses Electron to host the existing React and TypeScript workspace, with Python providing the same engine and CLI. Download size is secondary to consistent rendering and reliable native integration.
- [Workspace reference (legacy sections)](https://myflames.io/docs/ref-local-ui.md): The same workspace can run inside the optional Electron development app in apps/desktop, currently targeting macOS. See Desktop app for setup. Compact navigation, open query documents and the command palette (⌘K) are shared with the…
- [Diagram reference](https://myflames.io/docs/ref-workbench-view.md): Open myflames ui, load a plan, and choose Visual Explain above the chart. Diagram and Workbench now share this single view. Existing --type diagram commands and Python renderdiagram calls remain compatible aliases. The command line…