Skip to content

Installation

Requirements

  • Python 3.12 or newer
  • A Codeberg account
  • A Codeberg API token (required for live data; see below)

Install yilan

Clone the repository and install with uv:

git clone https://codeberg.org/marvin8/yilan
cd yilan
uv sync

Or install directly from the repository:

uv tool install git+https://codeberg.org/marvin8/yilan

Codeberg API token

Yilan fetches commit history and open issues via the Codeberg API. Without a token the board still renders but API fields show (unavailable — no token).

  1. Go to Settings → Applications → Access Tokens on Codeberg.
  2. Create a token with at minimum the issue and repository read scopes.
  3. Export it in your shell profile:
export CODEBERG_TOKEN=your_token_here

Or pass it inline for a one-off run:

CODEBERG_TOKEN=... yilan

Verify the install

yilan --version