Skip to main content

A interactive terminal directory navigator for Windows.

Project description

📂 terminaltreeview

PyPI version Python Version License: MIT

terminaltreeview is a sleek, interactive terminal directory navigator designed specifically for Windows. It brings a modern, tree-like navigation experience directly to your command line, allowing you to jump between folders with fluid keyboard shortcuts.


Features

  • Visual Tree View: Navigate your folders with a clean, indented structure.
  • Lightning Fast: Optimized for speed and low latency.
  • Intuitive Shortcuts:
    • ↑ / ↓: Navigate through files and folders.
    • Enter / →: Expand/Collapse directories.
    • : Go to the parent directory (smart jumping).
    • Ctrl + Enter: Exit and open the terminal in the parent directory.
    • Shift + Enter: Go Inside! Exit and teleport your terminal into the selected directory.
    • Ctrl + O: Open file! Use start command to open file.
    • Ctrl + N: New folder! Create and name a folder inside the selected directory.
    • Type letters: Filter Filter all folders and files on the view.
  • Rich Styling: Beautiful colors and icons powered by the rich library.

One-Minute Setup

Getting the full experience ready is extremely simple:

1. Install via pip

pip install terminaltreeview

2. Enable Shell Integration (Magic CD)

To allow terminaltreeview to change your terminal's directory (the "Teleport" feature), run this setup command once:

ttv-setup

[!TIP] This command automatically configures every shell it detects — PowerShell 7 (pwsh), Windows PowerShell 5.1, and CMD (via a ttv.bat shim on your PATH). After running it, simply restart your terminal or run . $PROFILE.

What ttv-setup does — nothing hidden:

  • Appends a clearly marked, human-readable block (# >>> terminaltreeview >>># <<< terminaltreeview <<<) containing the plain ttv function to your PowerShell profiles. It is static code you can open and read — no Invoke-Expression, no downloads, no dynamic execution.
  • Creates a small ttv.bat shim in Python's Scripts folder for CMD support.
  • Running it again is safe: the block is replaced in place, never duplicated. It also migrates profiles configured by older versions.

To completely undo the integration at any time:

ttv-setup --uninstall

3. Start Navigating

Now just type ttv from anywhere:

ttv

Key Mappings

Key Action
/ Move selection
Enter / Expand folder
Collapse folder or jump to Parent
Ctrl + Enter Open shell at current selection level
Shift + Enter Open shell inside selected folder
Ctrl + O Open the selected item
Ctrl + N Create a new folder in the selected directory
Q / Ctrl + C Quit

Requirements

  • OS: Windows (Uses Win32 API for cursor and key handling).
  • Python: 3.8 or higher.

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to make terminaltreeview even better.

Made with ❤️ by FlipNeves

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

terminaltreeview-0.3.0.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

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

terminaltreeview-0.3.0-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file terminaltreeview-0.3.0.tar.gz.

File metadata

  • Download URL: terminaltreeview-0.3.0.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for terminaltreeview-0.3.0.tar.gz
Algorithm Hash digest
SHA256 04fd90604670848575c55677e7bd3b5749331bfab8ab99730bec721b8e91b344
MD5 15c932566fd994d0953ae0ab5a5e7c48
BLAKE2b-256 eb1fc4a94c572653f3611127f902c6ab4d1638889a58d520f68c3877b1c46034

See more details on using hashes here.

File details

Details for the file terminaltreeview-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for terminaltreeview-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d90c683a15535061cae622fb1378ae866581ff35aeb324af6429aa73f4368a97
MD5 3c74a430da68a4a5c55da4e293a6eb33
BLAKE2b-256 b7d884b8810e41b0c7e277b838148af2352e758e1b156fdb5290d2f028e81585

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