Level Sony M.
Back to Projects

readme-runner — Launch Any Project in One Command

Go CLI tool that reads any project's README, generates an AI-powered execution plan, and runs it automatically — no manual setup required.

Go CLI LLM AI DevOps OpenSource
Share
Code Article Star
readme-runner — Launch Any Project in One Command
Table des matières

Why

Every time you clone a project to test it, you spend time deciphering the README, tracking down the right versions, and figuring out which commands to run. If a human can read the README and understand how to launch the app, an LLM can too — and generate a reliable plan in seconds.

What

readme-runner (rdr) is a Go CLI tool that clones, installs, and launches any software project from a single command. It reads the README, computes a clarity score, generates a structured RunPlan via an LLM, validates it through a security layer, then executes — or previews — every step.

How

Modular pipeline in Go: fetcher (clone/copy), scanner (stack detection + README parsing), LLM provider (Anthropic, OpenAI, Mistral, Ollama), validator (security blocklist, risk levels), prerequisite checker, executor (dry-run by default), and cleanup. Developed with GitHub Copilot CLI.

Overview

readme-runner (rdr) is a Go CLI that turns any project’s README.md into an executable installation plan — powered by an LLM. One command to clone, configure, and run.

Developed as a submission for the GitHub Copilot CLI Challenge (DEV Community × GitHub, 2026).

Project Status

In active development — first version not yet released. The core pipeline is functional; ongoing work focuses on multi-OS support and plan caching.

Read the full write-up →

Technologies & Tools

Go
GitHub Actions
GitHub
Linux
Bash
Docker
Git
Go
GitHub Actions
GitHub
Linux
Bash
Docker
Git

Projet suivant

VolleyX — Design and production of a mobile application for managing and scoring volleyball matches

Commentaires