Skip to main content

TUI File Browser App

Project description

a pleasant file explorer in your terminal supporting all filesystems

PyPI PyPI - Python Version GitHub License Testing Status task uv pre-commit docs semantic-release Gitmoji

browsr 🗂️ is a pleasant file explorer in your terminal. It's a command line TUI (text-based user interface) application that empowers you to browse the contents of local and remote filesystems with your keyboard or mouse.

You can quickly navigate through directories and peek at files whether they're hosted locally, in GitHub, over SSH, in AWS S3, Google Cloud Storage, or Azure Blob Storage. View code files with syntax highlighting, format JSON files, render images, convert data files to navigable datatables, and more.

Screenshots
Image 2 Image 3 Image 4
Screen Recording

https://user-images.githubusercontent.com/49741340/238535232-459847af-a15c-4d9b-91ac-fab9958bc74f.mp4

Installation

It's recommended to use pipx instead of pip. pipx installs the package in an isolated environment and makes it available everywhere. If you'd like to use pip instead, just replace pipx with pip in the below command.

pipx install browsr

Extra Installation

If you're looking to use browsr on remote file systems, like GitHub or AWS S3, you'll need to install the remote extra. If you'd like to browse parquet / feather files, you'll need to install the data extra. Or, even simpler, you can install the all extra to get all the extras.

pipx install "browsr[all]"

Usage

Simply give browsr a path to a local or remote file / directory. Check out the Documentation for more information about the file systems supported.

Local

browsr ~/Downloads/

GitHub

browsr github://juftin:browsr
export GITHUB_TOKEN="ghp_1234567890"
browsr github://juftin:browsr-private@main

Cloud

browsr s3://my-bucket

** Currently AWS S3, Google Cloud Storage, and Azure Blob Storage / Data Lake are supported.

SSH / SFTP

browsr ssh://username@example.com:22

License

browsr is distributed under the terms of the MIT license.

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

browsr-1.22.1.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

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

browsr-1.22.1-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file browsr-1.22.1.tar.gz.

File metadata

  • Download URL: browsr-1.22.1.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for browsr-1.22.1.tar.gz
Algorithm Hash digest
SHA256 64da1ccc9c7d4a14adc2cd907c61bdd42de981888a9f8210079a095d4060e73a
MD5 436d6a6e090f74108dd6dd2de13b4ce0
BLAKE2b-256 ed135b8316216fe2331f687e10e6a6006807fb772b9007262aa800786c2d7f4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for browsr-1.22.1.tar.gz:

Publisher: publish.yaml on juftin/browsr

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

File details

Details for the file browsr-1.22.1-py3-none-any.whl.

File metadata

  • Download URL: browsr-1.22.1-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for browsr-1.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e6c6639d1f2bec389892bac8955980a29fe9e32807708ef69724b94be9f3a88d
MD5 877b5b92927d534f05372481c161cc72
BLAKE2b-256 fe1ac0a4cbfb05c126b8566549da907fd3c654bd0a76871464c7570f2311b3fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for browsr-1.22.1-py3-none-any.whl:

Publisher: publish.yaml on juftin/browsr

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