Skip to content

install.md

Latest commit

 

History

History
84 lines (56 loc) · 3.22 KB

install.md

File metadata and controls

84 lines (56 loc) · 3.22 KB

Install

Build From Source

./scripts/zig version
rustc --version
./scripts/build-all.sh
./zig-out/bin/orca version --json

Use Zig 0.16.0 (see .zigversion; prefer ./scripts/zig) and the repository's Rust toolchain. zig build intentionally does not invoke Cargo; scripts/build-all.sh builds the user-facing CLI and required orca-daemon companion independently.

Release Artifacts

Phase 41 release helpers build checksum-covered Orca and Edge archives into dist/:

./scripts/build-release.sh
(cd dist && shasum -a 256 -c checksums.txt)

Windows archive smoke-test helper:

.\scripts\build-release.ps1 -ArchiveOnly
.\scripts\install.ps1 -Version 1.1.0 -ArtifactDir .\dist -InstallDir "$env:USERPROFILE\bin"

scripts/build-release.ps1 does not produce release-manifest.json or rendered package manifests. Use scripts/build-release.sh plus scripts/verify-release.sh for production release verification.

Do not use an install-only path without verification. Download the archive, verify dist/checksums.txt, inspect the install script if using it, then install.

Homebrew

Homebrew distribution uses the christopherkarani/homebrew-orca tap and the GitHub Release archives from christopherkarani/Orca.

Maintainer release flow:

./scripts/build-release.sh
brew audit --strict --online dist/package-manifests/homebrew/Formula/orca.rb
brew install --build-from-source dist/package-manifests/homebrew/Formula/orca.rb
brew test dist/package-manifests/homebrew/Formula/orca.rb

User install after the tap repository is published:

brew tap christopherkarani/orca
brew install orca
orca plugin install hermes --yes

Manual Artifact Install

  1. Download or build the archive for your OS and CPU.
  2. Verify its SHA-256 digest against dist/checksums.txt.
  3. Extract the archive, or run scripts/install.sh / scripts/install.ps1 to install the binary and runtime assets together.
  4. Paste the activation command printed by the installer. It invokes the absolute installed binary, so it also works in the shell that launched a first-time install before orca is on PATH. Then run orca doctor.

Package Templates

Templates exist under packaging/:

  • Homebrew: packaging/homebrew/Formula/orca.rb
  • Scoop: packaging/scoop/orca.json
  • WinGet: packaging/winget/orca.yaml
  • npm wrapper: packaging/npm/package.json
  • Docker: packaging/docker/Dockerfile

They contain release-time placeholders until artifacts and checksums are generated.

macOS Notes

macOS builds provide process supervision, environment filtering, staged writes, PATH/shell shims, MCP stdio proxying, audit/replay, and network policy decisions. Transparent filesystem and transparent network enforcement are limited unless orca doctor says otherwise.

Linux Notes

Linux builds use backend detection for namespace, seccomp, Landlock, cgroup, and process supervision capability. v1.1.0 does not install kernel-backed restrictions as an active strong sandbox.

Windows Notes

Windows builds use orca.exe, PowerShell scripts, path normalization, command wrappers, and process cleanup support where implemented. Transparent filesystem and network enforcement are limited unless orca doctor reports active support.