Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Transform tree diagrams into real folders and generate folder structure visualiz
npm install -g foldertree-cli
```

## Usage
### Creating Folders from Tree Diagram

1. Create a text file (e.g., `structure.txt`) with your desired folder structure:
Expand Down Expand Up @@ -50,10 +49,38 @@ Generate a tree diagram from an existing folder
foldertree-cli generate my-project output.txt
```

## ❗To hide system files or to include `.gitignore` rules, [check the section below](#usage-guide).

### Tree Diagram Format

* Use ├── for items that have siblings below them
* Use └── for the last item in a group
* Use │ for vertical lines
* Add / at the end of folder names
* Indent using spaces (4 spaces or 1 tab)


## usage-guide

<details> <summary>CLI help</summary>

```
Usage:
foldertree-cli (create-folders|create|c) <input-file> <target-directory>
foldertree-cli (generate-file|generate|g) <source-directory> <output-file> [options]

Commands:
create-folders, create, c - Create folder structure from input file
generate-file, generate, g - Generate structure text file from existing directory

Options:
--ignore <gitignore-file> - Specify a .gitignore file to exclude additional paths
--include-hidden - Include hidden and system folders (like .git, .vscode)

Examples:
foldertree-cli create-folders ./structure.txt ./my-project
foldertree-cli generate-file ./my-project ./output-structure.txt
foldertree-cli generate-file ./my-project ./output-structure.txt --ignore ./.gitignore
foldertree-cli generate-file ./my-project ./output-structure.txt --include-hidden
```
</details>
29 changes: 17 additions & 12 deletions README.npm.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,28 @@ foldertree-cli generate my-project output.txt
└── README.md
```

## Commands
### create

Creates folders and files from a tree diagram:

```bash
foldertree-cli create <input-file> <target-directory>
### Usage:
```
Usage:
foldertree-cli (create-folders|create|c) <input-file> <target-directory>
foldertree-cli (generate-file|generate|g) <source-directory> <output-file> [options]

### generate
Commands:
create-folders, create, c - Create folder structure from input file
generate-file, generate, g - Generate structure text file from existing directory

Creates a tree diagram from existing folders:
```bash
foldertree-cli generate <source-directory> <output-file>
Options:
--ignore <gitignore-file> - Specify a .gitignore file to exclude additional paths
--include-hidden - Include hidden and system folders (like .git, .vscode)

Examples:
foldertree-cli create-folders ./structure.txt ./my-project
foldertree-cli generate-file ./my-project ./output-structure.txt
foldertree-cli generate-file ./my-project ./output-structure.txt --ignore ./.gitignore
foldertree-cli generate-file ./my-project ./output-structure.txt --include-hidden
```

Features
### Features
* Validates tree diagram format
* Handles nested structures
* Creates empty files automatically
Expand Down
Loading