Skip to main content

Deploy the binary

Deploy agentgateway as a standalone binary on your system.

To run agentgateway as a standalone binary, follow the steps to download, install, and configure the binary on your local machine or server.

Install the binary​

Download and install​

Download and install the agentgateway binary. Alternatively, you can manually download the binary from the agentgateway releases page.

To install the latest release:

curl -sL https://agentgateway.dev/install | bash

To install a specific version, pass the --version flag. Use any release tag from the agentgateway releases page, 1.4.1. The version must start with v (the script adds it if you omit it).

curl -sL https://agentgateway.dev/install | bash -s -- --version 1.4.1

To install the nightly build for development and testing:

  1. Go to the nightly release in GitHub Actions and click the release that you want to use.

  2. From the URL, get the release number, such as 24873456345 in https://github.com/agentgateway/agentgateway/actions/runs/24873456345.

  3. Using the gh CLI, download the release for your OS. The following example uses macOS.

    gh run download 24873456345 -R agentgateway/agentgateway -n release-binary-mac

  4. Make the binary file executable and move it to your binary location, such as in the following example.

    chmod +x agentgateway
    sudo mv agentgateway /usr/local/bin/agentgateway

  5. Verify that you have the nightly release.

    agentgateway --version

    Example output:

    {
      "version": "0.0.0-alpha.813d7d0",
      "git_revision": "813d7d0ab4757db7c8ed5a639bc63c0bb20ac116",
      "rust_version": "1.95.0",
      "build_profile": "release",
      "build_target": "aarch64-apple-darwin"
    }

Example output:

  % Total    % Received % Xferd  Average Speed   Time    Time     Time     Current
                                 Dload  Upload   Total   Spent   Left    Speed
100  8878  100  8878    0     0  68998      0 --:--:-- --:--:-- --:--:-- 69359

Downloading https://github.com/agentgateway/agentgateway/releases/download/v0.4.16/agentgateway-darwin-arm64
Verifying checksum... Done.
Preparing to install agentgateway into /usr/local/bin
Password:
agentgateway installed into /usr/local/bin/agentgateway

Verify the installation​

Verify that the agentgateway binary is installed.

agentgateway --version

Example output with the latest version, 1.4.1:

{
  "version": "1.4.1",
  "git_revision": "90f7b25855fb5f5fbefcc16855206040cba9b77d",
  "rust_version": "1.89.0",
  "build_profile": "release",
  "build_target": "x86_64-unknown-linux-musl"
}

Run agentgateway​

To run agentgateway, the binary can simply be executed. Configuration will be stored in ~/.config/agentgateway

agentgateway

To specify an explicit configuration file, use -f:

agentgateway -f config.yaml

You might start with this simple example configuration file.

Open http://localhost:15000/ui to get started!