Metadata-Version: 2.4
Name: tofuref
Version: 1.1.0
Summary: TUI for OpenTofu provider registry.
Project-URL: Homepage, https://github.com/DJetelina/tofuref
Project-URL: Repository, https://github.com/DJetelina/tofuref.git
Project-URL: Issues, https://github.com/DJetelina/tofuref/issues
Author: David Jetelina
License-Expression: MIT
License-File: LICENSE
Keywords: infra,opentofu,platform,sre,terraform,tofu,tool,tui
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: httpx>=0.28.1
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: textual>=3.1.1
Requires-Dist: xdg-base-dirs>=6.0.2
Description-Content-Type: text/markdown

# tofuref

[![PyPI - Version](https://img.shields.io/pypi/v/tofuref)](https://pypi.org/project/tofuref/)
![PyPI - License](https://img.shields.io/pypi/l/tofuref)
![PyPI - Downloads](https://img.shields.io/pypi/dm/tofuref)
![GitHub Repo stars](https://img.shields.io/github/stars/DJetelina/tofuref?style=flat&logo=github)

TUI for OpenTofu provider registry.

![Screenshot](https://github.com/djetelina/tofuref/blob/main/screenshots/welcome.svg?raw=true)

## Installation

```bash
pipx install tofuref
```

## Usage

Run the application:

```bash
tofuref
```

### Controls

#### Actions

| keybindings   | action                                               |
|---------------|------------------------------------------------------|
| `s`, `/`      | **search** in the context of providers and resources |
| `u`, `y`      | Context aware copying (using a provider/resource)    |
| `v`           | change active provider **version**                   |
| `q`, `ctrl+q` | **quit** tofuref                                     |
| `t`           | toggle **table of contents** from content window     |
| `ctrl+l`      | display **log** window                               |

#### Focus windows

| keybindings | action                     |
|-------------|----------------------------|
| `tab`       | focus next window          |
| `shift+tab` | focus previous window      |
| `p`         | focus **providers** window |
| `r`         | focus **resources** window |
| `c`         | focus **content** window   |
| `f`         | toggle **fullscreen** mode |

### Navigate in a window

Navigate with arrows/page up/page down/home/end or your mouse.

VIM keybindings should be also supported in a limited capacity.

## Upgrade

```bash
pipx upgrade tofuref
```
