Install

config-weave is one statically linked executable per platform. In this tutorial you download it, put it on your PATH and confirm it runs. There is nothing else to install on any machine that runs it: no interpreter, no agent and no shared libraries.

Before you start

• A Linux x86_64 or Windows x86_64 machine you can write to.
• A terminal. The commands below use a POSIX shell on Linux and PowerShell on Windows.
• Building from source needs a Rust toolchain and network access to fetch the dependencies. Cross-building the release artifacts also needs cross and a container runtime.

Download a release

Every release on the GitHub releases page carries three files: a Linux binary, a Windows binary and a checksums file.

Linux

Download the Linux binary and the checksums file into one directory, verify the checksum, then move the binary to a directory on your PATH under the name config-weave.

sha256sum --check --ignore-missing SHA256SUMS
chmod +x config-weave-linux-x86_64
mkdir -p ~/.local/bin
mv config-weave-linux-x86_64 ~/.local/bin/config-weave

The checksum command prints config-weave-linux-x86_64: OK. If ~/.local/bin is not on your PATH, add it in your shell profile or choose a directory that is, such as /usr/local/bin.

Windows

Download the Windows binary and the checksums file, verify the hash, then place the binary in a directory on your PATH under the name config-weave.exe. The commands below create a directory under your profile and add it to the user PATH.

Get-FileHash .\config-weave-windows-x86_64.exe -Algorithm SHA256
Select-String config-weave-windows-x86_64.exe .\SHA256SUMS
New-Item -ItemType Directory -Force "$env:LOCALAPPDATA\config-weave"
Move-Item .\config-weave-windows-x86_64.exe "$env:LOCALAPPDATA\config-weave\config-weave.exe"
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$env:LOCALAPPDATA\config-weave", "User")

Compare the hash the first command prints with the line the second command finds. They match when the download is intact. Open a new terminal so the updated PATH takes effect.

Verify the install

Run the version command from any directory.

$ config-weave version
config-weave 0.1.0

Build from source instead

If you would rather build the binary yourself, clone the repository and build with cargo. The build fetches the WCL and wscript crates from GitHub, so it needs network access the first time.

git clone https://github.com/Configweave/config-weave.git
cd config-weave
cargo build --release
./target/release/config-weave version

This produces a binary for your own platform. The repository also ships a justfile with the release recipes. just build makes a debug build. just release cross-builds both release binaries and the checksums file into dist/, and just install copies those into ~/.local/share/config-weave/bin and links the Linux binary as ~/.local/bin/config-weave. Both recipes need cross and a container runtime, because the two targets build inside containers.

Next steps

You have a working binary. In Your first playbook you scaffold a playbook, validate it, and take it through check and apply. The full list of subcommands and global options is in config-weave.