> For the complete documentation index, see [llms.txt](https://docs.ilert.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ilert.com/developer-docs/client-libraries/ilagent.md).

# ilagent

ilagent is a lightweight program that lets you easily integrate your on-premise systems with ilert.

{% hint style="info" %}
**ilagent or ilert CLI?** Both are command line binaries, but they solve different problems.

* **ilagent** is built to run unattended on your servers. It is a long-running agent that connects your on-premise systems to ilert: forwarding events and heartbeats, buffering them locally when the network is down, consuming MQTT or Kafka messages, and pulling alert actions back into your network. Install it where your monitoring lives and let it run.
* [**ilert CLI**](/developer-docs/client-libraries/ilert-cli.md) is built for a person or an agent at a keyboard. You log in as yourself, and it acts as your individual ilert user with your own permissions — listing and acknowledging *your* alerts, creating incidents, and reaching every API endpoint from a terminal, a CI job, or an AI agent.

If you need something to run permanently next to your infrastructure, use ilagent. If you want to operate ilert from a terminal, use the ilert CLI.
{% endhint %}

ilagent comes as a single binary with a small footprint and is available for all major platforms. We also provide an official Docker image.

## Features

* [Pull and deliver alert action events to local targets](/developer-docs/client-libraries/ilagent/edge-connector.md)
* [Send events and heartbeats from the command line](/developer-docs/client-libraries/ilagent/cli.md)
* [Run a local HTTP proxy server with a retry queue for events and heartbeats](/developer-docs/client-libraries/ilagent/cli.md#http-proxy)
* [Consume and forward MQTT messages to ilert](/developer-docs/client-libraries/ilagent/mqtt.md)
* [Consume and forward Apache Kafka messages to ilert](/developer-docs/client-libraries/ilagent/kafka.md)
* [Map, enrich, and filter consumer messages to ilert events](/developer-docs/client-libraries/ilagent/event-mapping.md)
* [Sync escalation policy levels from external systems](/developer-docs/client-libraries/ilagent/escalation-policies.md)

## Installing

### Docker

```sh
docker run ilert/ilagent --help
```

### Compile from source

> Requires Rust to be installed, see <https://rustup.rs>

```sh
git clone git@github.com:iLert/ilagent.git
cd ilagent
cargo build --release
./target/release/ilagent --help
```

### Install script (macOS / Linux)

```sh
curl -sL https://raw.githubusercontent.com/iLert/ilagent/master/install.sh | bash -
```

Pre-compiled binaries are available on the [releases page](https://github.com/iLert/ilagent/releases).

## Quick reference

* The proxy exposes the same API as `https://api.ilert.com/api` — see the [API docs](https://api.ilert.com/api-docs/#tag/Events)
* In `daemon` mode, provide `-b il1hbt123...` to monitor ilagent's uptime via heartbeats
* Adjust the log level with multiple `-v` flags (default: error, `-v` warn, `-v -v` info)
* ilagent buffers events locally using SQLite3 (except in Kafka mode) and requires file system access in `daemon` mode

## Source code

The ilagent source code is open source and managed on GitHub: <https://github.com/iLert/ilagent>

{% hint style="info" %}
Missing a feature? Let us [know](/knowledge-base/contact.md)
{% endhint %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ilert.com/developer-docs/client-libraries/ilagent.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
