# Install Reticle

Download [Reticle Desktop](https://github.com/mannders00/reticle/releases/latest),
install the package for your computer, and open a sample or a new workspace.
Desktop runs locally without a Reticle account.

## Choose a package

| Platform | Release file |
|---|---|
| macOS, Apple Silicon | `Reticle_x.y.z_macos_arm64.dmg` |
| macOS, Intel | `Reticle_x.y.z_macos_amd64.dmg` |
| Linux, x86_64 | `Reticle_x.y.z_linux_x86_64.AppImage`, `Reticle_x.y.z_linux_amd64.deb`, or `Reticle_x.y.z_linux_x86_64.rpm` |
| Windows, x86_64 | `Reticle_x.y.z_windows_x64.msi` or `Reticle_x.y.z_windows_x64-setup.exe` |

Replace `x.y.z` with the release version. Linux packages target Ubuntu 24.04+ or
compatible GTK4/WebKitGTK 6.0 systems. See [supported platforms](supported-platforms.md)
for feature differences, including Windows terminal limitations.

## Verify and install

Download `SHA256SUMS` from the same release. On Linux, set `PACKAGE` to the
downloaded filename and run:

```sh
PACKAGE=Reticle_x.y.z_linux_amd64.deb
grep "  $PACKAGE$" SHA256SUMS | sha256sum -c -
```

On macOS use `shasum -a 256 -c -` instead of `sha256sum -c -`. On Windows compare
`Get-FileHash .\Reticle_x.y.z_windows_x64.msi -Algorithm SHA256` with its entry in
`SHA256SUMS`. A checksum checks the file against the published digest; packages
are not currently code-signed.

### macOS

Open the DMG and drag Reticle into Applications. macOS may show an
unknown-developer warning. After verifying the download, use the system's
**Open Anyway** option in **System Settings → Privacy & Security** if required.

### Linux

- **AppImage:** run `chmod +x Reticle_*.AppImage`, then launch the file.
- **DEB:** run `sudo apt install ./Reticle_*_linux_amd64.deb`.
- **RPM:** run `sudo dnf install ./Reticle_*_linux_x86_64.rpm` on a compatible distribution.

### Windows

Run either the MSI or setup EXE. Both install per user. If SmartScreen prompts,
check the release and checksum before using **More info → Run anyway**.
Keep using the same installer format for subsequent upgrades.

## Tools for live checks

Drawing and PDF export do not require external command-line tools. Install the
tools for the features you use and ensure the Reticle process can find them on
its `PATH`:

| Feature | Tool and configuration |
|---|---|
| HTTP status checks | `curl`; network access to the URL |
| HTTP JSON predicates | `curl` and `jq` |
| SSH checks and named actions | `ssh`; working non-interactive authentication for the configured host/user |
| Local commands | Unix with `bash`, plus any programs called by the command |
| Desktop SSH terminal | macOS or Linux with `ssh` |
| Desktop Kubernetes terminal | macOS or Linux with `kubectl`, kubeconfig, and access to the selected pod |

A program available in your interactive shell may not be available to a GUI app
or system service. For Team, install these tools on the daemon host, not on each
teammate's computer.

## Upgrade or uninstall

Install the newer native package over the old one, or replace the AppImage.
Reticle keeps its application-data location and references to workspace files.
Back up the YAML files before upgrading; see [workspaces](workspaces.md).

To uninstall, remove the app on macOS, use **Installed apps** on Windows, remove
the AppImage file, or run `sudo apt remove reticle` / `sudo dnf remove reticle`.
Workspace files and application data are separate from the installed program.

## Build from source

Requires Go 1.26+, [Bun](https://bun.sh), and
[native Wails dependencies](https://v3.wails.io/getting-started/installation/).

```sh
git clone https://github.com/mannders00/reticle
cd reticle
bun install
go tool wails3 task dev
```

Use `go tool wails3 task build` for a native executable and
`go tool wails3 task package` for native packaging. On macOS, use
`go tool wails3 task darwin:package:dmg ARCH=arm64` (or `ARCH=amd64`) for a DMG.

Continue with [your first diagram](getting-started.md).
