agent-fetch
A Python command-line tool for fetching AGENTS.md files (or other markdown/docs) from GitHub repositories.
🚀 Features
- Interactive-first: Default command triggers beautiful interactive file selection
- Flexible Automation: Flags let advanced users skip interaction with
--all,--name, or--repo - Configurable Defaults: Global default repo stored in config with branch overrides
- Beautiful UI: Colorful menus with arrow key navigation and fuzzy search using
questionary - Cross-platform: Works on Linux, macOS, and Windows
📦 Installation
# Option 1: Traditional pip installation
pip install -e .
# Option 2: Modern uv installation (recommended)
uv pip install -e .
🎯 Quick Start
Default Setup (No Configuration Required)
The tool comes with a pre-configured default repository and works immediately:
# Interactive mode (with default repo)
agentfetch
Change Default Repository (Optional)
If you want to use a different repository:
agentfetch set-repo https://github.com/your-org/docs
Quick Usage Examples
# Interactive mode (default)
agentfetch
# Fetch all files from default repo
agentfetch main --all
# Search for specific files
agentfetch main --name "api" # Fuzzy matching
# Use different repository
agentfetch main --all --repo https://github.com/org/docs
Expected Interactive Output
📁 Files in index.yaml
Select files to fetch using ↑/↓ arrows, space to select, enter to confirm
❯ Python APIs Guide
Shadcn UI Components Guide
Next.js App APIs Guide
📋 Commands
| Command | Description |
|---|---|
agentfetch |
Interactive mode (default) |
agentfetch --all |
Fetch all files |
agentfetch --name <query> |
Fetch by name (fuzzy matching) |
agentfetch --repo <url> |
Fetch from alternate repo |
agentfetch --branch <branch> |
Fetch from specific branch |
agentfetch --no-overwrite |
Skip existing files |
agentfetch set-repo <url> |
Set global default repo |
agentfetch show-repo |
Display current config |
agentfetch list |
List files in index.yaml |
agentfetch validate |
Validate index.yaml |
🔧 Configuration
Configuration is stored in:
- Linux/macOS:
~/.agentfetch/config.yaml - Windows:
%APPDATA%\agentfetch\config.yaml
Example config:
default_repo: "https://github.com/org/agents"
default_branch: "main"
📁 Index File Specification
The tool expects an index.yaml file in the repository root with this structure:
agents:
- name: "Root Guide" # Human-readable name
source: "AGENTS.md" # Repo-relative path
target: "downloads/root.md" # Local destination
- name: "API Guide"
source: "services/api/AGENTS.md"
target: "downloads/api.md"
🔍 Example Workflows
Standard Development Workflow
# Set up default repository
agentfetch set-repo https://github.com/your-org/docs
# Interactive selection for daily use
agentfetch
# Automate fetching all docs
agentfetch --all
# Fetch specific documentation
agentfetch --name "user guide"
CI/CD Integration
# Non-interactive batch operation
agentfetch --all --repo https://github.com/org/docs --branch main
Multi-Repository Setup
# Fetch from monorepo
agentfetch --repo https://github.com/org/monorepo
# Fetch from specific branch
agentfetch --repo https://github.com/org/monorepo --branch feature/new-docs
🛠️ Development
This tool is modular and easily extensible, following Python best practices with:
- OOP Design: Clean class-based architecture
- Separation of Concerns: Config, fetching, parsing, and UI as separate modules
- Robust Error Handling: Comprehensive error handling throughout
- Rich UI: Beautiful, colorful console output with Rich
Project Structure
agents_collector/
├── config/ # Configuration management
├── fetcher/ # GitHub fetching logic
├── parser/ # Index file parsing
├── cli/ # Command-line interface
├── ui/ # Interactive UI components
└── __init__.py
Dependencies
typer: CLI frameworkpyyaml: YAML parsingrequests: HTTP clientquestionary: Interactive menusrapidfuzz: Fuzzy matchingrich: Beautiful console output
🤝 Contributing
The tool follows a modular architecture that makes it easy to:
- Add new fetcher backends (GitLab, local files, etc.)
- Extend interactive selection features
- Add new CLI commands
- Support additional index file formats
📄 License
MIT License
🎉 Why agent-fetch?
This tool makes it simple to collect, organize, and update AGENTS.md files across monorepos or multiple projects, ensuring consistency for both developers and coding agents.
Metadata
Release files for agent-fetch 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| agent_fetch-0.1.0.tar.gz | 14.5 kB | Without provenance | Details for agent_fetch-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| agent_fetch-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for agent_fetch-0.1.0-py3-none-any.whl |
Total release size: 35.7 kB
Release files / agent_fetch-0.1.0.tar.gz
| Download URL | agent_fetch-0.1.0.tar.gz |
|---|---|
| Size | 14.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ec0dd28debd4a501f9d0f2d8ec049fa4a1679ad35192a03551108ab1ef66bac
|
|
BLAKE2b-256 checksum How to use checksums |
15f69d2524e32ac112f7d1d7359771a8af478c29b4b3d583411465b96cc4c823
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.15
|
Release files / agent_fetch-0.1.0-py3-none-any.whl
| Download URL | agent_fetch-0.1.0-py3-none-any.whl |
|---|---|
| Size | 21.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
786a814f093385b317e0af408a7061043504e2bbb7871d3287fc1d6dc0bef4d3
|
|
BLAKE2b-256 checksum How to use checksums |
84f8eef97a6a6e58b6692b4d020e82ee1705e373a63c25d7d23bd0d378c66667
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.15
|
Security for agent-fetch 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.