# Githrun

Githrun is a command-line tool and VS Code extension that lets you execute, explore, and install Python scripts directly from GitHub and Gists — handling dependencies, private repositories, and local tool installation along the way.

## Features

- **Remote execution** — run scripts from GitHub or Gist URLs instantly
- **Auto-dependency management** — creates temporary virtual environments and installs missing packages with `--auto-install`
- **Private repo access** — authenticate with GitHub tokens for private code and higher API rate limits
- **Bookmarks** — save long URLs as short aliases (`githrun run clean-db`)
- **Tool installation** — install remote scripts as permanent local CLI commands
- **Recursive downloads** — download entire folders or sub-directories from a repo
- **Interactive search** — search files in a repo and run results immediately
- **Smart caching** — caches API responses to speed up repeated searches and reduce API usage

## Get started

- [CLI: Installation & Running Scripts](cli-usage.md)
- [CLI: Auth, Bookmarks & Tool Install](cli-auth-and-tools.md)
- [CLI: Find, Search & Download](cli-find-download.md)
- [Python API](python-api.md)
- [VS Code Extension](vscode-extension.md)
- [Configuration](configuration.md)
