yilan

Repo Docs CI

Codestyle

AGPL

yilan is a command-line tool that fetches data from Codeberg via the Forgejo API and renders a unified markdown project status board (BOARD.md). It replaces a 600-line PEP 723 single-file script with a proper installable CLI package. It is a personal tool — no multi-forge support, no PyPI release.

Install and run from Source

Clone the repository:

git clone https://codeberg.org/marvin8/yilan.git

yilan uses uv for dependency management; please install uv before proceeding.

Install all required Python modules:

uv sync

Set your Codeberg API token (read-only scope is sufficient):

export CODEBERG_TOKEN=<your-token>

Run a dry-run to verify output without writing any file:

uv run yilan --dry-run

To write BOARD.md in the current directory:

uv run yilan

Configuration lives at ~/.config/yilan/config.toml — define owners, monorepos, intent files, and concepts there.

Significance of the name yilan

Yilan (一览, yīlǎn) is a classical Chinese word meaning "to take in everything at a single glance" — as in 一览无余 (yīlǎn wúyú, "nothing escapes the eye"). The tool's job is exactly that: pull every active repository into one board so nothing slips out of sight.

Licensing

yilan is licensed under the GNU Affero General Public License v3.0 or later.