Installation
Craft ships as a standalone executable with Node embedded. Pick the install
method that fits your machine or CI runner, then run craft --version to
confirm it works.
Standalone binary
Section titled “Standalone binary”Craft provides standalone executables with Node embedded. Choose the file matching your operating system and CPU:
| Platform | Release file |
|---|---|
| macOS Apple Silicon | craft-darwin-arm64.gz |
| macOS Intel | craft-darwin-x64.gz |
| Linux arm64 | craft-linux-arm64.gz |
| Linux x64 | craft-linux-x64.gz |
| Windows x64 | craft-win-x64.exe |
Native downloads are available starting with the first release containing these assets. Linux builds use glibc; Alpine/musl is not supported. macOS binaries are ad-hoc signed, without Developer ID notarization. Windows binaries do not have Authenticode signatures.
Download the matching asset over HTTPS from the release page. On macOS or Linux,
decompress with gunzip <filename>.gz, rename the executable to craft, run
chmod +x craft, and move it to a directory on your PATH. On Windows, rename
the downloaded executable to craft.exe and put it on your PATH. Run
craft --version to check the installed version.
The existing release asset named craft remains a portable JavaScript bundle
requiring Node. Existing action, CDN, and nightly consumers can continue using it.
Homebrew
Section titled “Homebrew”After the first stable release containing standalone binaries and the formula:
brew install getsentry/tools/craftThe formula selects the native macOS/Linux x64 or arm64 archive and verifies its
SHA-256 checksum. Node is embedded; Git is a formula dependency. Other publishing
targets still require their own tools (for example, npm, Docker, or Python).
Craft’s stable release pipeline updates the formula in getsentry/homebrew-tools
after uploading the release assets. Pre-release versions do not update Homebrew.
Publishing requires the release credential to have write access to that tap.
Shell installer
Section titled “Shell installer”After the first release with native binaries, install the latest stable release on macOS/Linux, or Windows x64 using Git Bash:
curl -fsSL https://craft.sentry.dev/install | bashTo pin a version or choose a directory, download the script first:
curl -fsSL https://craft.sentry.dev/install -o craft-installbash craft-install --version 2.35.0 --install-dir "$HOME/.local/bin"The installer downloads over HTTPS and checks the executable’s version before installing.
It uses CRAFT_INSTALL_DIR, an absolute XDG_BIN_HOME, an existing user bin
folder on PATH, or ~/.local/bin. Add the printed directory to PATH yourself.
It does not use sudo or modify shell profiles. --dry-run prints the selected
version and platform without creating installation files. CRAFT_VERSION
can also pin a release. Linux binaries require glibc.
The installer detects GITHUB_ACTIONS or CI and skips shell completions and
agent skills automatically. In CI, it installs to --install-dir,
CRAFT_INSTALL_DIR, or the runner’s temporary bin directory (falling back to
~/.local/bin) and adds the directory to $GITHUB_PATH when available.
To install a previously downloaded native archive offline, pass --archive /path/to/archive --version VERSION.
Archives still undergo executable version checks and macOS signature verification.
Updating a standalone installation
Section titled “Updating a standalone installation”craft update # latest stable releasecraft update --check # metadata only, without downloading the binarycraft update 2.35.0 # a specific published versioncraft update 2.35.0 --force # reinstall or allow a downgradecraft update --dry-run # metadata only; no files changedThe updater validates the HTTPS release assets and candidate version before
replacing the running executable. macOS signatures are verified too. Unix uses
atomic replacement; Windows keeps a backup until replacement succeeds and
restores it if replacement fails. A running Windows process can prevent deletion
of the old backup; Craft prints its path so you can remove it after those
processes exit. A stale .craft-install.lock after a crash must be removed
only after checking that no installation/update is still running.
craft update is manual; it does not run background updates. npm/pnpm and
Homebrew installations receive instructions to use their package manager.
Explicit prerelease versions are allowed, while the default selects stable.
Stable standalone upgrades use binpatch delta chains when available and smaller than the full download. Craft verifies the patched executable against the target release digest before checking its version and installing it. Missing, oversized, corrupt, or incompatible patches fall back to the normal HTTPS download. The first native release and explicit prerelease installs use full downloads.
Shell completion
Section titled “Shell completion”craft setup installs completions for the shell detected from $SHELL.
Choose a shell explicitly with craft setup --shell bash (also zsh or fish).
This works with standalone, npm/pnpm, and Homebrew installations. The installer
runs setup automatically; craft setup --no-completions skips this step.
To print scripts without writing files:
craft completion bashcraft completion zshcraft completion fishBash files live under $XDG_DATA_HOME/bash-completion/completions, defaulting to
~/.local/share; source the printed file if your shell does not load it automatically.
For zsh, add the printed zsh/site-functions directory to fpath before compinit.
Fish files live under $XDG_CONFIG_HOME/fish/completions, defaulting to ~/.config.
Relative XDG paths are ignored. Both craft and sentry-craft aliases are supported.
Setup prints instructions and does not modify shell profiles. Dry-run writes no
completion files; custom files and symlink destinations are preserved.
Agent skills
Section titled “Agent skills”craft setup installs an embedded, version-pinned craft-cli skill into
~/.agents/skills/craft-cli and ~/.claude/skills/craft-cli when those agent
roots already exist and are writable. No network download is needed. This works
with standalone and npm/pnpm/Homebrew installations.
craft setup --no-agent-skills # remember an opt-out from installation/refreshcraft setup --agent-skills # re-enable installation/refreshThe preference is saved in $XDG_CONFIG_HOME/craft/setup.json, defaulting to
~/.config/craft/setup.json. Standalone updates refresh the skill using the new
binary and honor the saved opt-out. Package-manager users rerun craft setup
after upgrading. Opt-out preserves existing skill files; remove them manually
if you want agents to stop discovering the skill. Custom files and file symlinks
are preserved. Dry-run writes neither preferences nor skill files.
npm / pnpm (not recommended)
Section titled “npm / pnpm (not recommended)”Standalone executables are recommended. The npm package remains supported when Node is already available and uses the JavaScript bundle:
pnpm add -g @sentry/craftnpm install -g @sentry/craft