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

# seedex-agent

This page describes how the seedex-agent repository is laid out and how to build and lint it.

## Requirements

* Go 1.22, for the build of the link API.
* shfmt 3.13 and shellcheck 0.11, for the lint.
* A server running Ubuntu 24.04, to install a build.

## Project structure

* `sdx`: The command: dispatch, status, help, and firewall.
* `lib/common.sh`: Shared helpers: firewall, systemd, and logging.
* `lib/vpn.sh`, `lib/proxy.sh`, and `lib/link.sh`: One library per service.
* `link/main.go`: The link API: `GET /v1/configs` and `POST /v1/run`.
* `install.sh`: The script that users run. It downloads the release when it isn't run from a checkout.
* `version`: The version.

## Build

Run the following command:

```sh
make build
```

The command builds `seedex-link` for amd64 and arm64 into `build/`, together with the release tarball and `checksums.txt`.

To install the build on a server, copy `sdx`, `version`, `lib`, `install.sh`, and `build` to the server and run `bash install.sh files` there. The `files` mode updates the scripts and the binary of an existing installation.

## Lint

`make lint` runs shfmt and shellcheck over the shell files, and `gofmt` and `go vet` over the Go code.


---

# 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.seedex.net/developer-guide/seedex-agent.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.