Kaleido-Desktop/AGENTS.md
Elijah be865fa992
All checks were successful
Validate Kaleido Desktop / validate (push) Successful in 1m21s
Document the release and push flow for future sessions
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-30 17:28:04 -07:00

2 KiB

Kaleido Desktop

Working rules

  • This is a real desktop Plex client (Tauri 2 + React/TypeScript + libmpv), sibling of the Android TV app at git.elijahkuntz.com/Elijah/Kaleido. Preserve working Plex functionality; never substitute mock content or prototype playback.
  • Design for mouse and keyboard first. Keep Kaleido's artwork-led look (clear logos, backdrop fading into the page, UltraBlur colour wash, neutral near-black chrome) but don't port remote-control patterns that feel wrong with a pointer.
  • Keep the interface restrained: no redundant buttons or navigation.
  • .env (PLEX_SERVER_URL, PLEX_TOKEN) is for local testing only. Never print, commit or embed credentials. .tools/updater.key signs updates; never commit or replace it.
  • Shared code goes in src/ and src-tauri/src/; anything OS-specific goes in src-tauri/src/platform/<os>.rs or tauri.<os>.conf.json.

Testing

  • npm run typecheck, npm test, cargo check --manifest-path src-tauri/Cargo.toml.
  • UI: npm run dev and a browser at http://localhost:1420 (signs in from .env).
  • Native: npm run tauri dev with WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9333; window.__kaleido exposes the stores in development.
  • Mute before playback tests (__kaleido.useSettings.getState().set('volume', 0)). Playback changes real Plex progress and track selections; restore them.

Releases

Built and published locally (CI only validates). In short: bump the version in package.json, src-tauri/Cargo.toml, src-tauri/tauri.conf.json (+ lockfile), add a CHANGELOG.md section, .\scripts\build.ps1, commit + tag vX.Y.Z + push, node scripts/publish-release.mjs X.Y.Z [--prerelease], then node scripts/update-manifest.mjs X.Y.Z <release download URL> and commit/push updates/latest.json. Full checklist: docs/development.md → Releases. Only push or publish when the user asks. FORGEJO_TOKEN lives in the ignored .env.

See docs/architecture.md and docs/development.md.