rocksky.app / rocksky

0

A decentralized music tracking and discovery platform built on AT Protocol 🎵 rocksky.app

spotify atproto lastfm musicbrainz scrobbling listenbrainz

0

rocksky / docs

7 folders 10 files

at main

Tsiry Sandratraina feat(cli): control CLI playback from web/mobile miniplayers via /ws 4hrs ago

docs(openapi): add feed and following query params to getStories

1 month ago

feat(cli): control CLI playback from web/mobile miniplayers via /ws Make the Rocksky CLI player a controllable device on the /ws relay, like the Rockbox companion: it registers with the session token, streams its now-playing (track + status) to the web/mobile miniplayers, and executes play/pause/next/previous/seek commands from them — elapsed time stays in sync both ways. - cli: new tui/rockskyWs.ts (register, push state, handle commands), wired into startHeadlessRuntime so it runs for the TUI and `mpd` daemon. Device name is configurable via [remote] name in settings.toml (default "Rocksky CLI"); ROCKSKY_NO_REMOTE disables it. - api: include device_name in ws broadcasts so clients can label the source. - web: add a "device" player source to StickyPlayer — remote now-playing, live progress, and transport sent back as commands. - web-mobile: label the remote source with device_name; add remote previous + seek.

4 hours ago

docs: add Web Scrobbler integration guide Covers installing the browser extension, copying the per-user webhook URL from the Rocksky avatar menu, and pasting it into Accounts → Webhook → API URL. Screenshot copied from the in-app modal asset.

1 month ago

docs: add Web Scrobbler integration guide Covers installing the browser extension, copying the per-user webhook URL from the Rocksky avatar menu, and pasting it into Accounts → Webhook → API URL. Screenshot copied from the in-app modal asset.

1 month ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs: add scrobble mirroring guide for Last.fm, ListenBrainz, Teal.fm Mirroring lets users keep an existing scrobbler and pull plays into Rocksky without repointing clients — distinct from the existing "Migrating from…" pages. New Mirroring group covers the overview (how it differs from migrating, dedup, backfill) plus one page per supported source.

1 month ago

docs(sdk): sync BEAM + clojure docs for scrobble_match object refactor The scrobble_match param-object refactor and version bumps were documented across most SDKs but missed elixir/erlang/gleam and docs/sdks/clojure.mdx. - scrobble_match now takes a param object everywhere: elixir/erlang maps, gleam ScrobbleMatch record, clojure map (title/artist required; album, mbId/isrc, timestamp optional). Drops the stale erlang /3 arity that no longer exists. - Bump versions to match manifests: rocksky_ex 0.6, gleam 1.6, rocksky_erl 0.3.0, clojure 0.6.0-SNAPSHOT.

4 days ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

CONTRIBUTING.md

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs(cli): document the import and mpd commands Add Mintlify pages for the two new CLI commands: - cli/import — a dedicated step-by-step import guide: request a Spotify/ Last.fm export, create a Bluesky App Password, set the required ROCKSKY_IDENTIFIER / ROCKSKY_PASSWORD env vars, dry-run, then import. Documents autodetection, metadata enrichment, PDS-safe rate limiting, dedup, and resumable checkpoints, plus the full option table. - cli/mpd — serving the library over the MPD protocol (port/bind, settings.toml, client examples). Wire both into the Rocksky CLI nav group and the overview command table.

2 days ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs: replace Mintlify starter with real Rocksky documentation Migrate the docs site from the Mintlify template scaffold to real content sourced from docs.rocksky.app and the SDK READMEs. Adds guides for integrations (Jellyfin, Navidrome, Pano Scrobbler, Kodi, Claude Desktop MCP, local scrobble API), migrations (Last.fm, ListenBrainz), the `rocksky` CLI, and per-language SDK pages (TypeScript, Python, Rust, Go, Ruby, Kotlin, Elixir, Clojure, Gleam). API reference auto-generates from the production openapi.json.

1 month ago

docs(mintlify): rewrite SDK docs for the actual native SDKs Rewrite all 10 sdks/ pages away from the legacy HTTP/bearer-token client docs to the real SDKs: native-core bindings (python/ruby/elixir+erlang/gleam/clojure/ kotlin), indigo (go), atcute (typescript), jacquard rocksky-sdk (rust). Document the common surface (unauth AppView reads + app-password Agent writes + identity hashes) and, where present, the dedup index + Jetstream real-time sync. Update the overview + language counts (10, incl. Erlang). The api-reference bearer-token docs are unchanged (that's the XRPC API itself, not the SDK).

5 days ago

docs(mintlify): rewrite SDK docs for the actual native SDKs Rewrite all 10 sdks/ pages away from the legacy HTTP/bearer-token client docs to the real SDKs: native-core bindings (python/ruby/elixir+erlang/gleam/clojure/ kotlin), indigo (go), atcute (typescript), jacquard rocksky-sdk (rust). Document the common surface (unauth AppView reads + app-password Agent writes + identity hashes) and, where present, the dedup index + Jetstream real-time sync. Update the overview + language counts (10, incl. Erlang). The api-reference bearer-token docs are unchanged (that's the XRPC API itself, not the SDK).

5 days ago

README.md

Rocksky Docs#

The source for docs.rocksky.app — the documentation site for Rocksky, a decentralized, open-source music scrobbling network built on the AT Protocol.

Built with Mintlify.

Structure#

docs/
├── docs.json                # Mintlify config (navigation, theme, anchors)
├── index.mdx                # Landing page
├── quickstart.mdx           # 5-minute onboarding
├── faq.mdx
├── integrations/            # Jellyfin, Navidrome, Pano Scrobbler, Kodi, …
├── migrations/              # from-lastfm, from-listenbrainz
├── cli/                     # `rocksky` CLI reference (one page per command)
├── sdks/                    # TypeScript, Python, Rust, Go, Ruby, Kotlin,
│                            #   Elixir, Clojure, Gleam
└── api-reference/
    ├── introduction.mdx
    └── openapi.json         # Production OpenAPI spec (auto-generates endpoints)

The API reference endpoint pages are generated from openapi.json at build time — don't edit them by hand.

Local development#

Install the Mintlify CLI:

npm i -g mint

From this directory:

mint dev              # preview at http://localhost:3000
mint broken-links     # validate internal links

Updating the API reference#

Replace api-reference/openapi.json with a regenerated spec — the endpoint tree under the API reference tab will pick it up automatically.

Publishing#

Changes pushed to main deploy automatically via the Mintlify GitHub app.

Contributing#

Issues and PRs welcome at tangled.org/@rocksky.app/rocksky. Chat with the team on Discord.

License#

MIT © Tsiry Sandratraina.