Skip to main content

A command-line tool for visualizing directory structures

Project description

Recursivist

A beautiful command-line tool for visualizing directory structures with rich formatting, color-coding, and multiple export options.

Key Features

  • 🎨 Colorful Visualization: Each file type is assigned a unique color for easy identification
  • 🌳 Tree Structure: Displays your directories in an intuitive, hierarchical tree format
  • 📁 Smart Filtering: Easily exclude directories and file extensions you don't want to see
  • 🧩 Gitignore Support: Automatically respects your .gitignore patterns
  • 🔄 Directory Comparison: Compare two directory structures side by side with highlighted differences
  • 📊 Multiple Export Formats: Export to TXT, JSON, HTML, Markdown, and React components

Installation

pip install recursivist

Quick Start

Just run the command in any directory to see a beautifully formatted directory tree:

recursivist visualize

For a specific directory:

recursivist visualize /path/to/directory

To exclude common directories:

recursivist visualize \
--exclude "node_modules .git"

To export the structure to markdown:

recursivist export \
--format md

To compare two directories:

recursivist compare dir1 dir2

Documentation

For comprehensive documentation, including detailed usage instructions, examples, and API reference, click here.

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

recursivist-1.4.7.tar.gz (326.3 kB view details)

Uploaded Source

Built Distribution

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

recursivist-1.4.7-py3-none-any.whl (40.7 kB view details)

Uploaded Python 3

File details

Details for the file recursivist-1.4.7.tar.gz.

File metadata

  • Download URL: recursivist-1.4.7.tar.gz
  • Upload date:
  • Size: 326.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for recursivist-1.4.7.tar.gz
Algorithm Hash digest
SHA256 555c441e272ce52eca4402efab17ad7f31ca0b8efd84fa37072cf6347649ff23
MD5 61fd8124912c1003ee9b36cb053bbf6e
BLAKE2b-256 272493e042835a97ebfab44c6ce69cf54bc2ed17d3c3607c27ef1db1df57903e

See more details on using hashes here.

File details

Details for the file recursivist-1.4.7-py3-none-any.whl.

File metadata

  • Download URL: recursivist-1.4.7-py3-none-any.whl
  • Upload date:
  • Size: 40.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for recursivist-1.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 461b0b198d0843b69da102628c635efd2286b62c862833ddad063e16e618e5ba
MD5 2e3a7a7d602768cca2455c11d9e5da57
BLAKE2b-256 25bc7c68fa23b676b820a3790e64c5fc8845c519b9423daae163d2ea6dd6a2a1

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