Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Install

Install Starweaver from GitHub Release artifacts, use crates.io packages for SDK code, or run from a checkout while developing inside this repository.

From source

git clone https://github.com/Wh1isper/starweaver.git
cd starweaver
make check
make cli -- -p "hello" --output text

Useful source commands:

make sw -- version
make cli
make cli -- -p "hello" --output text

From GitHub Releases

curl -fsSL https://raw.githubusercontent.com/Wh1isper/starweaver/main/scripts/install.sh | sh

Pinned install:

STARWEAVER_VERSION=vX.Y.Z \
  curl -fsSL https://raw.githubusercontent.com/Wh1isper/starweaver/main/scripts/install.sh | sh

Custom install directory:

STARWEAVER_INSTALL_DIR="$HOME/bin" \
  curl -fsSL https://raw.githubusercontent.com/Wh1isper/starweaver/main/scripts/install.sh | sh

Installer environment variables:

VariablePurpose
STARWEAVER_VERSIONInstall a specific release tag, such as vX.Y.Z.
STARWEAVER_INSTALL_DIRChoose an install directory.
STARWEAVER_COMPONENTSComponent list; current release artifacts provide cli.
STARWEAVER_NO_MODIFY_PATHSet to 1 to skip shell profile updates.
STARWEAVER_GITHUB_REPOOverride the release repository for forks.

The CLI component installs starweaver, starweaver-cli, sw, and starweaver-rpc.

Crates

[dependencies]
starweaver-agent = "X.Y.Z"

Use the workspace path while developing inside this repository:

[dependencies]
starweaver-agent = { path = "crates/starweaver-agent" }

Update

Installed CLI binaries update through the launcher:

starweaver update
starweaver update cli
starweaver cli update
starweaver update --dry-run
starweaver update --force

The update command invokes the installer with STARWEAVER_COMPONENTS=cli, replaces CLI launcher binaries, and preserves existing configuration and session data under ~/.starweaver. It checks the current CLI package version before installing and returns status=up-to-date when the selected release is already installed. Use --force or STARWEAVER_UPDATE_FORCE=1 to reinstall the selected release.