Structify Project

A command-line tool to visualize and export project structures in multiple formats (Tree, JSON, Markdown, YAML).

With Structify Project, you can quickly generate an overview of your project's file and folder hierarchy, making it easier to document, share, and analyze codebases.

Table of Contents

• Install
• Usage
• Options
• Troubleshoot

Install

# Install globally via NPM
npm install -g structify-project

Usage

# Run structify-project inside any project directory:
structify-project ./ output

'./' is the path to the project folder from where you want to get the structure 'output' can be any name with which you want to save the file

Options with Interactive Mode

Once you run above command, You will be prompted to select output format and how to handle node_modules.

Step 1: Choose Output Format You will see a menu like this:

? Choose output format: (Use arrow keys)
❯ tree
  json
  markdown
  yaml

Structify Project supports multiple output formats. You can choose the one that best fits your use case.

| Format | Description | |------------|-----------------------------------------------------------------------------| | tree | Default tree-like text visualization of the project structure. | | json | Outputs a JSON representation — great for programmatic usage and parsing. | | markdown | Outputs a Markdown file — perfect for documentation and GitHub READMEs. | | yaml | Outputs in YAML format — useful for configuration pipelines and tooling. |

✨ By default, Structify Project uses the tree format if no option is specified.

Step 2: Choose Node Modules Handling Next, you will be asked how to include node_modules:

? How should node_modules be handled?
❯ Skip
  Name only
  Full

Node Modules Handling

Structify Project gives you full control over how node_modules is included in the generated project structure.
This is useful because node_modules can be extremely large and often unnecessary in documentation.

| Option | Description | |--------------|-----------------------------------------------------------------------------| | Skip | Excludes node_modules entirely (default). | | Name only | Shows just the node_modules/ folder name, without its contents. | | Full | Includes the entire node_modules tree (⚠️ can be very large & heavy). |

✨ Use Skip for cleaner outputs, Name only for awareness and Full only if you absolutely need the dependency tree.

✨ With these two prompts, Structify Project ensures you always generate the right format with the right level of detail for your project structure.

Troubleshoot

If Structify Project is not working as expected, here are some common issues and fixes:

1. Command Not Found

Issue: Running structify-project shows command not found.
Fix:

• Make sure you installed Structify Project globally:

  npm install -g structify-project

2. Prompts Not Appearing (skips directly to output)

Cause: The CLI is likely pointing to an old build. Fix:

• Ensure your src/cli.ts has the interactive code (inquirer.prompt).

• Rebuild your package:

    npm run build

3. Huge Output (node_modules too large)

Cause: You selected --node-modules all, which includes all dependencies. Fix:

• Use --node-modules skip (default) to exclude.
• Or --node-modules name to only show the folder.