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.2.0.tar.gz (972.3 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.2.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tofuref-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8cc7a9ecef1ee23fe4b1971eb5ca43e6cf7933c5cc82fe9f72ffa792e254a86a
MD5 50998e9ec064a49ce665aba811b68c17
BLAKE2b-256 07dbc1ce977ec611fed4c8c0bcc88f659bab6617268c0341a4b58363241398f7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tofuref-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bee2a7839164b14ac9e8d451669bc2fdc4dc12a07f2a5d613bd8188cf1769f4c
MD5 6978b6db196ac3ecfa50e39ec196bbad
BLAKE2b-256 5c307a92995a02de30f56c8acc4ca2797ee468b675c7c6fe14a864067a99b7cb

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