Skip to main content

OpenTUI frontend for agr

Project description

OpenTUI for agr and agrx

An OpenTUI interface for the agr/agrx CLI: view configured skills, trigger agr actions and preview SKILL.md

CI PyPI Python PyPI - Downloads GitHub Release License: MIT


agr-opentui is an OpenTUI front-end for agr/agrx. The default discover source in this repo points to https://github.com/kasperjunge/agent-resources.

Install from PyPI

With uv:

uv tool install agr-opentui

With pip:

python -m pip install agr-opentui

Then run:

agr-opentui

Check installed version:

agr-opentui --version

Usage

Tabs:

  • Skills: shows dependencies from agr.toml and install state.
  • Discover: shows skills embedded in the binary.

Common keys:

  • Tab / Shift+Tab: switch tabs
  • Arrow keys: move selection
  • space: toggle select
  • H: help
  • q: quit

Skills tab keys:

  • a: add skill (handle or owner/repo/path)
  • i: install selected (bulk)
  • r: remove selected (bulk)
  • v: preview SKILL.md
  • g: run with default options (agrx)
  • G: open run options (tool, interactive, prompt, extra args)
  • u: check discover list updates
  • U: apply update (no confirm)
  • s: apply update (confirm)
  • S: apply update + sync (no confirm)
  • c: reload config

Discover tab keys:

  • i: add selected
  • v: preview SKILL.md
  • y: copy handle/repo to clipboard
  • a: add skill
  • c: reload config

Run options keys (when the modal is open):

  • t: cycle tool
  • u: toggle --interactive
  • p: edit --prompt
  • e: edit extra args
  • Enter: run
  • Esc: close

Quick Cheat Sheet

Primary flow:

  • Tab to Skills
  • Arrow keys to select
  • g to run, G for run options

Bulk actions:

  • space to multi-select
  • i install or r remove (Skills tab)

Discover flow:

  • Tab to Discover
  • Arrow keys to select
  • v to preview, i to add, y to copy handle

Requirements

Runtime (using agr-opentui):

  • Python 3.10+
  • uv
  • agr + agrx on your PATH

Build/Development (working on this repo):

  • Bun 1.3.8+
  • Zig (required by OpenTUI build tooling)

Build

bun run build

or

make build

This creates bin/agr-opentui.

Install

bun install

Run

bun run src/main.ts

Run it from the repo you want to manage (the current working directory is the target repo). agr.toml is expected in that target repo for agr add/remove/sync operations.

Run From Target Repo

cd /path/to/your/project
agr-opentui

agr-opentui itself does not need to contain your target repo's agr.toml.

Discover List (Embedded)

The Discover tab is bundled into the compiled binary from this repository's skills.json at build time.

To change the list, update skills.json in this repository and rebuild (make build).

To avoid repeating repo metadata, skills.json can also be a DRY repo-group array like skills-multi-repo-example.json:

  • One array item per repository with this schema: repo, optional branch, handlePrefix, and skills[].
  • Each skills[] item must include id and an explicit relative path ending in /SKILL.md; label is optional.
  • At build time this expands into Discover entries with: handle = handlePrefix + "/" + id, preserved repo, preserved label (defaulting to handle), and explicit skillMdPath metadata for preview resolution.

Example:

[
  {
    "repo": "kasperjunge/agent-resources",
    "branch": "main",
    "handlePrefix": "kasperjunge",
    "skills": [
      {
        "id": "code-review",
        "path": "skills/development/workflow/code-review/SKILL.md",
        "label": "Code Review"
      }
    ]
  }
]

Migration from legacy skills.json:

  • Existing object/array payloads are still supported.
  • To migrate, group skills by repository and replace per-skill repo duplication with one repo-group entry.

Troubleshooting

  • Missing agr.toml: run the app from a repo that has agr.toml, or create one.
  • uv not found: install uv and ensure it’s on PATH.
  • agr/agrx not found: install agr and ensure it’s on PATH.
  • python not found: install Python 3.
  • Discover list out of date: update this repository's skills.json and rebuild the binary.
  • Discover list not updating: check the source URL/repo/branch/path and network access.
  • SKILL.md preview says “not found”: the skill may not ship a SKILL.md or the path is nonstandard.

Notes

  • All actions run through uv (uv run agr, uv run agrx).
  • Bridge loading runs with the launcher Python when available (AGR_OPENTUI_LAUNCHER_PYTHON), with uv run python -m agr_opentui.bridge as fallback.
  • Startup runs a lightweight preflight for uv, agr, and agrx; press d to run full Doctor checks.
  • If agr.toml is missing in the current directory, install/remove/sync commands are blocked and a warning is shown.
  • Logs are written to /tmp/agr-opentui.log.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agr_opentui-0.5.1.tar.gz (40.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agr_opentui-0.5.1-py3-none-any.whl (40.2 MB view details)

Uploaded Python 3

File details

Details for the file agr_opentui-0.5.1.tar.gz.

File metadata

  • Download URL: agr_opentui-0.5.1.tar.gz
  • Upload date:
  • Size: 40.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agr_opentui-0.5.1.tar.gz
Algorithm Hash digest
SHA256 fbcb4016119e02ed9403b8a69bf9bc094252058ed30295bff053dc158db11e81
MD5 2b43004ee338791355b10cf58481eb4f
BLAKE2b-256 04664afca376db43620eb60f3941f5c0e0d09e71b9ec81bee526e6a184e100a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for agr_opentui-0.5.1.tar.gz:

Publisher: publish-pypi.yml on RelativeSure/agr-opentui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file agr_opentui-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: agr_opentui-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 40.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agr_opentui-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 873bae53a66d9fe9d66a45fe499942ee79d1201e2c6179fbb873cff28ce72a03
MD5 6355c7260fefedafe683d0d3d6b921a7
BLAKE2b-256 9d646be261ae6a6cec6d2d1323fce3078e7afea2dfd9b747c8fae9322a0b8085

See more details on using hashes here.

Provenance

The following attestation bundles were made for agr_opentui-0.5.1-py3-none-any.whl:

Publisher: publish-pypi.yml on RelativeSure/agr-opentui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page