# Glyph docs

> Documentation for Glyph, a free, open-source desktop music player for Windows, macOS and Linux that searches many legal music sources at once, and for its self-hostable server and `glyph` CLI, the YouTube companion and r-dlp.

Every page is also available as Markdown: add `.md` to its address. All pages in one file: [llms-full.txt](https://docs.glyph.my/llms-full.txt). Source: https://github.com/glyphmusic/docs

## Start

- [Welcome to Glyph](https://docs.glyph.my/README.md): A fast desktop music player that searches many legal sources at once.

## Getting started

- [Install](https://docs.glyph.my/getting-started/install.md): Download Glyph for Windows, macOS or Linux, keep it updated, or build it from source.
- [First steps](https://docs.glyph.my/getting-started/first-steps.md): Search, play, like and collect songs, and the right-click menus of the player bar.
- [Keyboard shortcuts](https://docs.glyph.my/getting-started/keyboard-shortcuts.md): Every keyboard shortcut in Glyph.
- [Troubleshooting](https://docs.glyph.my/getting-started/troubleshooting.md): Fixes for the most common problems.

## Using Glyph

- [Search and sources](https://docs.glyph.my/using-glyph/search-and-sources.md): Which legal sources Glyph searches, search tips, YouTube resolvers and artist pages.
- [Library, playlists and queue](https://docs.glyph.my/using-glyph/library-and-queue.md): Liked songs, playlists, sharing codes, the three-part queue and shuffle styles.
- [Transfer music](https://docs.glyph.my/using-glyph/transfer-music.md): Bring your library from Spotify, YouTube Music, SoundCloud, Deezer or Last.fm without logging in, or import single playlists from links and files.
- [Downloads and audio quality](https://docs.glyph.my/using-glyph/downloads-and-quality.md): Offline downloads, streaming quality and saving data.
- [Sharing](https://docs.glyph.my/using-glyph/sharing.md): Send songs, playlists, settings and equalizer curves to others.
- [Lyrics](https://docs.glyph.my/using-glyph/lyrics.md): Synced lyrics from LRCLIB, choosing another version and fixing the timing.
- [Sound](https://docs.glyph.my/using-glyph/sound.md): Crossfade, volume levels, normalization, equalizer, spatial audio and playing on MPD.
- [Play on speakers and TVs](https://docs.glyph.my/using-glyph/devices.md): Play on speakers, TVs and other devices in your network (Chromecast, UPnP/DLNA, Sonos, MPD) and what to do when a device is missing.
- [Accounts, sync and stats](https://docs.glyph.my/using-glyph/accounts.md): Optional accounts: what syncs between devices, profiles and listening statistics.
- [AI assistants (MCP)](https://docs.glyph.my/using-glyph/ai-assistants.md): Let AI assistants such as Claude control Glyph through MCP, locally or through the server.
- [Integrations](https://docs.glyph.my/using-glyph/integrations.md): System media controls, Discord, the mini player and more.
- [Direct mode and API keys](https://docs.glyph.my/using-glyph/direct-mode-and-keys.md): Use Glyph without a server, with your own API keys.
- [Settings file](https://docs.glyph.my/using-glyph/config-file.md): Where config.toml lives, options that exist only in the file, and settings backup.

## Self-hosting

- [Overview](https://docs.glyph.my/self-hosting/overview.md): Run your own Glyph server on Cloudflare or on your own machine, and which to choose.
- [Cloudflare](https://docs.glyph.my/self-hosting/cloudflare.md): Deploy the Glyph server as a free Cloudflare Worker with accounts, sync and your own domain.
- [Own computer or VPS](https://docs.glyph.my/self-hosting/native.md): Run the Glyph server as one binary on Windows, macOS, Linux or a VPS, with automatic HTTPS.
- [YouTube companion](https://docs.glyph.my/self-hosting/companion.md): Give a Cloudflare server YouTube by running a small helper at home.
- [Sources and API keys](https://docs.glyph.my/self-hosting/providers-and-keys.md): Which sources a server offers, which keys they need and their quotas.
- [Accounts on your server](https://docs.glyph.my/self-hosting/accounts.md): Run accounts and sync on your own server, with your own domain.
- [Limits and protection](https://docs.glyph.my/self-hosting/limits.md): Rate limits, abuse protection, storage ceilings and private servers.
- [CLI reference](https://docs.glyph.my/self-hosting/cli.md): Every command of the glyph CLI: versions, own server, Cloudflare and remote management.
- [API reference](https://docs.glyph.my/self-hosting/api.md): The HTTP API the app uses, for custom clients and tools.

## Components

- [r-dlp](https://docs.glyph.my/components/r-dlp.md): Glyph's own fast YouTube audio resolver, written in Rust.

## More

- [FAQ](https://docs.glyph.my/faq.md): Short answers to common questions about Glyph.
- [Privacy](https://docs.glyph.my/privacy.md): What Glyph stores, where, and what it never collects.
- [What's new](https://docs.glyph.my/whats-new.md): Where to find the release notes of the app, the server, the companion and r-dlp.
- [Development](https://docs.glyph.my/contributing/development.md): Build, test and change the app, the server and r-dlp.
- [Translations](https://docs.glyph.my/contributing/translations.md): Improve a translation of Glyph or add a new language.