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.1.0.tar.gz (83.2 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.1.0-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for recursivist-1.1.0.tar.gz
Algorithm Hash digest
SHA256 fcd271023555ac4518a03dbf6a06e326c34f7b3ba2cc2245d3ed0b4b9610582f
MD5 f74248c5788cccb0213ba86edb62ca2d
BLAKE2b-256 e65397146593cb1d88ee982bea93ef7cdffa68553cd778361a7f7390348f60f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 30.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99902baa9f9a342bf0cf6d0cbfb66c14b7d635676fcb36b35a0c1d5cc5c31d16
MD5 d4dde4993fd753cca63f9aed83f0386c
BLAKE2b-256 d5a52be493fb2f1156d2c1d9a23b0e30a66b3f43f4e169e19c9a0ec408792b13

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