# Quick start

Source: [https://docs.aventail.co.uk/docs/getting-started/quickstartguide](https://docs.aventail.co.uk/docs/getting-started/quickstartguide)

Connect your Mac with **Aventail Link**, deploy one model, then use it in **Workspace** or your own software.

## Before you start

You need an **Apple Silicon Mac**, an available device slot in the intended Control account or organisation, and internet access. Allow disk space and memory for the model and its engine. The Aventail 2.0.0 package installs for your macOS user without an administrator prompt.

*Tested installation and local API: Aventail Link 2.0.0 · macOS 26.6.2 · Llama 3.2 3B Instruct Q4\_K\_M. The separate production Control and Workspace captures use Locai Link (Legacy Aventail) 1.3.2.*

**Other platforms or Link already installed?**

For a server or Windows device, check [published platform builds](https://docs.aventail.co.uk/docs/introduction/versions-and-supported-models) before using [terminal installation](https://docs.aventail.co.uk/docs/getting-started/initial-setup#headless).

If Aventail Link is already installed, confirm the device is **Online** in the intended Control environment and skip to [deployment](https://docs.aventail.co.uk/docs/getting-started/quickstartguide#deploy). Locai Link (Legacy Aventail) 1.x has a separate installation; see [upgrading from the old app](https://docs.aventail.co.uk/docs/link-app/install-macos#if-locai-link-is-already-installed).

## 1\. Sign in

Open your organisation's Control environment and sign in. [Production Control](https://control.locai.co.uk/login) and development Control have separate accounts and devices. Use the same environment and account when Link asks you to sign in.

### Sign in to Control

Control sign-in interface.

1.  **Choose your sign-in method**
    
    Open Control and use Google, GitHub or your email and password. Use the provider you originally registered with.
    
    [Screenshot: Sign-in form — close-up from Control sign-in page.](https://docs.aventail.co.uk/img/sign_in_1_-.png)
    

**First sign-in and account options**

Choose Google, GitHub, or your email and password. On first sign-in, review and accept the **Terms & Conditions** if you agree, then close **What's new**. New accounts open the [web setup wizard](https://docs.aventail.co.uk/docs/getting-started/initial-setup#web-setup-wizard) over the Dashboard.

## 2\. Install and connect Aventail Link

Follow the walkthrough, then check your Mac is **Online** in Control.

[Download Link for macOS (Apple Silicon)](https://get.aventail.co.uk/releases/latest/aventail-link-desktop-macos-arm64.pkg). This is the production release. For a development or staging account, use the download offered by that Control environment.

### Install and connect Aventail Link

Aventail Link 2.0.0 · Apple Silicon · captures from 2 October 2026.

1.  **Open the package**
    
    Open the macOS ARM64 .pkg supplied for your Control environment, then choose Continue.
    
    [Screenshot: Introduction and Continue — close-up from Aventail Link installer.](https://docs.aventail.co.uk/img/link/installation-2.0.0/macos-introduction.png)
    
2.  **Install for your user**
    
    Choose Install. This package installs into your home folder and is available to your macOS user.
    
    [Screenshot: Aventail Link installation type showing 33.1 MB and installation in the home folder.](https://docs.aventail.co.uk/img/link/installation-2.0.0/macos-installation-type.png)
    
3.  **Finish the installer**
    
    Wait for The installation was successful, then choose Close. The separate Aventail Link Setup window opens.
    
    [Screenshot: Aventail Link installer reporting successful installation.](https://docs.aventail.co.uk/img/link/installation-2.0.0/macos-installation-result.png)
    
4.  **Sign in to Aventail**
    
    Select Sign in with Aventail. In the browser, check the account and organisation before approving this device.
    
    The captured 2.0.0 build opens development Control. Use the environment intended for your package.
    
    [Screenshot: Full Aventail Link Setup window at Connect, with Sign in with Aventail and the four setup stages.](https://docs.aventail.co.uk/img/link/installation-2.0.0/setup-connect.png)
    

**Read the installation steps**

1.  Obtain the **Aventail Link 2.0.0 macOS ARM64 `.pkg`** intended for your Control environment. Use the production download above, or the download offered by your development Control environment.
2.  Open the package, choose **Continue → Install**, wait for **The installation was successful**, then choose **Close**.
3.  In **Aventail Link Setup → Connect**, select **Sign in with Aventail**. In your default browser, check the account and organisation, compare the approval code with Link and approve the device.
4.  Return to the **Models** screen and continue below.

The 2.0.0 build used for these screenshots opens **development Control** during sign-in. The public download above is the production channel; keep the package and account environment together. It has no installer licence step or administrator prompt, and the package starts the user service automatically. Setup continues through **Models → Serving → Finish**.

If setup stops, see [macOS installation help](https://docs.aventail.co.uk/docs/link-app/install-macos#if-setup-stops).

## 3\. Deploy and start serving

If you downloaded and enabled a model during Aventail setup, it is already serving: continue to [your first response](https://docs.aventail.co.uk/docs/getting-started/quickstartguide#use-your-model). Otherwise, select a model in setup or deploy one from Control. Keep Link running while it downloads.

### Download and serve during setup

Aventail Link 2.0.0 · development account · 2 October 2026. Identity fields redacted in the Finish image.

1.  **Choose your models**
    
    Tick a model to start downloading it. You can leave all models unticked to deploy from Control later, then select Continue.
    
    Available models depend on your account. This capture shows the development catalogue.
    
    [Screenshot: Model catalogue and download sizes — close-up from Aventail model setup.](https://docs.aventail.co.uk/img/link/installation-2.0.0/setup-models.png)
    
2.  **Let the download finish**
    
    Selecting a model starts its download immediately. Wait for it to finish before expecting a serving toggle on the next screen.
    
    This example uses a 2.0 GB model from the development account.
    
    [Screenshot: Full Aventail Link Setup window at Models, with llama\_3.2-3B-Instruct selected and downloading at 25 percent.](https://docs.aventail.co.uk/img/link/installation-2.0.0/setup-downloading.png)
    
3.  **Start serving**
    
    Once the download is complete, tick the installed model to serve it on port 8100, then choose Continue.
    
    The image shows the model before its serving checkbox is turned on.
    
    [Screenshot: Full Aventail Link Setup window at Serving, with the installed Llama model, its unchecked serving checkbox, Back and Continue.](https://docs.aventail.co.uk/img/link/installation-2.0.0/setup-serving.png)
    
4.  **Finish setup**
    
    Check All set and the installed/serving counts, then select Finish at the bottom-right of the setup window.
    
    Redacted copy of the supplied capture. This walkthrough finished with one model serving.
    
    [Screenshot: Full Aventail Link Setup window at Finish, showing 1 installed and 1 serving and the Finish button; node name and device ID are redacted.](https://docs.aventail.co.uk/img/link/installation-2.0.0/setup-finish-redacted.png)
    

**Read the deployment steps and Control alternative**

1.  In **Models**, tick a model to start downloading it. The captured 2.0.0 walkthrough uses **llama\_3.2-3B-Instruct** (2.0 GB); your account catalogue can differ.
2.  Wait for the download, then select **Continue**. In **Serving**, tick the installed model to serve it on port **8100**. If **Nothing downloaded yet** appears, use **Back** to check progress.
3.  Select **Continue**, check **All set** and the installed/serving counts, then select **Finish**. The captured result shows **1 installed · 1 serving**.

The earlier production Control route is shown below. Use Control in the same environment as the registered device; the development fleet interface may differ.

### Deploy and start serving

Control deployment and serving screens captured 28 September 2026.

1.  **Deploy the starter model**
    
    In Control’s wizard, choose Continue to deploy → Deploy model. Keep Link running while the model downloads.
    
    The device name and available model can differ.
    
    [Screenshot: Deploy stage — close-up from Deployment in the setup wizard.](https://docs.aventail.co.uk/img/guides/context/wizard-deploy.png)
    
2.  **Start serving**
    
    Wait for deployment to complete. Select Serve Model, or turn on the model’s switch under Serving. Use an available port; this walkthrough uses 8100.
    
    The completed deployment dialog is shown here. Wizard deployments also appear in Serving.
    
    [Screenshot: Successful deployment with a serving port field and Serve Model button.](https://docs.aventail.co.uk/img/control/onboarding/deployment-complete.png)
    
3.  **Check the endpoint**
    
    In Serving → API Usage, check the endpoint for your model. On this Mac, use 127.0.0.1 and the serving port.
    
    [Screenshot: API Usage panel showing local endpoint and request information for a served model.](https://docs.aventail.co.uk/img/control/onboarding/local-api.png)
    

In the wizard, select **Continue to deploy → Deploy model**. Wait for **Deployed** in **Notifications → Deployments**, then open **Serving**, expand your device and turn on the model's switch. Enter port **8100**, select **Start Serving** and wait for **serving**.

To deploy from **Models** instead:

1.  Open **Models → Globally Shared** in Control. Find **Gemma 4 (X-Small)**, the GGUF model used for the earlier production Control walkthrough (2.44 GB download).
2.  Select **Deploy**, choose your Mac under **Target Device**, and select **Deploy Model**.
3.  Keep Link running until **Model deployed successfully!** appears.
4.  Keep the displayed port (the tested default was **8100**) and select **Serve Model**. Confirm the model appears under **Serving**.

Deployment downloads and prepares the model. Serving starts it so applications can send requests. The first request may take longer while the model loads.

If the recommended model is unavailable or deployment fails, see [deployment help](https://docs.aventail.co.uk/docs/getting-started/initial-setup#deploy-a-model).

## 4\. Get your first response

Choose either route, or try both:

[**Chat in Workspace**Chat with your model and work with documents.](https://docs.aventail.co.uk/docs/workspace/getting-started)[**Connect your software**Send an API request, then connect an app or integration.](https://docs.aventail.co.uk/docs/getting-started/run-first-interface)

When you finish, stop the model from **Serving** in Control. It stays installed for next time.
