Skip to main content

A CLI tool for extracting and sharing code files and functions. A manual context builder for pasting into llms.

Project description

ggrab - Grug Grab Tool

A CLI tool for manually building context to paste into llm chats. ggrab gathers functions, classes, or entire files wraps them with xml and copies it to the clipboard.

Key Features

  • Smart Extraction: Grab entire files or specific functions/classes
  • Intelligent Autocompletion: File paths and function/class names
  • Token Counting: Built-in token counting for AI context limits
  • Language Support:
    • Python (AST-based extraction)
    • JavaScript (Esprima-based extraction)
    • Other files (full file extraction)

Quick Start

  1. Install:
pip install ggrab    # Basic install
# or
pipx install ggrab   # Recommended

Why pipx? The pipx install is recommended because it:

  • Won't interfere with other Python projects (creates its own venv)
  • Makes ggrab available globally in your terminal
  1. Setup:

Add the following to your shell config file (~/.bashrc, ~/.zshrc, or equivalent):

# Enable ggrab autocompletion
eval "$(register-python-argcomplete ggrab)"

Then reload your shell configuration:

# For bash
source ~/.bashrc

# For zsh
source ~/.zshrc

Usage

# Grab entire files
ggrab file.py

# Extract specific functions
ggrab file.py function1 function2

# Mix multiple files and functions
ggrab file1.py func1 func2 file2.js func3

# Now supports full directories (entire files only)
ggrab directory

Press TAB at any time for smart autocompletion:

  • After ggrab: Shows file suggestions
  • After selecting a file: Shows available functions/classes

Examples

# Extract multiple functions from a Python file
$ ggrab utils.py parse_data validate_input
Gathered code from:
  - utils.py, functions: parse_data, validate_input (203 tokens)

===== Combined Snippets (copied to clipboard) =====

# Extract from multiple files
$ ggrab api.py handle_request db.js queryDatabase
Gathered code from:
  - api.py, functions: handle_request (156 tokens)
  - db.js, functions: queryDatabase (178 tokens)

Total tokens across all files: 334

Performance Features

  • Lazy Loading: Heavy dependencies load only when needed
  • Smart Caching: Function/class listings cached for quick access
  • Hybrid Parsing: Fast regex for completion, accurate AST/Esprima for extraction

Requirements

  • Python 3.7+
  • Required: argcomplete
  • Optional but recommended:
    • pyperclip (clipboard support)
    • tiktoken (token counting)
    • esprima (JavaScript parsing)

Advanced Setup

Disable completion sorting (optional):

complete -o nosort -F _python_argcomplete ggrab

For zsh users:

autoload -U compinit && compinit
autoload -U bashcompinit && bashcompinit
eval "$(register-python-argcomplete ggrab)"

Acknowledgments

  • Developed -- ok, prompted into existance by Claude 3.5, o1 pro. Fixed up to working order by Keizo Gates making GrugNotes :)

License

MIT License


For bug reports and feature requests, please open an issue on GitHub.

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

ggrab-0.1.0a10.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

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

ggrab-0.1.0a10-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file ggrab-0.1.0a10.tar.gz.

File metadata

  • Download URL: ggrab-0.1.0a10.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for ggrab-0.1.0a10.tar.gz
Algorithm Hash digest
SHA256 d0c51f79ec1be9bff552918783909186c7d12ea1c8a81a29529b56b216eded70
MD5 b3b2c158b2f00c3f3650a0256c5527b4
BLAKE2b-256 4d8b815eca02681980d6e4545ff38388781d13730a9206cfaff7ab4617561ad4

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggrab-0.1.0a10.tar.gz:

Publisher: python-publish.yml on keizo/ggrab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ggrab-0.1.0a10-py3-none-any.whl.

File metadata

  • Download URL: ggrab-0.1.0a10-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for ggrab-0.1.0a10-py3-none-any.whl
Algorithm Hash digest
SHA256 e9e1c7e6e16a3257e9ad2b1a5abad6e15121a11b1f1aaaeeba44d72f698ba5cd
MD5 0882d030a8a7bb3ea6adff3d2d614217
BLAKE2b-256 150bff1e2f5defc5b6d28ab91b488b678c5110a6e77a481eb850678de4b8b94b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggrab-0.1.0a10-py3-none-any.whl:

Publisher: python-publish.yml on keizo/ggrab

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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