Skip to main content

Add your description here

Project description

tofuref

A terminal application to browse OpenTofu provider documentation from the terminal.

Screenshot

Installation

pipx install tofuref

Usage

Run the application:

tofuref

Development

Provider Data Fetching

tofuref uses git cloning to fetch provider data from the OpenTofu registry and provider repositories:

  1. Provider List: On startup, tofuref fetches the list of available providers from the OpenTofu Registry.

  2. Provider Documentation: When a provider is selected in the UI, tofuref fetches documentation from the provider's GitHub repository. This is done lazily (on-demand).

  3. Persistent Storage: The application stores cloned repositories in the user's application data directory to avoid re-cloning repositories on every startup.

License

MIT

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

tofuref-0.1.0.tar.gz (377.9 kB view details)

Uploaded Source

Built Distribution

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

tofuref-0.1.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file tofuref-0.1.0.tar.gz.

File metadata

  • Download URL: tofuref-0.1.0.tar.gz
  • Upload date:
  • Size: 377.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.0

File hashes

Hashes for tofuref-0.1.0.tar.gz
Algorithm Hash digest
SHA256 08e15e1a85a6722e826d341025d04855e25bcd70ac9dc1ad827bb51be2d5132b
MD5 f5892894680fb3ac9fe082b343e03bbc
BLAKE2b-256 b68462e8ef1f4d6dbe6f3a992ad29cac7b3800e0aef3a6ada2b6fad63bcf64c6

See more details on using hashes here.

File details

Details for the file tofuref-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tofuref-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.0

File hashes

Hashes for tofuref-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80ff0b42fbb1c295448ba7fa3e9aaa6a5f36f12067cd77b34946e7a17fea69dd
MD5 282960306b94424360e08d56a1d8fd94
BLAKE2b-256 006bbd5c47849c31d939f861b94a5c925662801adae7d9c2b8a246d42a827637

See more details on using hashes here.

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