Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rocksky.app/llms.txt

Use this file to discover all available pages before exploring further.

Every SDK wraps the Rocksky XRPC API (the same namespace tree under app.rocksky.*) with idiomatic, typed bindings for the host language.

TypeScript

@rocksky/sdk — Bun, Node 18+, Deno, browsers, Workers

Python

rocksky — asyncio + Pydantic v2 models

Rust

rocksky crate — tokio + reqwest, fluent builders

Go

github.com/tsirysndr/rocksky/sdk/go/rocksky

Ruby

rocksky gem — stdlib-only, IRB-friendly

Kotlin

app.rocksky:rocksky-kotlin — coroutines + Ktor

Elixir

rocksky_ex — pipe-friendly, Req-based

Clojure

app.rocksky/sdk — plain maps in, plain maps out

Gleam

rocksky — typed Request(a) pipeline

Common surface

All SDKs share the same shape:
  • Default base URLhttps://api.rocksky.app
  • Bearer auth — pass a JWT to write or access user-scoped endpoints
  • Namespacesactor, album, artist, song, scrobble, charts, feed, graph, like, shout, playlist, player, stats, apikey, mirror, dropbox, googledrive, spotify
  • Escape hatch — a generic query / procedure / call / xrpc method for endpoints the SDK hasn’t wrapped yet
  • Typed errorsRockskyError (or the language-equivalent base) with status, NSID, and body attached

Choosing an SDK

You’re writing…Use
A web frontend, Cloudflare Worker, or CLI in Node/BunTypeScript
A backend job, notebook, or data pipelinePython
A long-running daemon or system toolRust or Go
A Rails app, script, or IRB sessionRuby
An Android app or JVM serviceKotlin
A Phoenix app or supervised process treeElixir
A Clojure web service or REPL workflowClojure
A typed BEAM app with strict guaranteesGleam

Lexicon-derived types

Public model types are generated from the Rocksky lexicons into each SDK and re-exported under their historical SDK names. Regenerate across all 9 SDKs with bun run lexgen:types at the repo root — the generator lives in tools/lexgen/.

Source

All SDKs live in the monorepo at tangled.org/@rocksky.app/rocksky under sdk/<language>/.