> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rkat.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CD and distribution

> How Meerkat release artifacts are validated, built, and published across Rust, binaries, Python, and TypeScript.

Meerkat publishes one source project across several consumer surfaces:

| Artifact       | Audience                                | Published as                             |
| -------------- | --------------------------------------- | ---------------------------------------- |
| Rust crates    | Rust library users and surface binaries | crates.io                                |
| `rkat`         | CLI users                               | GitHub Release binary, Rust crate binary |
| `rkat-rpc`     | SDK backends and JSON-RPC hosts         | GitHub Release binary                    |
| `rkat-rest`    | HTTP/SSE service hosts                  | GitHub Release binary                    |
| `rkat-mcp`     | MCP host integrations                   | GitHub Release binary                    |
| Python SDK     | Python applications                     | `meerkat-sdk` on PyPI                    |
| TypeScript SDK | Node applications                       | `@rkat/sdk` on npm                       |

The public release path is GitHub Actions. BuildBuddy release lanes are an
owner-only acceleration path and use the same Make-level contract.

## Release Checks

Run the release gate before cutting a tag:

```bash theme={null}
make release-preflight
make verify-version-parity
make verify-schema-freshness
make release-dry-run
```

These checks keep the Rust workspace version, Python package version,
TypeScript package version, and generated contract artifacts aligned before any
registry publish happens.

## Binary Artifacts

Release assets are built for these binaries:

* `rkat`
* `rkat-rpc`
* `rkat-rest`
* `rkat-mcp`

Standard targets:

* `x86_64-unknown-linux-gnu`
* `aarch64-unknown-linux-gnu`
* `aarch64-apple-darwin`
* `x86_64-apple-darwin`
* `x86_64-pc-windows-msvc`

Release assets include platform archives plus a checksum manifest:

* `checksums.sha256`
* `index.json`

Reduced distributions are source builds of the same crates with a narrower
feature set, not separate public binaries.

## SDK Bootstrap

Python and TypeScript SDK users should not need a local Rust toolchain.

| SDK        | Install                   | Runtime resolution                                                                                    |
| ---------- | ------------------------- | ----------------------------------------------------------------------------------------------------- |
| Python     | `pip install meerkat-sdk` | Uses `MEERKAT_BIN_PATH` when set; otherwise resolves a matching `rkat-rpc` release binary             |
| TypeScript | `npm install @rkat/sdk`   | Uses an explicit binary path when configured; otherwise resolves a matching `rkat-rpc` release binary |

The SDKs are clients. They start or connect to the JSON-RPC surface rather than
embedding a separate runtime implementation.

## Release Workflow

1. Validate the release candidate.
2. Build platform binaries.
3. Create the GitHub release and upload binary assets.
4. Publish Rust crates.
5. Publish Python and TypeScript packages.
6. Run install smoke checks for at least one platform.

Manual release dispatch supports dry-run registry validation. Locally, use:

```bash theme={null}
make release-workflow VERSION=vX.Y.Z REGISTRY_DRY_RUN=true
MEERKAT_BUILDBUDDY=1 make release-workflow VERSION=vX.Y.Z REGISTRY_DRY_RUN=true
```

## BuildBuddy

Cargo is the default backend. BuildBuddy is selected explicitly:

```bash theme={null}
MEERKAT_BUILDBUDDY=1 make release-preflight
MEERKAT_BUILDBUDDY=1 make release-assets VERSION=vX.Y.Z
```

Use `make buildbuddy-doctor` when the local BuildBuddy setup looks suspicious.
It checks the API key, pinned `bb` CLI, generated Bazel files, selector
behavior, and lane isolation without printing secrets.

## Credentials

Registry credentials are independent:

| Registry  | Credential          |
| --------- | ------------------- |
| crates.io | Cargo publish token |
| PyPI      | `PYPI_API_TOKEN`    |
| npm       | `NPM_TOKEN`         |

Keep tokens in CI secrets or a local secret store. Do not commit registry
tokens, private BuildBuddy endpoints, or enterprise infrastructure names.

## Hard Rules

* Release only from tagged versions.
* Never publish mismatched Rust, Python, TypeScript, or contract versions.
* Never publish SDKs from a commit with stale generated schema artifacts.
* Keep public binary names stable: `rkat`, `rkat-rpc`, `rkat-rest`, `rkat-mcp`.
* Publish checksums and an index for release binary consumers.

## See Also

* [Build and CI](/reference/build-and-ci)
* [CLI commands](/cli/commands)
