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, React components, and SVG images

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-2.1.0.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

recursivist-2.1.0-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: recursivist-2.1.0.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for recursivist-2.1.0.tar.gz
Algorithm Hash digest
SHA256 c8d15ef696ac102ccd28d8ee188a867cdb715407fd473e2dfc5ea9ce08395627
MD5 bed28595eb9488030004a606c7573972
BLAKE2b-256 e1b3c75770351be1a8cdc2e37eba3dbc448c2f3647ecb152e3e8ce6480d3f3e9

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for recursivist-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 878197c35af4a7fdc98aaa82e56cc36580fa297e3375c59373b6a65a8e70f44d
MD5 59abb6052b6272255c51e167ef33340e
BLAKE2b-256 bb9fc93e8a3ba7c739d4321956d0aebf027e8017b803e938ba7383d599a361a7

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