tree2md 0.9.2

# tree2md

[![Crates.io](https://img.shields.io/crates/v/tree2md.svg)](https://crates.io/crates/tree2md)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**Visualize your codebase structure for humans and AI agents.**

```bash
tree2md                        # Pretty tree in terminal
tree2md | pbcopy               # Pipe-friendly tree for clipboard
tree2md -c -I "*.rs" -L 2     # Tree + file contents for AI context
```

---

## Output Modes

Output format is auto-detected based on TTY:

| Mode | When | What |
|------|------|------|
| **TTY** | Terminal | Emoji, LOC bars, stats, tree characters |
| **Pipe** | `\| pbcopy`, redirect, etc. | Plain tree + `(N lines)` |
| **Pipe + `-c`** | AI context | Tree + code-fenced file contents |

### TTY (terminal)

```
├── 📁 src/
│   ├── 🦀 cli.rs          [██████████]    156 (M)
│   ├── 🦀 main.rs         [████······]     65 (S)
│   └── 📁 render/
│       ├── 🦀 pipe.rs     [█████████·]    148 (M)
│       └── 🦀 terminal.rs [██████████]    247 (M) ★
└── Cargo.toml              [█·········]     36 (S)

**Totals**: 📂 3 dirs • 📄 5 files • 🧾 ~652 LOC
```

### Pipe

```
.
├── src/
│   ├── cli.rs  (156 lines)
│   ├── main.rs  (65 lines)
│   └── render/
│       ├── pipe.rs  (148 lines)
│       └── terminal.rs  (247 lines)
└── Cargo.toml  (36 lines)
```

### Pipe + `-c` (AI context)

```
.
├── src/
│   └── main.rs  (65 lines)
└── Cargo.toml  (36 lines)

## src/main.rs

```rust
fn main() {
    println!("Hello, world!");
}
```

## Cargo.toml

```toml
[package]
name = "example"
```
```

---

## Installation

```bash
cargo install tree2md
```

Or from source:

```bash
git clone https://github.com/zawakin/tree2md
cd tree2md
cargo install --path .
```

---

## CLI Options

### Filtering

| Flag | Description |
|------|-------------|
| `-L, --level <N>` | Limit traversal depth |
| `-I, --include <GLOB>` | Include patterns (repeatable) |
| `-X, --exclude <GLOB>` | Exclude patterns (repeatable) |
| `--use-gitignore {auto\|never\|always}` | Respect `.gitignore` |

### Contents

| Flag | Description |
|------|-------------|
| `-c, --contents` | Append file contents as code blocks |

### Statistics

| Flag | Description |
|------|-------------|
| `--stats {off\|min\|full}` | Statistics display (default: `full`) |
| `--loc {off\|fast\|accurate}` | Line counting mode (default: `fast`) |

### Fun & Style

| Flag | Description |
|------|-------------|
| `--fun {auto\|on\|off}` | Emojis and animations (default: `auto`) |
| `--emoji <MAPPING>` | Custom emoji (e.g., `--emoji ".rs=🚀"`) |
| `--emoji-map <FILE>` | Load emoji mappings from TOML file |
| `--no-anim` | Disable animations |

### Safety

| Flag | Description |
|------|-------------|
| `--safe` | Apply safety filters (default) |
| `--unsafe` | Disable all safety filters |

---

## Safety Defaults

Excluded by default:

- `.env`, `.ssh/**`, `*.pem`, `*.key`
- `node_modules/`, `target/`, `dist/`, `build/`
- `.git/**`, `.DS_Store`, `Thumbs.db`

Use `-I` to selectively include, or `--unsafe` to disable filters.

---

## Use Cases

**Copy structure to clipboard**

```bash
tree2md . -L 3 | pbcopy
```

**Feed codebase to AI agent**

```bash
tree2md . -c -I "*.rs" -I "*.toml" | pbcopy
```

**Quick project overview**

```bash
tree2md . -L 2 --stats min
```

**Rust files only, 3 levels deep**

```bash
tree2md src/ -L 3 -I "*.rs"
```

---

## Build from Source

```bash
git clone https://github.com/zawakin/tree2md
cd tree2md
cargo build --release
cargo test
```

---

## Contributing

PRs welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).

```bash
mise run verify   # fmt + clippy + tests
mise run fix      # auto-format + clippy fix
```

---

## License

MIT License — see [LICENSE](LICENSE).