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.2.tar.gz (117.9 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.2-py3-none-any.whl (40.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: recursivist-1.4.2.tar.gz
  • Upload date:
  • Size: 117.9 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.2.tar.gz
Algorithm Hash digest
SHA256 14a368d95ed68a79139730052b9c7396a383484e26b00142540734299cca9f5c
MD5 4474b49522077a493650ee48203d59ca
BLAKE2b-256 9a3e23ee80aa43bfc3c54ac196fa886b03929957f4dc209ebb8ea850a57e0c91

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.4.2-py3-none-any.whl
  • Upload date:
  • Size: 40.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b9e9dace84be0bd4f9666d71e94d15c0c33f92c0ad369180e7719a4ee047bb03
MD5 4cc073a076befad21ed45b0a8467ecf9
BLAKE2b-256 843eb56a6d160b3e9097d1249ab09edc51ee03b91c47b640414d55e6f9159c86

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