docs: Fix CLI help text accuracy

- Add stdout documentation to --output option help text
- Update default filename to 'digest.txt' consistently
- Enhance docstrings with comprehensive usage examples
- Improve GitHub token documentation with environment variable support
- Fix inconsistencies between help text and actual CLI behavior

Author: Sendi0011

current_help.txt

@@ -0,0 +1,36 @@
+Usage: gitingest [OPTIONS] [SOURCE]
+
+  Main entry point for the CLI. This function is called when the CLI is run as
+  a script.
+
+  It calls the async main function to run the command.
+
+  Parameters ---------- source : str     A directory path or a Git repository
+  URL. output : str, optional     The path where the output file will be
+  written. If not specified, the output will be written     to a file named
+  `<repo_name>.txt` in the current directory. Use '-' to output to stdout.
+  max_size : int     Maximum file size (in bytes) to consider. exclude_pattern
+  : Tuple[str, ...]     Glob patterns for pruning the file set.
+  include_pattern : Tuple[str, ...]     Glob patterns for including files in
+  the output. branch : str, optional     Specific branch to ingest (defaults
+  to the repository's default). include_gitignored : bool     If provided,
+  include files normally ignored by .gitignore. token: str, optional
+  GitHub personal-access token (PAT). Needed when *source* refers to a
+  **private** repository. Can also be set via the ``GITHUB_TOKEN`` env var.
+
+Options:
+  -o, --output TEXT           Output file path (default: <repo_name>.txt in
+                              current directory)
+  -s, --max-size INTEGER      Maximum file size to process in bytes
+  -e, --exclude-pattern TEXT  Patterns to exclude. Handles Python's arbitrary
+                              subset of Unix shell-style wildcards. See:
+                              https://docs.python.org/3/library/fnmatch.html
+  -i, --include-pattern TEXT  Patterns to include. Handles Python's arbitrary
+                              subset of Unix shell-style wildcards. See:
+                              https://docs.python.org/3/library/fnmatch.html
+  -b, --branch TEXT           Branch to clone and ingest
+  --include-gitignored        Include files matched by .gitignore
+  -t, --token TEXT            GitHub personal access token for accessing
+                              private repositories. If omitted, the CLI will
+                              look for the GITHUB_TOKEN environment variable.
+  --help                      Show this message and exit.

src/gitingest/cli.py

@@ -17,7 +17,7 @@
     "--output",
     "-o",
     default=None,
-    help="Output file path (default: <repo_name>.txt in current directory)",
+    help="Output file path (default: digest.txt in current directory). Use '-' for stdout.",
 )
 @click.option(
     "--max-size",
@@ -81,7 +81,7 @@ def main(
         A directory path or a Git repository URL.
     output : str, optional
         The path where the output file will be written. If not specified, the output will be written
-        to a file named `<repo_name>.txt` in the current directory. Use '-' to output to stdout.
+        to a file named `digest.txt` in the current directory. Use '-' to output to stdout.
     max_size : int
         Maximum file size (in bytes) to consider.
     exclude_pattern : Tuple[str, ...]
@@ -95,6 +95,25 @@ def main(
     token: str, optional
         GitHub personal-access token (PAT). Needed when *source* refers to a
         **private** repository. Can also be set via the ``GITHUB_TOKEN`` env var.
+
+    Examples
+    --------
+    Basic usage:
+        $ gitingest .
+        $ gitingest /path/to/repo
+        $ gitingest https://github.com/user/repo
+
+    Output to stdout:
+        $ gitingest . -o -
+        $ gitingest https://github.com/user/repo --output -
+
+    With filtering:
+        $ gitingest . -i "*.py" -e "*.log"
+        $ gitingest . --include-pattern "*.js" --exclude-pattern "node_modules/*"
+
+    Private repositories:
+        $ gitingest https://github.com/user/private-repo -t ghp_token
+        $ GITHUB_TOKEN=ghp_token gitingest https://github.com/user/private-repo
     """
     asyncio.run(
         _async_main(
@@ -133,7 +152,7 @@ async def _async_main(
         A directory path or a Git repository URL.
     output : str, optional
         The path where the output file will be written. If not specified, the output will be written
-        to a file named `<repo_name>.txt` in the current directory. Use '-' to output to stdout.
+        to a file named `digest.txt` in the current directory. Use '-' to output to stdout.
     max_size : int
         Maximum file size (in bytes) to consider.
     exclude_pattern : Tuple[str, ...]
@@ -193,4 +212,4 @@ async def _async_main(
 
 
 if __name__ == "__main__":
-    main()
+    main()

src/static/llm.txt

@@ -176,15 +176,15 @@ gitingest https://github.com/user/private-repo -t $GITHUB_TOKEN -o -
 # Specific branch analysis (short flag)
 gitingest https://github.com/user/repo -b main -o -
 
-# Save to file (default: <repo_name>.txt in current directory)
+# Save to file (default: digest.txt in current directory)
 gitingest https://github.com/user/repo -o my_analysis.txt
 
 # Ultra-concise example for small files only
 gitingest https://github.com/user/repo -i "*.py" -s 51200 -o -
 ```
 
 **Key Parameters for AI Agents**:
-- `-o` / `--output`: Stream to STDOUT with `-` (default saves to `<repo_name>.txt`)
+- `-o` / `--output`: Stream to STDOUT with `-` (default saves to `digest.txt`)
 - `-s` / `--max-size`: Maximum file size in bytes to process (default: no limit)
 - `-i` / `--include-pattern`: Include files matching Unix shell-style wildcards
 - `-e` / `--exclude-pattern`: Exclude files matching Unix shell-style wildcards