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

Uploaded Python 3

File details

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

File metadata

  • Download URL: recursivist-1.4.4.tar.gz
  • Upload date:
  • Size: 324.0 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.4.tar.gz
Algorithm Hash digest
SHA256 24083b333d4bac140fd313721da46028f5818e76584aad0ca1a1ae34a440a387
MD5 47d83715a7d82b942c2c4947f966cbf7
BLAKE2b-256 da6678fd30a05732724de37f86245347032417646203afb6e242340b5ba5f726

See more details on using hashes here.

File details

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

File metadata

  • Download URL: recursivist-1.4.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 428d0cc6d67f183845c10013726c8e228a9d963a897991abb042e06c8231b088
MD5 2c478a1ecc24cc92c9104e5ed2634e4e
BLAKE2b-256 309fc2b41c3cc1b11ac04ee3d4b67b728cae4d247c638c53d3141db930c7c49e

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