41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Installation
|
|
|
|
Install from a clone with `go run ./setup`. `./install.sh` is a thin wrapper
|
|
around the same command.
|
|
|
|
## Requirements
|
|
|
|
- Go toolchain on `PATH`.
|
|
- `git` on `PATH`, unless using `--local`.
|
|
- OS keyring/Secret Service available.
|
|
- The Go install directory on `PATH`.
|
|
- The agent CLI you plan to launch (`copilot`, `claude`, ...).
|
|
|
|
## What setup does
|
|
|
|
The installer clones or updates a cached source checkout, checks out the latest
|
|
release tag, seeds `config.toml` from `config.example.toml` without overwriting
|
|
existing values, appends marked templates for missing service/provider sections,
|
|
optionally opens the config in an editor, installs `sherlock` plus MCP binaries,
|
|
and installs shell completions when supported.
|
|
|
|
One implementation backs both bootstrap setup and `sherlock update`.
|
|
|
|
## Flags and environment
|
|
|
|
Setup flags: `-y`/`--yes` skips the editor, `--config-only` edits config without
|
|
installing, `--local` builds the current checkout, `-h`/`--help` prints usage.
|
|
|
|
Environment: `SHERLOCK_CONFIG` selects the config path,
|
|
`SHERLOCK_UPDATE_REPO_URL` selects the source repo, and `VISUAL`/`EDITOR`
|
|
selects the editor.
|
|
|
|
## Updating
|
|
|
|
Use `sherlock update` to install a newer release, or `sherlock update --force`
|
|
to reinstall the latest release. Updates rebuild binaries and completions, and
|
|
may append marked config templates for newly shipped service/provider sections.
|
|
They do not rewrite existing config values.
|
|
|
|
Re-running setup is safe: it preserves config and reinstalls binaries.
|