Metadata-Version: 2.4
Name: openrepo-cli
Version: 0.1.0
Summary: Generate dead-simple setup guides for any GitHub repo. Even a 4-year-old could follow it.
Author-email: Andrey <andrey@agentweb.us>
License: MIT
Project-URL: Homepage, https://github.com/andreycpu/openrepo
Project-URL: Repository, https://github.com/andreycpu/openrepo
Project-URL: Issues, https://github.com/andreycpu/openrepo/issues
Keywords: cli,github,setup,guide,documentation,open-source
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: llm
Requires-Dist: httpx>=0.27; extra == "llm"
Dynamic: license-file

# openrepo

Generate dead-simple setup guides for any GitHub repo. Even a 4-year-old could follow it.

You give it a GitHub URL. It clones the repo, analyzes the structure, and generates a step-by-step guide with exact bash commands to get it running. No assumed knowledge.

## Install

```bash
pip install openrepo
```

For LLM-powered guides (richer output using Claude):

```bash
pip install openrepo[llm]
```

## Usage

### Basic (no API key needed)

```bash
openrepo https://github.com/karpathy/autoresearch
```

This analyzes the repo locally and generates a setup guide. The guide prints to your terminal and saves to a markdown file.

### With Claude (richer, more contextual guides)

```bash
export ANTHROPIC_API_KEY=your_key
openrepo https://github.com/karpathy/autoresearch --llm
```

### Options

```
openrepo <github-url>           # basic local analysis
openrepo <github-url> --llm     # use Claude for richer guide
openrepo <github-url> -o FILE   # custom output path
openrepo <github-url> --keep    # keep cloned repo after analysis
```

## What it detects

- Python projects (pip, uv, poetry, pipenv)
- Node.js projects (npm, yarn, pnpm, bun)
- Rust projects (cargo)
- Go projects (go mod)
- Docker setups
- Makefiles
- Environment variables (.env.example)
- Entry points and run commands
- Available scripts and make targets

## Example output

```
# How to Set Up `autoresearch`

Source: https://github.com/thenamangoyal/autoresearch

## What you need first

- **Git** — https://git-scm.com
- **Python 3.10+** — https://python.org/downloads
- **uv** — `curl -LsSf https://astral.sh/uv/install.sh | sh`

## Setup (step by step)

### Step 1: Download the project

Open your terminal and run:

    git clone https://github.com/thenamangoyal/autoresearch
    cd autoresearch

### Step 2: Install Python dependencies

    uv sync

### Step 3: Run it

    uv run prepare.py
    uv run train.py
```

## Why this exists

Open source READMEs are written by the person who built the project. They skip steps that feel obvious to them but aren't obvious to anyone else. This tool bridges that gap automatically.

## License

MIT
