sprout 🌱

🌟 Overview

sprout is a command-line interface that takes a bundle created by gitingest and sprouts it in the target directory.

sprout is written in Rust for fun and learning.

🚀 Getting Started

Prerequisites

• Rust: Ensure you have Rust installed. You can get it from rust-lang.org. sprout is built with the latest stable Rust version.

Building sprout

1. Clone the repository (if you haven't already):

   git clone https://github.com/nightconcept/sprout.git
   cd sprout

2. Build for debugging:

   cargo build

   The executable will be located at target/debug/sprout.

3. Build for release (optimized):

   cargo build --release

   The executable will be located at target/release/sprout.

🛠️ Usage

The sprout CLI tool takes a bundle file as input and creates the files and directories in a specified output location.

Command Syntax:

sprout [OPTIONS] [BUNDLE_FILE_PATH] [OUTPUT_DIRECTORY_PATH]

Or using flags:

sprout --input <BUNDLE_FILE_PATH> --output <OUTPUT_DIRECTORY_PATH>

Arguments & Options:

• BUNDLE_FILE_PATH: (Positional or via -i/--input) Path to the bundle file. This is required.
• OUTPUT_DIRECTORY_PATH: (Positional or via -o/--output) Path to the directory where files will be sprouted.
  • Defaults to the current working directory if not specified.
• -f, --force: (Optional) If specified, sprout will overwrite any existing files in the output directory that conflict with files from the bundle. Without this flag, sprout will abort if any collisions are detected.

📜 License

This project is licensed under the MIT License. See LICENSE for details.