Metadata-Version: 2.4
Name: treesh
Version: 0.1.0
Summary: Turn a text description of a folder structure into an actual folder structure.
Project-URL: Homepage, https://github.com/not-em/treesh
Project-URL: Repository, https://github.com/not-em/treesh
Project-URL: Issues, https://github.com/not-em/treesh/issues
License: MIT
Keywords: bootstrap,cli,directory,scaffolding,tree
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: typer>=0.26.8
Description-Content-Type: text/markdown

# treesh

Turn a text description of a folder structure into an actual folder structure.

```
$ treesh examples/rust-crate.txt --root ./my-crate
```

## Install

For now, treesh lives on GitHub. 

```
uv tool install git+https://github.com/not-em/treesh
```

## Usage

**From a file:**

```
treesh examples/python-package.txt --root ./my-project
```

**From a string:**

```
treesh "src/
    main.py
    utils.py"
```

**Dry run (preview without creating):**

```
treesh examples/rust-crate.txt --dry-run
```

## Tree format

treesh accepts trees in most sensible formats:

- Four-space indentation, or tree-drawing characters (`├──`, `└──`, `│`), or both
- Trailing slashes (`src/`) or children mark a folder
- Comments after `#` or `←` are stripped
- Blank lines and whole line comments are ignored

## Examples

See the `examples/` folder for ready-made trees.