Skip to main content

A post-modern terminal file explorer

Project description

rovr

Static Badge Static Badge Static Badge

[!caution] This project is in its very early stages. Feedback is appreciated, but this cannot be daily-driven yet.

What and Why?

  • What:
    • It is a file manager made using the Textual framework.
  • Why:
    • Because I can :3
    • I'm using this as a learning opportunity to learn more about Textual, and designing a neat little app for myself.

Installation

# Test the main branch
uvx --from git+https://github.com/NSPC911/rovr.git -q rovr --python 3.13
# Install
## uv (my fav)
uv tool install rovr
## or pipx
pipx install rovr
## or plain old pip
pip install rovr

Screenshots

Startup Version 0.0.0.4

Create new Item Version 0.0.0.4

Delete selected items Version 0.0.0.4

Zoxide integration Version 0.0.0.4

FAQ

  1. There isn't X theme/Why isn't Y theme available?
[[custom_theme]]
name = "<str>"
primary = "<hex>"
secondary = "<hex>"
success = "<hex>"
warning = "<hex>"
error = "<hex>"
accent = "<hex>"
foreground = "<hex>"
background = "<hex>"
surface = "<hex>"
panel = "<hex>"
is_dark = "<bool>"
variables = {
  "<key>" = "<value>"
}
  1. Why is it considered post-modern?
  • Parody to my current editor, helix
    • If NeoVim is considered modern, then Helix is post-modern
    • If superfile is considered modern, then rovr is post-modern
  1. Why did you say it cannot be daily driven?
  • Refer to the road map. There is many features yet to be completed. Pull Requests are appreciated
  1. What can I contribute?
  • Themes, and features can be contributed.
  • Refactors will be frowned on, and may take a longer time before merging.
  1. I want to add a feature/theme/etc! How do I do so?
  • You need uv at minimum. pre-commit and ruff are recommended to be installed.
  • Clone the repo, and inside it, run uv sync and pre-commit install.
  • Make your changes, ensure that your changes are properly formatted (via the pre-commit hook), before pushing to a custom branch on your fork.
  1. How do I make a feature suggestion?
  • Open an issue using the feature-request tag. Issue templates will come soon.
  1. Why not ratatui or bubbletea??? angry noises
  • I like python.
  1. When will it be completed?
  • When it is completed.

Road map

This is a list of features that I plan to add before releasing the appropriate version and where they are inspired from.

Version 1

Status: 26/29

  • Directory Auto-completion (explorer)
  • Button Navigation (explorer)
  • Keyboard Navigation
    • Directory Navigation (explorer)
    • Others (superfile)
  • Double Click to enter into directories (explorer)
  • Configuration (superfile)
    • Base
    • Schema
    • Extending custom themes via configuration
  • zoxide support (ranger)
    There is no command line for rovr, which means it will use keybinds to launch either a modified current folder bar or a panel
  • Previewing files
    • Image files using textual-image (superfile)
      Explorer kinda supports image viewing, but this is a TUI, so inspiration is from superfile
    • Directories (superfile)
    • Compressed Files
  • Pinned folder sidebar (superfile)
    Explorer also supports a pinned sidebar, but it also includes the massive file tree, which I won't add.
  • Search Bar (superfile)
  • Metadata
  • Clipboard (superfile)
    • Copy files and folders
    • Cut files and folders
    • Paste files and folders
      • Warn when overwriting same named files
  • Multiple File Lists
    • Tabs
  • Active and Completed processes (superfile)
  • Actions bar (explorer)
    • Change sort order of files
    • Copy files
    • Cut files
    • Paste files
    • Create new files/folders
    • Delete files/folders
    • Rename a file/folder
  • bat as previewer

Version 2

  • Plugins using pytest-dev/pluggy or a custom way (I wish not)
  • Cross process clipboard sync (two rovr instances should have synced clipboards)
  • Recycle Bin of 1-day when files get overwritten (Currently handled with sendtotrash but it doesn't work at times, so not a reliable solution)

Declined Features

  • Horizontal and Vertical Splits
  • Transparent UI

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

rovr-0.0.4.tar.gz (531.1 kB view details)

Uploaded Source

Built Distribution

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

rovr-0.0.4-py3-none-any.whl (51.3 kB view details)

Uploaded Python 3

File details

Details for the file rovr-0.0.4.tar.gz.

File metadata

  • Download URL: rovr-0.0.4.tar.gz
  • Upload date:
  • Size: 531.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.9

File hashes

Hashes for rovr-0.0.4.tar.gz
Algorithm Hash digest
SHA256 69f71ebd7285dfc680c1e3eb250a850713ae73271ba791c8eee00a1b69e779d4
MD5 1455dd034091fe1d09c4612e8d701570
BLAKE2b-256 1fc9cee51839ac3d4e9bc27d775624dbe3bb588b27aaee553979754a880033a5

See more details on using hashes here.

File details

Details for the file rovr-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: rovr-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 51.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.9

File hashes

Hashes for rovr-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 19c60e0abf0c2e67ee6874bbcd5248f0e3cb6692012e8027e107d3e3f79c537f
MD5 e4ac5c6ab4fbbd8fa73f81c9ba128d8a
BLAKE2b-256 18c75b32f6baa4432d05dc556d3b7a856cea336514df0e7f8c3ca28aeba338d7

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