Skip to main content

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

Project description

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

pip install openrepo

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

pip install openrepo[llm]

Usage

Basic (no API key needed)

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)

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

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

openrepo_cli-0.1.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

openrepo_cli-0.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file openrepo_cli-0.1.0.tar.gz.

File metadata

  • Download URL: openrepo_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for openrepo_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0cf22e66f55470694210327eb171a1727426b923df0c2fc2b7fe26a91d75b4be
MD5 3eacc41f2168441016948f0180c392cd
BLAKE2b-256 72b69eefe0169121dd4727f5318b6a5db86948927e42f101d127096e1b9a683f

See more details on using hashes here.

File details

Details for the file openrepo_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: openrepo_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for openrepo_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8528007e992c9f1eeb0c758461efaf39b9c01fd751a94229a77f868265da142
MD5 46efb7d3a6aa9007cc0cf020b0de9656
BLAKE2b-256 82367f3daf06f2deaf9bda43192373b0f4c0a6ae57a186baa68027cfe5a28f2a

See more details on using hashes here.

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