> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/get-started/quickstart-image-enhancement.md).

# Quickstart: Image Enhancement

Enhance your first image on-premise using the VIESUS CLI. This guide takes you from download to enhanced output.

**Prerequisites:** Access to the [VIESUS Transfer Portal](https://transfer.viesus.com) with a valid [license](/licensing/overview.md)

***

{% stepper %}
{% step %}

## Install VIESUS

Download the package for your platform from [transfer.viesus.com](https://transfer.viesus.com) and install it. Choose the GPU installer if you have an NVIDIA Ampere GPU with ≥ 8 GB VRAM; otherwise use the CPU installer.

{% tabs %}
{% tab title="Linux (amd64)" %}

```bash
sudo dpkg -i viesus-redist_<VERSION>_amd64.deb \
             viesus_<VERSION>_amd64.deb \
             viesus-license_<VERSION>_amd64.deb

# Verify installation
/usr/local/viesus/viesus -v
```

{% endtab %}

{% tab title="Windows" %}
Right-click `VIESUS_Viewer_and_CLI_Setup_VIESUS_<VERSION>_GPU_x64.exe` → **Run as administrator**, accept the EULA, follow the wizard, restart when prompted.

```powershell
# Verify installation
"C:\Program Files\Imaging Solutions\VIESUS\viesus.exe" -v
```

{% endtab %}
{% endtabs %}

Expected output: `VIESUS X.XX.XX ...` (version matches the package you installed)

{% hint style="info" %}
For the full walkthrough with screenshots see [Installation](/installation/cli.md).
{% endhint %}
{% endstep %}

{% step %}

## Activate your license

After installing, activate your license on the target machine.

* **GUID:** No activation step needed. Keep your GUID handy — you'll pass it to every command in the enhancement steps below.
* **Activation Key:** Generate a request file with the VIESUS License Tool, send it to Viesus AG, and apply the activation file you receive back. Step-by-step with screenshots: [Licensing → Activation Key](/licensing/activation-key.md).

No license yet? Contact <info@viesus.com> to request a trial.
{% endstep %}

{% step %}

## Enhance your first image

Process a single file.

{% tabs %}
{% tab title="Linux" %}

```bash
/usr/local/viesus/viesus \
  -p viesusini.json \
  -s \
  -f /path/to/photo.jpg
```

{% endtab %}

{% tab title="Windows" %}

```powershell
"C:\Program Files\Imaging Solutions\VIESUS\viesus.exe" ^
  -p viesusini.json ^
  -s ^
  -f "C:\Photos\photo.jpg"
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**GUID users:** add `-g "your-guid"` to every command, e.g. `-g "4e8f35ab-7f72-4b1e-a1fd-2b5e9c58e9d3"`. Activation Key users omit the `-g` flag — the activated install unlocks the library at runtime.
{% endhint %}

The `-s` flag saves output in the same folder with a `_viesus` suffix:

* Input: `photo.jpg` → Output: `photo_viesus.jpg`
  {% endstep %}

{% step %}

## Process a batch

Create an image list file (`images.lst`) with one path per line, then run VIESUS.

{% tabs %}
{% tab title="Linux" %}

```bash
# Generate list from a folder
find /path/to/photos -name "*.jpg" > images.lst

# Process
/usr/local/viesus/viesus \
  -p viesusini.json \
  -b /path/to/output \
  -l images.lst
```

{% endtab %}

{% tab title="Windows" %}

```powershell
# Generate list from a folder
dir /s /b /path/to/photos/*.jpg > images.lst

# Process
"C:\Program Files\Imaging Solutions\VIESUS\viesus.exe" ^
  -p viesusini.json ^
  -b "C:\Output" ^
  -l images.lst
```

{% endtab %}
{% endtabs %}

A result file (`images.res`) is written alongside the list — one line per image with a status code.
{% endstep %}
{% endstepper %}

***

## Common issues at setup

| Symptom                | Cause                                              | Fix                                                                                                         |
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| License not recognised | GUID wrong or spaced / activation file not applied | For GUID users, check the `-g` value; for Activation Key see [Activation Key](/licensing/activation-key.md) |
| `File not found`       | Path in image list doesn't exist                   | Verify paths with `ls` or `dir`                                                                             |
| Slow AI features       | GPU not detected                                   | Run `nvidia-smi`; ensure you installed the GPU variant                                                      |
| Permission denied      | Output folder not writable                         | `chmod 775 /path/to/output`                                                                                 |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.viesus.com/get-started/quickstart-image-enhancement.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
