Development

Build, test and change the app, the server and r-dlp.

Every part is Rust, dual-licensed MIT or Apache-2.0 (r-dlp: MIT). Pull requests are welcome in each repository.

Desktop app

git clone https://github.com/glyphmusic/desktop.git
cd desktop
cargo build --release -p glyph

Rust 1.85 or newer. Linux also needs (Debian/Ubuntu names):

sudo apt-get install libxkbcommon-dev libxkbcommon-x11-dev libwayland-dev libvulkan-dev libx11-xcb-dev libxcb1-dev libfontconfig-dev libfreetype-dev libasound2-dev libdbus-1-dev libssl-dev pkg-config libwebkit2gtk-4.1-dev libgtk-3-dev libsoup-3.0-dev libjavascriptcoregtk-4.1-dev

Path	Contents
`src/`	the app and its UI (GPUI)
`crates/glyph-core`	sources, search, library, settings, sync
`crates/glyph-audio`	playback, crossfade, equalizer, loudness
`crates/glyph-protocol`	types shared with the server
`assets/`	fonts, icons, translations

Quick feedback without linking: cargo check -p glyph. The fast profile gives release speed without LTO for local tests: cargo build --profile fast -p glyph.

On Windows, ./scripts/run-dev.ps1 builds and opens the dev app, ./scripts/dev-watch.ps1 rebuilds after every edit.

Rules

Every feature must work on Linux, macOS and Windows; no platform-only crate without a fallback.
Official APIs only, keys only from settings, environment or secrets.
The server never sees audio the app plays from local yt-dlp.

Server

git clone https://github.com/glyphmusic/server.git
cd server
cargo test --workspace
cargo check -p glyph-server-worker --target wasm32-unknown-unknown

Crate	Target
`glyph-server-core`	shared logic
`glyph-server-native`	binary for Linux, macOS, Windows, Docker
`glyph-server-worker`	Cloudflare Worker (wasm32)

Worker tests against a local workerd:

cd crates/glyph-server-worker
worker-build --dev --no-opt
npm ci
npm test

r-dlp

git clone https://github.com/glyphmusic/r-dlp.git
cd r-dlp
cargo build --release --locked

Docs

These pages live in glyphmusic/docs. The Glyph server renders them at docs.glyph.my straight from the main branch: a push is live within about a minute, no deploy needed.

Edit the Markdown and open a pull request. Edit this page on GitHub at the bottom of every page opens the right file.
SUMMARY.md is the navigation: ## Group headings and * [Title](file.md) items, indented by two spaces for sub-pages.
A page's first # Heading is its title; description: in the front matter is the line under it.
Link other pages by their file (../self-hosting/cli.md#remote-management).
Notes: {% hint style="info" %} … {% endhint %} (info, success, warning, danger). Tabs: {% tabs %}{% tab title="…" %} … {% endtab %}{% endtabs %}. Collapsible answers: <details><summary>…</summary> … </details>. Other HTML is shown as text.
Give every page a description:. It is the lead line, the search snippet and the summary in llms.txt.

Preview your changes locally with the real page template: see preview/.

For search and LLMs

Address	Contents
`docs.glyph.my/search.json`	the index the search box (`Ctrl+K` or `/`) uses
`docs.glyph.my/llms.txt`	every page with its description, as llms.txt
`docs.glyph.my/llms-full.txt`	all pages as Markdown in one file
`docs.glyph.my/<page>.md`	one page as clean Markdown, e.g. `/self-hosting/cli.md`

edit this page on github · markdown