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.3.1.tar.gz (98.5 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.3.1-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for recursivist-1.3.1.tar.gz
Algorithm Hash digest
SHA256 9cf33d9fec32e6d571cc654d54ccf007bc7df5f0a9ebe26b8033788fee83fe65
MD5 bc62833369a0bf11ec519f6f9ac229cb
BLAKE2b-256 2776ac43b4f29a512f94065811697853355e62e3b9fd190744d6fe3d1b8da3a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 40.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.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f71ddcc1fd283b8d7eb24262fb32ca5b89506b5ac6bce3a4479f5d600e40440c
MD5 3f1f5ebcbad0f50b8fcd4b942603c1ad
BLAKE2b-256 e031455119261c611acdf2f49c9850ae672c8062831315e4abdee2f82c4e2077

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