Installation and Upgrades

Installation and upgrades

Language: English · 简体中文

For most users, the best installation is Agent-directed: install the global lwc command once, then let LWC's idempotent AgentTarget installer configure the supported surfaces of the Agent hosts you actually use.

Requirements

• macOS on x86_64 or Apple silicon;
• glibc Linux on x86_64 or aarch64;
• Windows x86_64 or ARM64 through the native release package; the shell installer requires Git Bash;
• Node.js 22 or newer when installing through npm;
• Rust and Cargo only when installing from crates.io or source.

The optional MarkItDown, AnyDoc, Grafeo, SurrealDB, and CodeGraph capabilities have separate setup and consent boundaries. The base CLI does not silently install or enable them during lwc init.

Recommended installation

Homebrew

Prebuilt bottles are available for Apple silicon macOS and x86_64 Linux:

brew install JanYork/tap/lwc

npm

The npm package downloads the matching GitHub Release binary and verifies its SHA-256 checksum:

npm install --global @i-xor/lwc

GitHub installer

The installer verifies the selected release archive against SHA256SUMS and installs to a user-writable binary directory:

curl --proto '=https' --tlsv1.2 -fsSL https://github.com/JanYork/llm-wiki-cli/releases/latest/download/install.sh | sh

It uses ~/.local/bin by default and updates an existing copy in ~/.local/bin or ~/.cargo/bin. To use another directory for this invocation:

curl --proto '=https' --tlsv1.2 -fsSL https://github.com/JanYork/llm-wiki-cli/releases/latest/download/install.sh | LWC_INSTALL_DIR="$HOME/bin" sh

crates.io

cargo install --locked lwc

Build from GitHub

cargo install --locked --git https://github.com/JanYork/llm-wiki-cli

For a local checkout:

git clone https://github.com/JanYork/llm-wiki-cli.git
cd llm-wiki-cli
cargo install --locked --path .

Verify the CLI

Do not assign the binary path to a shell variable for routine use. The command should be globally callable:

command -v lwc
lwc --version
lwc --help

If command -v lwc fails after an installer reports success, add the install directory to your shell's PATH, start a new shell, and repeat the checks.

Configure your Agents

LWC can detect installed Agent hosts and install each host's officially supported MCP, Skill, Hook, Instructions, and permission surfaces:

lwc agent install --yes
lwc agent status --target all --location global

--yes uses detected Agents and default global settings without an interactive prompt. It does not mean “install every possible Agent.”

Restart any Agent whose configuration is read only at startup. Complete the host's normal trust or permission review when it appears. LWC does not bypass UI-owned trust decisions.

For explicit control:

lwc agent install --target codex,claude,pi --location global --yes
lwc agent install --print-config codex
lwc agent refresh --target codex,claude,pi --location global

--print-config only prints the proposed configuration. It does not write files. Install and refresh are idempotent; uninstall restores only LWC-owned state.

Do not install both the direct AgentTarget integration and the optional native package for the same Agent.

Initialize global memory

Global memory is optional but useful for stable preferences and practices that apply across projects:

lwc --scope global init

Run it once. Project-specific facts still belong in project scope.

Upgrade

Use the same distribution channel that installed LWC:

brew update
brew upgrade lwc

npm install --global @i-xor/lwc@latest

cargo install --locked --force lwc

The GitHub installer is also an updater:

curl --proto '=https' --tlsv1.2 -fsSL https://github.com/JanYork/llm-wiki-cli/releases/latest/download/install.sh | sh

After upgrading:

lwc --version
lwc agent refresh --target auto --location global
lwc agent status --target all --location global

Agent refresh updates owned integration content without duplicating entries or overwriting unrelated configuration.

Security notes

• Download only from the official repository, Homebrew tap, npm package, or crates.io package named on this page.
• Release installers verify SHA-256 checksums. A checksum protects integrity; it is not publisher code signing.
• Do not copy configuration paths from a maintainer's private workstation. Use the Agent host's official conventions and LWC's registered AgentTarget adapter.
• Keep adapter credentials in the adapter's environment. Do not store secrets in LWC configuration, Wiki pages, tags, reasons, or operation history.

Next: Quick start