Skip to content

Commit 34cd5b6

Browse files
epilandeepilande
committed
docs: Update README
1 parent f3b02aa commit 34cd5b6

2 files changed

Lines changed: 20 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@ to your clipboard, ready for LLM processing.
1818

1919
## ✨ Features
2020

21-
- 🎮 **Interactive Mode**: Navigate your project structure with vim-like keybindings in a
22-
TUI environment
23-
- 🧹 **Filtering Options**: Respect `.gitignore` rules, handle hidden files, apply customizable glob
24-
patterns, and skip large files
21+
- 🎮 **Interactive Mode**: Navigate your project structure with vim-like keybindings in a TUI environment
22+
- 💻 **CLI Mode**: Run non-interactively (`-n` flag) to grab all valid files based on filters, ideal for scripting
23+
- 🧹 **Filtering Options**: Respect `.gitignore` rules, handle hidden files, apply customizable glob patterns, and skip large files
2524
- 🔍 **Fuzzy Search**: Quickly find files across your project
2625
- ✅ **File Selection**: Toggle files or entire directories (with child items) for inclusion or exclusion
2726
- 📄 **Multiple Output Formats**: Generate Markdown, Plain Text, or XML output
@@ -91,20 +90,20 @@ grab [options] [directory]
9190

9291
### Options
9392

94-
| Option | Description |
95-
| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
96-
| `-h, --help` | Display help information. |
97-
| `-v, --version` | Display version information. |
98-
| `-n, --non-interactive` | Run in non-interactive mode (selects all valid files respecting filters). |
99-
| `-o, --output <file>` | Output file path (default: `./codegrab-output.<format>`). |
100-
| `-t, --temp` | Use system temporary directory for output file. |
101-
| `-g, --glob <pattern>` | Include/exclude files and directories using glob patterns. Can be used multiple times. Prefix with '!' to exclude (e.g., `--glob="*.{ts,tsx}" --glob="\!*.spec.ts"`). |
102-
| `-f, --format <format>` | Output format. Available: `markdown`, `text`, `xml` (default: `"markdown"`). |
103-
| `-S, --skip-redaction` | Skip automatic secret redaction via gitleaks (Default: false). WARNING: Disabling this may expose sensitive information! |
104-
| `--deps` | Automatically include direct dependencies for selected files (Go, JS/TS). |
105-
| `--max-depth <depth>` | Maximum depth for dependency resolution (`-1` for unlimited, default: `1`). Only effective with `--deps`. |
106-
| `--max-file-size <size>` | Maximum file size to include (e.g., `"100kb"`, `"2MB"`). No limit by default. Files exceeding the specified size will be skipped. |
107-
| `--theme <name>` | Set the UI theme. Available: catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, dracula, nord. (default: `"catppuccin-mocha"`). |
93+
| Option | Description |
94+
| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
95+
| `-h, --help` | Display help information. |
96+
| `-v, --version` | Display version information. |
97+
| `-n, --non-interactive` | Run in non-interactive mode (selects all valid files respecting filters). |
98+
| `-o, --output <file>` | Output file path (default: `./codegrab-output.<format>`). |
99+
| `-t, --temp` | Use system temporary directory for output file. |
100+
| `-g, --glob <pattern>` | Include/exclude files and directories using glob patterns. Can be used multiple times. Prefix with '!' to exclude (e.g., `--glob="*.{ts,tsx}" --glob="\!*.spec.ts"`). |
101+
| `-f, --format <format>` | Output format. Available: `markdown`, `text`, `xml` (default: `"markdown"`). |
102+
| `-S, --skip-redaction` | Skip automatic secret redaction via gitleaks (Default: false). WARNING: Disabling this may expose sensitive information! |
103+
| `--deps` | Automatically include direct dependencies for selected files (Go, JS/TS). |
104+
| `--max-depth <depth>` | Maximum depth for dependency resolution (`-1` for unlimited, default: `1`). Only effective with `--deps`. |
105+
| `--max-file-size <size>` | Maximum file size to include (e.g., `"100kb"`, `"2MB"`). No limit by default. Files exceeding the specified size will be skipped. |
106+
| `--theme <name>` | Set the UI theme. Available: catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha, rose-pine, rose-pine-dawn, rose-pine-moon, dracula, nord. (default: `"catppuccin-mocha"`). |
108107

109108
### 📖 Examples
110109

@@ -234,6 +233,7 @@ CodeGrab comes with several built-in themes:
234233
- Catppuccin (Latte, Frappe, Macchiato, Mocha)
235234
- Dracula
236235
- Nord
236+
- Rosé Pine (Main, Moon, Dawn)
237237

238238
Select a theme using the `--theme` flag:
239239

‎internal/ui/help.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ const UsageText = `Usage:
5252
--max-file-size <size> Maximum file size to include (e.g., "50kb", "2MB"). No limit by default.
5353
Files exceeding this size will be skipped if the limit is set.
5454
--theme <name> Set the UI theme. Available: catppuccin-latte, catppuccin-frappe,
55-
catppuccin-macchiato, catppuccin-mocha, dracula, nord.
56-
(default: "catppuccin-mocha").
55+
catppuccin-macchiato, catppuccin-mocha, rose-pine, rose-pine-dawn,
56+
rose-pine-moon, dracula, nord. (default: "catppuccin-mocha").
5757
5858
Examples:
5959
# Run interactively in the current directory

0 commit comments

Comments
 (0)