xai-rust Documentation

xai-rust is a Rust SDK for the xAI API (Grok models). The canonical project documentation now lives under docs/.

• Start here: docs/index.md
• Full specification: docs/SPEC.md
• Architecture: docs/ARCHITECTURE.md
• API guide: docs/API.md
• Tooling and CI: docs/TOOLING.md

Legacy docs from before the refresh are archived in legacy/docs/2026-02-26-refresh/.

Release workflow (maintainers)

Run the local pre-publish sequence before any release:

• just release-readiness
  • Runs pre-commit, parity checks, package list, and publish dry-run.
• just release-evidence
  • Captures the readiness checks plus git branch/worktree evidence.
• just release-local-verified
  • Optional end-to-end publish with evidence pack + publish in one command.
• just release-local-verified-dry-run
  • Validation-only equivalent of the verified publish path.

Use just release-evidence if you need a standalone audit artifact under output/release-evidence/ for review.

Local-only publish workflow (no GitHub Actions)

This project uses local, machine-local release execution only:

• just release-local
• just release-local-dry-run
• just release-local-no-parity
• just release-local-verified
• just release-local-verified-dry-run
• just release-local-migrate <path-to-target-repo>
• just release-local-migrate-dry-run <path-to-target-repo>
• just release-local-migrate-verify <path-to-target-repo>
• just release-readiness
• just release-readiness-target <path-to-target-repo>

For migrating another repo, use:

• pwsh -ExecutionPolicy Bypass -File scripts/export_local_release_kit.ps1 -TargetRepo C:\path\to\other\repo
• Verify with:
  • pwsh -ExecutionPolicy Bypass -File scripts/verify_local_publish_kit.ps1 -TargetRepo C:\path\to\other\repo
  • just release-local-migrate-verify C:\path\to\other\repo
  • just release-readiness-target C:\path\to\other\repo

Run just release-readiness before publishing from this repository. The readiness check now verifies manifest metadata + the publish artifact policy (required files + exclude-based artifact filtering).

For final publish actions from this repo, use:

• just release-local-verified (full evidence + publish in one command)
• just release-local-verified-dry-run (full evidence + dry-run publish)

Refer to .github/LOCAL_ONLY.md for the local-only migration pattern that can be reused in another repository.