Installing
Installing
What you need
- git, on the
PATH. edhil works in a git repository and uses git for everything that touches history. - A project on a forge, with epics and work items, and an access token that can read and write its issues. On GitLab it is a project and a personal access token with the
apiscope. On Forgejo it is a repository with issue dependencies enabled and an access token for the issues of the repository; see the token. - A coding agent. One of four tools: the GitHub Copilot command line tool (
copilot), Claude Code (claude), the OpenAI Codex command line tool (codex) or opencode (opencode). You need one of them, installed and signed in, and it must run without asking questions when it is started with a prompt. edhil uses Copilot unless you choose another tool; see Choosing an agent. - Verification commands. After the agent has changed the code, edhil runs the commands that the work item names in its Verification steps. Any command works;
integration.verificationin Configuration can restrict them and give them time limits. - Rust, only to build edhil itself.
Building and installing
From a checkout of the edhil repository:
cargo install --path crates/edhil
or, with yet installed:
yet install
Both put an edhil program in your cargo bin directory. Check that it works:
edhil --version
edhil --help
First steps
-
Set the environment variable that holds your token. Its name is up to you, it is the one you write in the configuration:
export GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxxxxxx -
In the repository you want to work on, create
edhil.yamlwith the section of your forge. For a GitLab project the smallest file is:gitlab: url: "https://gitlab.com" token_env: "GITLAB_TOKEN" default_group: "mygroup" default_project: "mygroup/myproject"For a Forgejo repository it is:
forgejo: url: "https://forgejo.example.com" token_env: "FORGEJO_TOKEN" repository: "myowner/myrepo"Use one of the two sections, not both.
-
List what is open:
edhil work-itemsIf this shows your epics and work items, the token, the URL and the project or repository are right.
-
Read about how a run works before the first
edhil implement: it changes files, makes commits and writes a journal in the repository.
What edhil leaves in your repository
edhil creates a directory called .edhil at the top of the repository the first time a command needs it (implement and commit; the commands that only read do not create anything). It adds /.edhil/ to .git/info/exclude, which is local to your clone, so the directory never shows up in git status. edhil does not edit your .gitignore; if you want the directory to be ignored for everybody, add it yourself, and edhil will stop warning about it.