software-brain-engine

Install And Release

SBE should install like a normal developer tool: download one installer, click it, then run sbe from any terminal.

target/ is not a release folder. It is Cargo’s local build cache and is ignored by Git. Release users should only see generated artifacts such as .msi on Windows or archives on Unix platforms.

.sbe/ is also generated runtime data. It belongs inside the project being indexed and should stay out of Git unless a fixture intentionally needs a checked-in debug sample.

Windows

Preferred distribution is a single MSI:

GitHub Releases

powershell -NoProfile -ExecutionPolicy Bypass -File .\scripts\build-msi.ps1 -Version 0.2.0

The MSI build requires WiX Toolset v3.x on PATH. Install it from an Administrator terminal, for example:

choco install wixtoolset --no-progress -y

The MSI installs sbe.exe under Program Files and appends the install folder to the system PATH, so users can run sbe from a new terminal after installation.

The release artifact should be:

sbe-0.2.0-windows-x64.msi

Do not publish target/, .wxs, .wixobj, or loose build folders as release downloads.

For development:

cargo install --path crates/cli --force

macOS and Linux

Release builds publish compressed native binaries from GitHub Actions. Development install:

Platform Artifact Location
Windows x64 sbe-0.2.0-windows-x64.msi GitHub Releases
Linux x64 sbe-linux-x64.tar.gz GitHub Releases
macOS ARM64 sbe-macos-arm64.tar.gz GitHub Releases
cargo install --path crates/cli --force

npm

SBE is not published to npm yet. Do not add an npm badge until an npm package exists.

If npm support is added later, it should be a convenience installer/wrapper for the native sbe binary, not a replacement for the Rust CLI.

Verify

sbe version
sbe doctor /path/to/project

Maintainer Release Flow

  1. Update version metadata.
  2. Run the quality gate:
cargo fmt --check
cargo test --workspace
cargo clippy --workspace -- -D warnings
cargo build --release -p sbe-cli
  1. Create a tag such as v0.2.0.
  2. GitHub Actions builds release artifacts:
    • sbe-0.2.0-windows-x64.msi
    • sbe-linux-x64.tar.gz
    • sbe-macos-arm64.tar.gz