fsvz - Directory Structure CLI Tool

fsvz is a lightweight, dependency-free command-line tool built with Node.js for generating and displaying directory structures. It's designed to be simple and easy to use.

TODOs

• add screenshot or a gif of it working in the README

Features

• No External Dependencies: Built purely with Node.js built-in modules.
• Customizable Output: Choose between simple and fancy tree-like console outputs, or export to JSON or CSV.
• Pattern Ignoring: Ability to ignore files and directories based on a provided glob pattern.

Installation

You can install fsvz globally using npm by running the following command:

npm install -g fsvz

This allows you to use the fsvz command from anywhere on your system.

Usage

After installation, you can use the fsvz command in your terminal. Here are some ways to use this tool:

Basic Usage

To display the directory structure of the current directory, simply type:

fsvz

NOTE: For deeply nested hierarchies, it will take a while to display the entire structure. Although I've tested it with a few thousand files and directories, I have not tested it with extremely large directories. If you run into any issues, please let me know by opening an issue.

Fancy and Simple Outputs to the CLI

For an output that uses dashes instead of an ASCII tree-like structure, use the --simple or -s option:

fsvz --simple

Output to JSON or CSV, or to a File in "raw" format

To output the directory structure as JSON or CSV, use the --json or --csv options:

fsvz --json mytree.json # outputs the tree structure to a JSON file. You can also use the -j shorthand.
fsvz --csv mytree.csv # file extension is optional and automatically added if not provided

To output the raw tree structure to a file, use the --raw option:

fszv --raw mytree.txt # outputs the raw tree structure to a file, just as it would be displayed in the terminal

Ignoring Patterns

To ignore files or directories that match glob patterns, use the --ignore or -i options. For example, to ignore all node_modules directories, you can run:

fsvz --ignore="node_modules"

Or to ignore all files with the .js extension, you can run:

fsvz -i "*.js"

Or to ignore multiple patterns, you can separate them with commas or standard glob pattern syntax:

fsvz --ignore="node_modules,*.js"
fsvz -i "{node_modules|*.js}"

Help

For more information on all available options, use the help command:

fsvz --help

Example Output

Here is an example of what the default output might look like:

fsvz-project
├── node_modules
│   └── (contents ignored)
├── src
│   ├── index.js
│   └── utils.js
├── package.json
└── README.md

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have feedback, requests, or bugs to report.

License

fsvz is MIT licensed.