Skip to content
Reviactyl v26 has been released!
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Building Agent

Steps to Build Reviactyl Agent (GO)

Agent is written in Go. This makes it very easy to modify and compile it on your own, and distribute your own binaries. This guide will cover the steps necessary to build it yourself.

It will not, however, explain where to look for certain aspects of Agent and which changes are necessary to achieve specific results. Knowledge of the Go language is required if you want to modify it.

Building Go programs is very easy, and the same also applies to Agent. Go is cross-platform, but Agent only supports Linux at the moment. The easiest way to compile it for Linux is to run the commands on a Linux machine.

Build Requirements

An up to date version of Go is required to compile Agent. The minimum version can be found at the top of the go.mod file. See the official instructions for help with installing Go.

Building

Execute the following command in your local clone of the repository to compile Agent into a binary.

go build

Install the new binary

Root Required Some the following commands require root permissions. Prepend them with sudo if you are not logged in as root.

1

Backup the current installation of wings

mv /usr/local/bin/agent /usr/local/bin/wings-agent
2

Place the new binary in /usr/local/bin

cp ./agent /usr/local/agent
3

Restart Agent

systemctl restart agent

Troubleshooting

If the wings service does not start properly, you can try to start Wings in a console window.

agent --debug

Remember to stop the system service before, and re-enable it afterwards.

Last updated

Was this helpful?