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.0.tar.gz (115.1 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.0-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: recursivist-1.4.0.tar.gz
  • Upload date:
  • Size: 115.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for recursivist-1.4.0.tar.gz
Algorithm Hash digest
SHA256 a5079613a3e4ed2d969c4d357d8485f4b876097853c17fcdf136f04c10285636
MD5 7f6097197f62b7209957f64d47d2d299
BLAKE2b-256 b18eaca0d5985a5e487b69890c5a81d8d096392039eaf8716df79733bb9a8a66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 40.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for recursivist-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5afec266ff4c584daad99270df5bb012e95c4f0b9826b3dd310b48a05271467
MD5 665ce432e91c9746f1170696976b95e2
BLAKE2b-256 080f1a63dee0baf80ef785b4bc667047a839ce5d6a87ae69cf04a91fb648adc1

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