Skip to main content

ctxflow to keep you developing with ease

Project description

a pleasant file explorer in your terminal supporting all filesystems

PyPI PyPI - Python Version GitHub License docs Testing Status Hatch project Ruff pre-commit 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

ctxflow-0.0.1.tar.gz (9.6 MB view details)

Uploaded Source

Built Distribution

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

ctxflow-0.0.1-py3-none-any.whl (56.0 kB view details)

Uploaded Python 3

File details

Details for the file ctxflow-0.0.1.tar.gz.

File metadata

  • Download URL: ctxflow-0.0.1.tar.gz
  • Upload date:
  • Size: 9.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ctxflow-0.0.1.tar.gz
Algorithm Hash digest
SHA256 443dad96bf40fdb510c31f6ba8c187b5316cd49976325c3e7af839bc52a11acc
MD5 61d4e1020e439e16e790c4f11105936d
BLAKE2b-256 57e6fb50d89b436ba0bac82e82ef9c3ef3f2315006c4877710669b23748ba4a5

See more details on using hashes here.

File details

Details for the file ctxflow-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: ctxflow-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 56.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for ctxflow-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c98355bfe5b3a8a21c422f62c04adf704836bfc43fd2d25d0dd5dd70efc9d4
MD5 df5e29ec1f7b664c01eb767a569b0dba
BLAKE2b-256 7df37a38be6b1a7faea1363f524fdeb4952b520880a7f9f03de3ca1bbc1f24e4

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