Skip to content

Installation

Install Starweft on Linux, macOS, or Windows.

Requirements

  • OpenClaw binary (or a compatible script) for worker task execution

SQLite is automatically bundled at build time — no separate installation required.

curl (macOS / Linux)

The simplest installation method. It auto-detects your platform and downloads the latest binary.

bash
curl -fsSL https://raw.githubusercontent.com/co-r-e/starweft/main/scripts/install.sh | sh

Homebrew (macOS / Linux)

bash
brew tap co-r-e/oss
brew install starweft

Shell completions for bash, zsh, and fish are also installed automatically.

GitHub Releases

You can download pre-built binaries from the GitHub Releases page.

bash
curl -LO https://github.com/co-r-e/starweft/releases/latest/download/starweft-v0.3.0-x86_64-unknown-linux-gnu.tar.gz
tar xzf starweft-v0.3.0-x86_64-unknown-linux-gnu.tar.gz
sudo mv starweft /usr/local/bin/

npm

If you have a Node.js environment, you can also install via npm. A platform-specific binary is automatically downloaded during postinstall.

bash
npm install -g starweft

You can also run it temporarily with npx.

bash
npx starweft --version

cargo install

If you have the Rust toolchain installed, you can build and install from crates.io.

bash
cargo install starweft

Build from Source

bash
git clone https://github.com/co-r-e/starweft.git
cd starweft
cargo build --release

The binary will be located at target/release/starweft.

Platform Notes

  • Default transport: local_mailbox (file-based via Unix socket paths)
  • Data directory: ~/.starweft
  • Secret key files are protected with 0600 permissions

Verify Installation

bash
starweft --version

Next Steps

Quick Start

Set up your first multi-node Starweft environment