Skip to content
redi

Getting Started

redi is a TUI/CLI tool for Redmine. It wraps the REST API and offers a TUI for people working at a terminal, and a CLI that people and programs (agents, scripts) can both run.

redi TUI

Install

Section titled “Install”

The name on PyPI is redtile, not redi. Installing with uv is what I recommend.

Terminal window
uv tool install redtile

Check that it is there:

Terminal window
redi --version

Initial setup

Section titled “Initial setup”
Terminal window
redi init

redi init

It asks for the language (en / ja), then the Redmine URL and API key. The key is not echoed. It then checks that the connection works, lists the projects it found so you can pick the default one, and writes a profile to ~/.config/redi/config.toml.

The API key is under My account → API access key in Redmine. If it is not there, an administrator has to enable the REST API under Administration → Settings → API.

Environment variables work as an alternative to a profile — see Configuration.

Open the TUI

Section titled “Open the TUI”
Terminal window
redi --tui

j / k to move, Enter to open, ? for help, q to quit. See TUI for details.

Or stay on the command line

Section titled “Or stay on the command line”
Terminal window
redi issue            # list issues of the default project
redi issue view 160   # one issue

redi issue is shorthand for redi issue list — see Command Structure for the rule behind it.

Where to go next

Section titled “Where to go next”