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

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

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)"

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.0a5.tar.gz (7.2 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.0a5-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ggrab-0.1.0a5.tar.gz
  • Upload date:
  • Size: 7.2 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.0a5.tar.gz
Algorithm Hash digest
SHA256 117c0cc6564f779b0a48344b43d350b47158e8af564c490dcb30f3bf2a6f4ee8
MD5 5a185c626deae9db5a6d12d6dbf117e3
BLAKE2b-256 414b82aa0720e62d59aec554f492d5b42e6a85bb3ee5231ce61c9bca13d2da38

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggrab-0.1.0a5.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.0a5-py3-none-any.whl.

File metadata

  • Download URL: ggrab-0.1.0a5-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.0a5-py3-none-any.whl
Algorithm Hash digest
SHA256 70a40c007e32e1ef36cabbb9cc7ac50121bff9d96909e3561edba2fe5124ca44
MD5 a57d06b011fca6ae90b573b41c047b2c
BLAKE2b-256 f4c85992215bbcf15d98817590e7dbeb62e21a3f3511a7a8f4e75842fce81fcc

See more details on using hashes here.

Provenance

The following attestation bundles were made for ggrab-0.1.0a5-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