Added capability to process local folder.

Author: fabiomolinar

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "git2prompt"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Fabio Thomaz Molinar <[email protected]>"]
 description = "git2prompt is a command-line tool that takes a GitHub repository URL, downloads its contents, and generates a single text file optimized for use as input to AI tools."
 readme = "README.md"

Cargo.toml

@@ -30,6 +30,10 @@ For example:
 
 `git2prompt rust-lang/rust-by-example`
 
+Or in case you have the repository on your local machine, then just run it with the `--local` flag.  For example:
+
+`git2prompt --local .`
+
 ### **Advanced Usage**
 
 Process multiple repositories and merge their contents into a single file:

README.md

@@ -5,7 +5,7 @@ pub mod repository;
 
 use futures::future::join_all;
 use io_utils::{ensure_directories, read_ignore_patterns};
-use processing::process_single_repository;
+use processing::{process_repository_files, process_single_repository}; // Import process_repository_files
 use repository::Repository;
 use std::path::PathBuf;
 use std::sync::Arc;
@@ -75,3 +75,44 @@ pub async fn process_github_urls(
 
     Ok(output_paths)
 }
+
+/// Processes a single local directory path, prepares content, and writes to output.
+pub async fn process_local_path(
+    path: PathBuf,
+    no_headers: bool,
+    ignore_file: Option<PathBuf>,
+    folder: Option<String>,
+) -> Result<Vec<PathBuf>, String> {
+    if !path.is_dir() {
+        return Err(format!("Local path {:?} is not a directory.", path));
+    }
+
+    // Prepare output directory
+    let output_dir = PathBuf::from("./output");
+    ensure_directories(&PathBuf::new(), &output_dir).await?; // No download dir needed
+
+    // Read ignore patterns
+    let ignore_patterns = read_ignore_patterns(ignore_file).await?;
+
+    // Create a repository object from the local path
+    let mut repository = Repository::from_local_path(&path);
+    // Print full path for debugging
+    println!("Processing local repository at path: {:?}", repository.path);
+
+    // Process the files in the local directory
+    let content = process_repository_files(
+        &repository.path,
+        no_headers,
+        false, // merge_files is false since there is only one repo
+        &ignore_patterns,
+        folder.as_deref(),
+    )
+    .await?;
+    repository.content = Some(content);
+
+    // Use handle_results to generate the output file
+    let repositories = vec![repository];
+    let output_paths = processing::handle_results(repositories, false, &output_dir).await?;
+
+    Ok(output_paths)
+}

src/lib.rs

@@ -1,22 +1,26 @@
 use clap::Parser;
-use git2prompt::process_github_urls;
+use git2prompt::{process_github_urls, process_local_path};
 use std::path::PathBuf;
 
-/// A command-line tool to download GitHub repository contents and format them for AI tools.
+/// A command-line tool to process repository contents and format them for AI tools.
 #[derive(Parser, Debug)]
 #[clap(author, version, about, long_about = None)]
 struct Args {
-    /// GitHub repository URLs (e.g., "owner/repo"). Supports multiple URLs.
+    /// GitHub repository URLs (e.g., "owner/repo") or a single local path with --local.
     #[clap(required = true)]
-    urls: Vec<String>,
+    sources: Vec<String>,
+
+    /// Process the source as a local directory path instead of a GitHub URL.
+    #[clap(short, long, action)]
+    local: bool,
 
     /// Do not add file paths as headers above code blocks in the output file(s).
     #[clap(short, long, action)]
     no_headers: bool,
 
     /// Merge contents of all repositories into a single output file.
-    /// If not set, a separate file will be created for each repository.
-    #[clap(short, long, action)]
+    /// Incompatible with --local.
+    #[clap(short, long, action, conflicts_with = "local")]
     merge_files: bool,
 
     /// Path to a file containing a list of files/folders to ignore.
@@ -28,12 +32,13 @@ struct Args {
     )]
     ignore_file: PathBuf,
 
-    /// Download and process only a specific folder within the repository
+    /// Download and process only a specific folder within the repository.
     #[clap(short, long, value_name = "FOLDER PATH", conflicts_with = "pr")]
     folder: Option<String>,
 
-    /// Process only the files changed in a specific pull request
-    #[clap(long, value_name = "PULL REQUEST NUMBER", conflicts_with = "folder")]
+    /// Process only the files changed in a specific pull request.
+    /// Incompatible with --local.
+    #[clap(long, value_name = "PULL REQUEST NUMBER", conflicts_with_all = ["folder", "local"])]
     pr: Option<u32>,
 }
 
@@ -42,25 +47,48 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     let args = Args::parse();
 
     println!("Starting git2prompt...");
-    println!("Repositories to process: {:?}", args.urls);
-    println!("No file headers: {}", args.no_headers);
-    println!("Merge into a single output file: {}", args.merge_files);
-    println!("Ignore file path: {:?}", args.ignore_file);
-    println!("Folder to process: {:?}", args.folder);
-    println!("Pull request number: {:?}", args.pr);
-    println!("----------------------------------------");
 
-    // Call the library function to process the URLs, wrapping the ignore file path in Some
-    match process_github_urls(
-        args.urls,
-        args.no_headers,
-        args.merge_files,
-        Some(args.ignore_file),
-        args.folder,
-        args.pr,
-    )
-    .await
-    {
+    let result = if args.local {
+        // --- LOCAL PATH MODE ---
+        if args.sources.len() != 1 {
+            // Using Box::from to create a valid error type
+            return Err(Box::from(
+                "Error: When using --local, exactly one directory path must be provided.",
+            ));
+        }
+        let local_path = PathBuf::from(&args.sources[0]);
+        println!("Processing local repository at: {:?}", local_path);
+        println!("No file headers: {}", args.no_headers);
+        println!("Ignore file path: {:?}", args.ignore_file);
+        println!("----------------------------------------");
+        process_local_path(
+            local_path,
+            args.no_headers,
+            Some(args.ignore_file),
+            args.folder,
+        )
+        .await
+    } else {
+        // --- GITHUB URL MODE (default) ---
+        println!("Repositories to process: {:?}", args.sources);
+        println!("No file headers: {}", args.no_headers);
+        println!("Merge into a single output file: {}", args.merge_files);
+        println!("Ignore file path: {:?}", args.ignore_file);
+        println!("Folder to process: {:?}", args.folder);
+        println!("Pull request number: {:?}", args.pr);
+        println!("----------------------------------------");
+        process_github_urls(
+            args.sources,
+            args.no_headers,
+            args.merge_files,
+            Some(args.ignore_file),
+            args.folder,
+            args.pr,
+        )
+        .await
+    };
+
+    match result {
         Ok(output_paths) => {
             println!("Processing complete. Output files created:");
             for path in output_paths {
@@ -73,4 +101,4 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
             Err(e.into())
         }
     }
-}
+}

src/main.rs

@@ -12,6 +12,7 @@ pub struct Repository {
 }
 
 impl Repository {
+    /// Creates a new Repository instance from a remote GitHub URL.
     pub fn new(base_download_dir: &Path, repo_url: &str) -> Self {
         let url = format!("https://github.com/{}.git", repo_url);
         let name = repo_url.replace("/", "-");
@@ -24,6 +25,18 @@ impl Repository {
             content: None,
         }
     }
+
+    /// Creates a new Repository instance from a local file system path.
+    pub fn from_local_path(local_path: &Path) -> Self {
+
+        Self {
+            url: "local".to_string(), // URL is not applicable
+            name: "local-repo".to_string(), // A generic name for local repos
+            path: local_path.to_path_buf(), // The path is the provided local path
+            content: None,
+        }
+    }
+
     pub fn has_content(&self) -> bool {
         self.content.is_some()
     }
@@ -40,4 +53,4 @@ impl fmt::Display for Repository {
             self.has_content()
         )
     }
-}
+}