> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vigolium.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Get access to Gimorra, install the CLI and its scan engine, and check that the host is ready.

Gimorra is in invite-only alpha. Get an invite, run one command, and you're scanning.

> [card] [Get your invite: jessie@vigolium.com](mailto:jessie@vigolium.com)
>
> Email [jessie@vigolium.com](mailto:jessie@vigolium.com) with the target you want to point Gimorra at. You'll get a personal install link back.

**1. Get an invitation**

Email [jessie@vigolium.com](mailto:jessie@vigolium.com). You can also [request a demo](https://www.vigolium.com/request-demo) or visit [gimorra.vigolium.com](https://gimorra.vigolium.com/). Your invitation link opens a page with your own install command.

**2. Run the install command**

The command looks like this. Copy the real one from your invitation page:

```bash theme={null}
curl -fsSL <your install URL> | bash
```

The link is yours alone. Don't share it.

**3. Check the host**

```bash theme={null}
gimorra doctor          # read-only report of what is installed and what is missing
gimorra setup --yes     # installs what it can, and tells you any step left for you
```

## What the installer does

One script, five steps, no surprises:

1. Detects the platform. Gimorra supports macOS and Linux, on arm64 or x64.
2. Finds the current release and downloads it. It checks the SHA-256 checksum, and it also checks the release signature when the host's `openssl` supports Ed25519. If a checksum is missing or wrong, the install stops.
3. Installs `gimorra` in `~/.local/bin` by default, and adds that directory to `PATH` in your shell profile.
4. Installs the Vigolium scan engine version that this Gimorra release is tested with, unless Vigolium is already installed.
5. Runs `gimorra setup --yes` to finish setting up the host and to list anything left for you to do.

## Installer options

Pass options after `bash -s --`:

```bash theme={null}
curl -fsSL <your install URL> | bash -s -- --for audit
```

| Option | What it does |
| - | - |
| `--for scan` | Sets up the host for live scans. This is the default. |
| `--for audit` | Sets up the host for source-code audits only. It installs the audit tools and skips the scan engine. |
| `--for browser` | Also installs the browser that browser-driven agents use. |
| `--for all` | Installs everything above. |
| `--path <dir>` | The source tree that `--for audit` sets up language servers for. |
| `--prefetch` | Also downloads the files a run would otherwise download the first time it needs them. |
| `--skip-engine` | Skips installing the Vigolium engine. |
| `--version <v>` | Installs a specific release instead of the latest one. |

## Where to run it

Gimorra runs its tools as your user, on the machine where you start it. Give it a VM, a container or a box you can throw away, not the laptop that holds your keys.

> [!TIP]
>
> In a cloud coding sandbox such as Claude Code on the web, put the install command in the environment's setup script. In auto mode, the agent is not allowed to pipe a downloaded script into `bash` during a session.

## Next steps

> [card] [LLM configuration](https://docs.vigolium.com/gimorra/llm-configuration.md)
>
> Connect the model that drives the agent.

> [card] [Running a scan](https://docs.vigolium.com/gimorra/running-a-scan.md)
>
> Start a scan against a target you are authorized to test.

***

Stuck on install, or want access for your team? Email [jessie@vigolium.com](mailto:jessie@vigolium.com).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.