Weave documentation

Installation and support

Supported platforms, release versions, consent and workspace ownership.

Current packages

PackageCurrent versionPurpose
joinweave0.1.1Workspace installer and retained-data uninstall
@useweave/cli0.1.0Node launcher for the native weave executable
@useweave/mcp0.1.0Runtime MCP server over stdio
@useweave/cli-darwin-arm64, @useweave/cli-darwin-x640.1.0macOS prebuilt executables
@useweave/cli-linux-arm64, @useweave/cli-linux-x640.1.0Linux prebuilt executables

The installer patch does not change the native or MCP versions. Version-specific evidence is on the 0.1.1 release page.

Prerequisites

Use Node.js 20 or newer with npm/npx available. Keep optional dependencies enabled so npm can select the native package matching the Node process's OS and architecture.

PlatformArchitectureNative requirementsManaged background node
macOSApple Silicon / arm64Executable minimum load target: macOS 11User launchd session
macOSIntel / x64Executable minimum load target: macOS 11User launchd session
Linuxx64glibc 2.39 or newerWorking systemd --user session
Linuxarm64glibc 2.39 or newer, libssl.so.3 and libcrypto.so.3Working systemd --user session

Windows, musl distributions and older glibc versions are unsupported by this release. The macOS value is the binary's load target, not a claim that every macOS 11 configuration has been tested. Your chosen Node version must also support your OS.

The node needs network access to public peers, including the default dht1.weave.earth, dht2.weave.earth and dht3.weave.earth bootstrap endpoints on TCP 4001. Public connectivity and relay capacity depend on the network. No account login or private-key upload is part of installation.

Install

npx joinweave

For a pinned headless install:

npx joinweave@0.1.1 --yes --json

--json produces one JSON result on stdout, without prompts. Failure returns ok: false and a nonzero exit status. Doctor failure is installation failure; the recoverable workspace and node may remain for diagnosis and a rerun.

OptionBehavior
--yesHeadless install; skips PATH and MCP questions
--jsonOne machine-readable result; no prompts
--pathExplicit consent to add a managed shell PATH entry
--mcp-client CLIENTExplicit consent to configure the named client; repeat or use a comma-separated list
--no-mcpSkip agent configuration
--no-serviceStart a detached background node instead of installing a user service

A system without a systemd user session can use:

npx joinweave@0.1.1 --yes --no-service --no-mcp --json

A detached node still needs to be running for doctor and strand operations. It has no OS service supervision.

The default native binary is ~/.weave/bin/weave. Config, identity, data and logs live under ~/.weave; the installer also creates ~/Weave. WEAVE_HOME may select a dedicated absolute workspace directory, separate from your home and the visible folder. Use the same value in every command and agent integration for that workspace.

Interactive installation offers detected MCP clients and a shell PATH entry. --yes and --json alone do not authorize either edit. For example, explicitly consent to PATH and Codex/Cursor configuration:

npx joinweave@0.1.1 --yes --path --mcp-client codex,cursor --json

The installer preserves unrelated configuration, refuses conflicting owned entries and symbolic links, and makes private backups beside edited config files. Open a fresh shell after accepting PATH and restart configured agent clients.

Remove the installation

npx joinweave@0.1.1 uninstall --yes --json

Uninstall removes owned service, binary, PATH and MCP entries, retaining identity and workspace data. Modified entries are preserved and reported. ~/Weave is always preserved. Only use uninstall --purge when you intend to remove the dedicated workspace and its local identity keys.

Public packaging source contains the launcher, installer, MCP server, licenses and prebuilt binaries. The native Rust implementation remains private; this release does not publish an @useweave/sdk package.

On this page