Skip to content

installation.md

Latest commit

 

History

History
102 lines (69 loc) · 4.02 KB

installation.md

File metadata and controls

102 lines (69 loc) · 4.02 KB
Raw

Installation and updates

Chinese: installation.zh.md

Supported platforms

  • macOS — arm64 and x86_64 artifacts are published.
  • Linux — x86_64-unknown-linux-gnu and aarch64-unknown-linux-gnu (glibc). WSL2 on Windows can use the matching Linux archive.
  • Windows — native x86_64-pc-windows-msvc archives are published on Releases (.tar.gz / .tar.zst). The one-liner install.sh covers macOS and Linux; on Windows download an archive from Releases, extract finclaw.exe, and put it on your PATH (or use WSL2 + the Linux package).

One-line install (recommended)

curl -fsSL https://raw.githubusercontent.com/finogeeks/finclaw-cli/main/install.sh | sh

Cache-busting the script URL (if a CDN serves an old install.sh):

curl -fsSL "https://raw.githubusercontent.com/finogeeks/finclaw-cli/main/install.sh?$(date +%s)" | sh

Pin a version (adjust tag when your release provides install.sh on that tag):

curl -fsSL https://raw.githubusercontent.com/finogeeks/finclaw-cli/main/install.sh | sh -s -- --version 0.1.0

Useful environment variables (see install.sh --help on the branch you install from):

  • FINCLAW_VERSION — version with or without v prefix
  • FINCLAW_INSTALL_DIR — default is $HOME/.local/bin
  • FINCLAW_INSECURE_SKIP_CHECKSUM=1 — emergency only; do not use for normal installs

After install, ensure the install directory is on your PATH, then:

finclaw --version

Manual download and verify

  1. Open Releases and pick a version tag (for example v0.1.0).
  2. Download one platform archive (.tar.gz preferred when available, or .tar.zst) and the SHA256SUMS file for that release.

SHA256SUMS lists every platform archive in the release. You only have one file on disk, so do not run shasum -a 256 -c or sha256sum -c on the full SHA256SUMS file (it will look for the other platform archives and fail). Verify only the line for the file you downloaded:

cd ~/Downloads
VER=0.1.0
FILE="finclaw-v${VER}-aarch64-apple-darwin.tar.gz"   # match your platform triple
grep -F "$FILE" SHA256SUMS | shasum -a 256 -c -

On Linux you can use sha256sum -c in the same grep pipeline if you prefer.

Extract and install the binary

You need tar. Newer releases provide *.tar.gz; older releases may only provide *.tar.zst, which also requires zstd.

Example (Apple Silicon macOS, adjust VER and the archive name):

VER=0.1.0
FILE="finclaw-v${VER}-aarch64-apple-darwin.tar.gz"
tar -xzf "$FILE"
install -m 0755 "finclaw-v${VER}-aarch64-apple-darwin/finclaw" "$HOME/.local/bin/finclaw"

For older *.tar.zst archives, install zstd and run:

zstd -dc "finclaw-v${VER}-x86_64-unknown-linux-gnu.tar.zst" | tar -xf -

PATH — if finclaw is not found:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc   # or ~/.bashrc
export PATH="$HOME/.local/bin:$PATH"

macOS Gatekeeper

Unsigned binaries can be blocked by Gatekeeper. If the binary is quarantined or blocked, use System Settings → Privacy & Security to allow it, or follow your organization’s policy for signed builds.

Updating

Public finclaw-cli installs use the stable GitHub Releases channel by default, so finclaw update can show the right release URL even if you never edited config.yaml.

When a new release is published, run finclaw update --check to inspect the effective channel and latest version without changing files, or run finclaw update to update in place. The updater downloads the matching platform archive, verifies it against SHA256SUMS (or the per-asset hash in release.json), extracts the finclaw binary, saves the previous binary as finclaw.old, and replaces the installed binary.

Uninstall

See troubleshooting.md and run finclaw uninstall --help for options to remove the binary and local state.