Skip to main content

A 3-in-1 CLI toolkit to explore, search, and reconstruct directory structures with LLM-ready context support.

Project description

🌲 Seedling (v2.1.0)

Seedling CI

Seedling is a high-performance, 3-in-1 CLI toolkit designed for developers to explore, search, and reconstruct directory structures. Whether you need a beautiful image of your project architecture or a way to spawn a project from a text blueprint, Seedling has you covered.


🚀 Key Features

  • Context Rehydration 🌟: Generate a project snapshot using scan --full, and use build to flawlessly restore the entire directory structure along with the original source code.
  • Scan & Export: Export directory trees to Markdown, Plain Text, or high-fidelity PNG images with full Chinese character support.
  • Smart Search: Dual-mode search featuring Exact Match and Fuzzy Suggestions (powered by Levenshtein distance) with in-tree 🎯 [MATCHED] visual highlights.
  • Reverse Scaffolding: Use the build command to read any tree diagram (even those copied from a README) and instantly recreate the folder/file hierarchy.
  • Progressive UI: Dynamic "pulsing" progress bars for scanning and real-time construction logs for building.
  • Interactive Personality: Built-in session-based "Easter Eggs" that respond to your terminal behavior (Mac/Linux exclusive).

🛠️ Installation

Seedling is designed to be installed globally via pipx for a clean, isolated environment.

One-Click Setup (Self-Destructing Installers)

Our installers set up the environment, install the tool, and then delete themselves to keep your workspace tidy.

  • Windows: Run install.bat
  • macOS / Linux: Run chmod +x install.sh && ./install.sh

Developer / Manual Install

If you are modifying the source code, use Editable Mode:

pipx install -e . --force

📖 CLI Reference

1. scan - The Explorer

Used for scanning directories or searching for items.

Flag Short Description
--find -f Search Mode. Returns exact and fuzzy matches + a saved report.
--format -F Output format: md (default), txt, or image.
--depth -d Max recursion depth to prevent terminal "walls of text."
--exclude -e List of folders to ignore (e.g., node_modules .git venv).
--outdir -o Where to save the result (Defaults to your current terminal path).
--full - Power Mode. Appends the full text content of all scanned source files to the output.

Examples:

# Export current directory as a PNG image
scan . -F image

# Fuzzy search for a mispelled config file
scan ~/Projects -f "conifg"

# Complex scan: exclude heavy folders, show hidden, save to Desktop
scan . -s -e node_modules -o ~/Desktop -n project_map.md

# 🌟 POWER MODE: Export tree + all source code for LLMs (excluding caches)
scan . --full -e node_modules __pycache__ .git

2. build - The Architect

A dedicated command to turn a text-based tree into a real file system, or restore a project from a snapshot.

Flag Short Description
--check -c Dry-Run Mode. Simulates the build and reports missing/existing items.
--force -f Force Mode. Overwrites existing files without skipping.
--direct -d Direct Mode. Bypasses prompts to instantly create a specific file/folder path.

Examples:

# Build in current directory using a simple blueprint
build blueprint.md

# 🪄 RESTORE MAGIC: Reconstruct an entire project with source code from a --full scan
build project_snapshot.md ~/Desktop/RestoredProject

# Dry-run a blueprint to safely check what will be created
build blueprint.txt --check

# Directly scaffold a folder without prompts
build -d ~/Desktop/NewProject

📂 Project Structure

Seedling/
├── pyproject.toml      <- Modern build configuration
├── install.sh/bat      <- Auto-installers
├── test_suite.sh       <- Auto-tests
└── scan_tool/
    ├── __init__.py     <- Metadata & versioning
    ├── __main__.py     <- Module entry point
    ├── cli.py          <- Logic for 'scan' and 'build' commands
    ├── scanner.py      <- Search and scanning engine
    ├── builder.py      <- Scaffolding and reverse-build engine
    ├── exporter.py     <- Image rendering & OS-specific fonts
    └── utils.py        <- Session logic, animations, and smart-parsing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seedling_tools-2.1.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

seedling_tools-2.1.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file seedling_tools-2.1.0.tar.gz.

File metadata

  • Download URL: seedling_tools-2.1.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for seedling_tools-2.1.0.tar.gz
Algorithm Hash digest
SHA256 9e3fd4b90a569efd2080d50e8193f7f170ad9b4f1bc6e6c41137988d6eb43901
MD5 6e65b95f4d3063316a254613135f4352
BLAKE2b-256 4b758cfd23964f47033690eb47856410793cfd22805793ab3a04ae35e7625d31

See more details on using hashes here.

File details

Details for the file seedling_tools-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: seedling_tools-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for seedling_tools-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e80b2df2506593c284002880e785a037876dc6599af569b9ced50b8325719a0a
MD5 2f363eedf8d0254b05cbcd57dd41e87c
BLAKE2b-256 9e2a296aa9ffd2dde94d9ec6acf8541f579cc2258ac626ad2267cc20b658769e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page