relay-ai: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. Note that the codebase supports Claude Code, OpenAI Codex, and Google Gemini CLI.

Docker / always-on gateway: If a user asks to run Relay AI in a container, follow docs/DOCKER.md (AI checklist + questions). That deploys Server + Admin UI only — not desktop app launch.

Release workflow

Publishing is automated by GitHub Actions (.github/workflows/publish.yml): pushing a v* tag runs typecheck + tests + build, then npm publish (auth via the RELAYAI repo secret — an npm Automation token) and creates a GitHub Release from the matching CHANGELOG.md section. Do NOT run npm publish locally — that double-publishes and fails.

To release a new version:

# 1. Land all code changes and a CHANGELOG.md "## [x.y.z]" section first (committed).
npm version patch --no-git-tag-version   # bump package.json + package-lock (use minor/major as needed)
npm run build                            # rebuild dist — VERSION is derived from package.json automatically
git add -A && git commit -m "release: vX.Y.Z"
git tag -a vX.Y.Z -m "vX.Y.Z"            # MUST be annotated (-a); see below
git push --follow-tags                   # tag push triggers CI → npm publish + GitHub Release

The tag must be annotated (git tag -a). git push --follow-tags pushes only annotated tags, so a lightweight git tag vX.Y.Z is silently left behind: the push reports main -> main, no v* ref reaches the remote, and the publish workflow never triggers. The release looks committed but nothing is published. If that happens, git tag -d vX.Y.Z && git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z recovers it. Verify with git ls-remote --tags origin | grep vX.Y.Z — an annotated tag shows both refs/tags/vX.Y.Z and refs/tags/vX.Y.Z^{}.

package.json is the single source of truth for the version. Never edit src/constants.ts manually for version bumps. dist/ is committed, so rebuild it in the release commit.