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

Uploaded Python 3

File details

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

File metadata

  • Download URL: recursivist-1.4.5.tar.gz
  • Upload date:
  • Size: 325.9 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.5.tar.gz
Algorithm Hash digest
SHA256 71e5a1051e05ad5f88addbe65a99fe9c94dfc17d0b373fe81565ced7cad202d8
MD5 f3a4ca9e4dba763bc47b351f5b223002
BLAKE2b-256 08e0384b04a68021911002fe394eb6bcce02d2784e6679b7f7b45e5bcb1f42e1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.4.5-py3-none-any.whl
  • Upload date:
  • Size: 40.5 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7a9fba62b4074a6a2173894b60b9961b51a78ade28251ebd37559dc83667c9b0
MD5 d6c104deb8d8740a8c6642e5d605a3a5
BLAKE2b-256 aa81eaae75e53c35085b32efd05ea7beaa30d13a09dcbb08fb231c16b21aed34

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