# Setup Install the CLI, obtain your Registry URL from your administrator, and configure a default skills integration before following [Getting started](getting-started.md). ## macOS Install with Homebrew: ```sh brew tap ascending-llc/jarvis brew install ascending-llc/jarvis/jarvis-registry ``` Upgrade with `brew upgrade jarvis-registry`. Bash, zsh, and fish completions are installed automatically. After a fresh installation, restart your shell before using them. ## Windows Install with winget: ```powershell winget install Ascending.JarvisRegistryCLI ``` Upgrade with `winget upgrade Ascending.JarvisRegistryCLI`. Where winget is unavailable, use the installer script instead. It supports Windows amd64 and arm64 under Windows PowerShell 5.1 or PowerShell 7: ```powershell irm https://raw.githubusercontent.com/ascending-llc/jarvis-registry-cli/main/scripts/install.ps1 | iex ``` Review the [installer source](../scripts/install.ps1) before running it. The installer verifies the download's checksum and the binary's Authenticode signature, then adds the install directory to your `PATH`; open a new terminal afterward. Run from a non-elevated session, it installs to `%LOCALAPPDATA%\Programs\jarvis-registry` and updates your user `PATH`. Run from an elevated session, it installs to `%ProgramFiles%\jarvis-registry` and updates the machine-wide `PATH`. Set `JARVIS_REGISTRY_INSTALL_DIR` to choose a different directory, or `JARVIS_REGISTRY_VERSION` to install a particular release: ```powershell $env:JARVIS_REGISTRY_VERSION = 'v0.6.7' irm https://raw.githubusercontent.com/ascending-llc/jarvis-registry-cli/main/scripts/install.ps1 | iex ``` When deploying across many machines, set `JARVIS_REGISTRY_VERSION` in the deployment script or in the command you hand out. Without it, each run asks GitHub's API for the latest release, and GitHub allows only 60 such requests per hour from one network address. The installer supports v0.6.7 and later, the first signed releases; install older releases manually from the releases page. Re-running the command upgrades an existing installation in place. The installer can't run where AppLocker or WDAC enforces script rules, which puts PowerShell in Constrained Language mode; use winget or the releases page there. The binary is signed, but Windows may still show a SmartScreen "Windows protected your PC" prompt on first run for the first handful of installations across an organization, tapering off as the binary builds reputation. This is expected and does not indicate a problem with the signature. You can also install an archive manually from the [releases page](https://github.com/ascending-llc/jarvis-registry-cli/releases). For PowerShell tab completion, see [Shell completion](#shell-completion). ## Linux The installer supports Linux amd64 (x86_64) and arm64 (aarch64). The default per-user installation does not require `sudo`. Install the latest release, the `jr` shorthand, and shell completions with: ```sh curl -fsSL https://raw.githubusercontent.com/ascending-llc/jarvis-registry-cli/main/scripts/install.sh | bash ``` Review the [installer source](../scripts/install.sh) before running it. See [Updating the CLI](#updating-the-cli) for upgrades. The default binary directory is `~/.local/bin`; the installer prints any needed `PATH` and zsh completion setup instructions without changing your shell configuration. Bash completion requires `bash-completion` v2 to be installed and sourced by your shell. Completion paths honor `XDG_DATA_HOME` (bash/zsh) and `XDG_CONFIG_HOME` (fish); some versions of `bash-completion` cannot auto-load completions when `XDG_DATA_HOME` contains spaces. To choose a different directory or a particular release, set variables on the `bash` side of the pipe: ```sh curl -fsSL https://raw.githubusercontent.com/ascending-llc/jarvis-registry-cli/main/scripts/install.sh | BINDIR="$HOME/bin" JARVIS_REGISTRY_VERSION=v0.6.6 bash ``` Replace the example version with the release you want. The installer supports v0.6.4 and later; install older releases manually from the releases page. Setting `JARVIS_REGISTRY_VERSION` skips the GitHub latest-release API lookup, so it also works around failures at that step, such as API rate limiting. It still requires access to the installer URL and GitHub release downloads. You can also install an archive manually from the [releases page](https://github.com/ascending-llc/jarvis-registry-cli/releases). ## Go toolchain If the Go toolchain is installed and `GOBIN` is on your `PATH`: ```sh go install github.com/ascending-llc/jarvis-registry-cli/cmd/jarvis-registry@latest ``` A CLI installed this way always reports `dev` for `jarvis-registry --version`. It also includes no completion files; see [Shell completion](#shell-completion). ## Shell completion Homebrew and the Linux installer already install completion files. The `completion` command is useful for Windows, `go install` users, and anyone who wants completion in the current session. It prints a script embedded in the executable; no configuration, login, or network access is needed. **Bash** (including macOS bash 3.2; no `bash-completion` package is required for this command): ```bash eval "$(jarvis-registry completion bash)" ``` **Zsh**, after `compinit` has run (usually handled by your shell configuration): ```zsh source <(jarvis-registry completion zsh) ``` For a plain zsh session, run `autoload -Uz compinit; compinit` first. **Fish:** ```fish jarvis-registry completion fish | source ``` The bash, zsh, and fish scripts register both `jarvis-registry` and the `jr` shorthand when available. **PowerShell** (Windows PowerShell 5.1 or PowerShell 7+): ```powershell jarvis-registry completion powershell | Out-String | Invoke-Expression ``` Keep `Out-String`: it passes the complete multi-line script to `Invoke-Expression`. The script registers both `jarvis-registry` and `jarvis-registry.exe` and supports Constrained Language mode. Windows PowerShell 5.1 has a [completion engine limitation](https://github.com/PowerShell/PowerShell/issues/2912): a bare `--` does not trigger native completion. Type a flag prefix such as `--h`, `--m`, or `--i` before pressing Tab. PowerShell 7 supports completion immediately after `--`. Each command enables completion for the current session only. To load it in future sessions, add the same line to `~/.bashrc`, `~/.zshrc` (after `compinit`), or `~/.config/fish/config.fish`. For PowerShell, add it to `$PROFILE` if your machine allows profile scripts to run and you control that file. On managed machines where execution policy blocks profiles or IT manages them centrally, run the command in each new session; no profile changes are required. ## Updating the CLI For Linux and Windows installations made with an install script or a manually downloaded release: ```sh jarvis-registry update --check # Report an available version without changing the executable. jarvis-registry update # Download, verify, and install a newer release. jarvis-registry --version ``` The command checks releases in `ascending-llc/jarvis-registry-cli` directly on GitHub; Registry configuration and login are not required. It selects a release for your operating system and architecture, verifies the download against the release's SHA-256 `checksums.txt`, and replaces the resolved executable. The `jr` symlink continues to work. A checksum failure leaves the installed executable untouched. On Windows, self-update does not verify Authenticode signatures. If the current version is already the latest, the command reports that and exits successfully. It also refuses to downgrade a newer local version. `--check` exits successfully when a newer version is available and does not download the archive or change the executable. Network, validation, and installation failures exit with an error. The executable's directory must be writable; for an administrator-installed copy, use an appropriately privileged terminal. Only one self-update per OS user can install into a given executable path at a time. Another attempt reports that an update is already in progress; wait for it to finish before retrying. `--check` does not acquire this lock. Self-update and skills sync share OS-level locks under `~/.jarvis-registry/locks/`, with names `update-.lock` and `skills-.lock` keyed by the resolved executable path and cleaned sync-root path, respectively. No Registry config is loaded for self-update. Lock files remain after release; their presence or age does not indicate a running operation. The OS releases the lock on process exit, including crashes. Do not delete lock files while an operation is running. Because locks are per user, different OS users updating a shared installation such as `/usr/local/bin` do not block each other. Use the upgrade method matching your installation: - **Homebrew:** `brew upgrade jarvis-registry`. Self-update, including `--check`, refuses to run on a Homebrew-managed executable. - **winget:** `winget upgrade Ascending.JarvisRegistryCLI`. Self-update, including `--check`, refuses executables under a `WinGet/Packages` directory for user- and machine-scope installs. - **Go toolchain:** rerun `go install github.com/ascending-llc/jarvis-registry-cli/cmd/jarvis-registry@latest`. These builds report `dev`, so both self-update and `--check` refuse to run. **First upgrade:** a version released before `update` was introduced cannot run this command. Use your original installer or download a current release once; subsequent upgrades can use `jarvis-registry update`. **Shell completions:** self-update replaces only the executable. Rerun your shell's [completion command](#shell-completion) to load the updated embedded script in the current session; a startup-file entry loads the new version in future sessions. To refresh completion files previously copied into your shell's configuration directories, rerun the Linux installer or copy the completion files from the new release archive, then restart your shell. GitHub access is required. `update` uses `GITHUB_TOKEN` from the environment when set. A valid token raises the API rate limit; anonymous requests normally share a 60-requests-per-hour budget per public IP, including other users behind the same corporate NAT or VPN and the Linux installer's latest-release lookup. An expired or revoked token can cause `401 Bad credentials`; update or unset `GITHUB_TOKEN` to resolve it. If GitHub reports a rate limit, wait before checking again; avoid running `--check` frequently in shell startup scripts or scheduled jobs. ## Configure the CLI Run the interactive configuration command: ```sh jarvis-registry configure ``` Enter the Registry base URL supplied by your administrator and choose `claude`, `codex`, or `copilot` as the default skills sync mode. The CLI writes these values to `~/.jarvis-registry/config.yaml`; rerun `configure` whenever they need to change. Confirm the installation and review available commands: ```sh jarvis-registry --version jarvis-registry --help ``` Continue with [Getting started](getting-started.md) to sign in and sync skills.