Getting started

Set up oy as a focused audit/review extension for an existing opencode installation.

Requirements

opencode and a configured model provider
git for target-diff reviews
Rust 1.96+ only when building from source

oy does not store provider credentials or select a provider. Follow opencode’s provider setup, then use opencode once to verify the model works.

Install

Full mise installer

curl -fsSL https://oy.adonm.dev/install.sh | sh

The POSIX shell installer installs or updates mise, oy, opencode, tokei, and Universal Ctags, then runs oy setup. Restart your shell or use the activation command it prints.

Review install.sh before piping it to a shell. Set OY_SKIP_SETUP=1 to skip integration writes or OY_MISE_MINIMUM_RELEASE_AGE to change mise’s release-age filter. Optional Sighthound has no release binary; set OY_INSTALL_SIGHTHOUND=1 only when Rust 1.85+ is already installed and you want mise to build it from source.

Minimal manual install

mise use --global cargo-binstall cargo:oy-cli opencode
oy setup
oy doctor

You can also install from crates.io:

cargo install oy-cli --locked

Optional evidence helpers can be added later from the reference.

Choose setup scope

oy setup --dry-run        # preview global changes
oy setup                  # ~/.config/opencode/
oy setup --workspace      # .opencode/ in this repository

Global setup is convenient for personal use. Workspace setup is useful when one repository needs local overrides. Restart running opencode sessions after setup changes.

Config rewrite: oy replaces its documented config entries and pretty-serializes opencode.json. Other object keys remain, but JSONC comments and formatting do not. Back up a hand-edited config and preview first.

Create a first report

cd your-repository
oy doctor
oy audit

opencode runs the restricted auditor and writes ISSUES.md. Start with a small or medium repository so you can inspect the protocol and report before increasing scope.

For a code-quality review:

oy review             # collected workspace
oy review main        # git diff main

Continue with the workflow guide to understand focus text, path scope, SARIF, finding IDs, and reruns.

Compatibility

Prebuilt releases cover Linux x86_64/aarch64 with glibc and Apple Silicon macOS. Other Rust targets may build from source but are not release-tested. The curl installer assumes a Unix-like shell.

See the compatibility matrix for the distinction between CI-tested, release-built, and best-effort environments.

oy documentation