Metadata-Version: 2.4
Name: rtfmup
Version: 0.0.1.dev0
Summary: Set up any repo from its README.
Keywords: setup,readme,cli,developer-tools,bootstrap
Author: xb17
Author-email: xb17 <10093951+xb17@users.noreply.github.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/xb17/rtfmup
Project-URL: Repository, https://github.com/xb17/rtfmup
Project-URL: Issues, https://github.com/xb17/rtfmup/issues
Description-Content-Type: text/markdown

# rtfmup

**Set up any repo from its README.**
Read The Fine Manual, then bring it `up`.

> ⚠️ **Early development, not ready for use.** This release only claims the name and ships a minimal `scan` command.

## What it will do

`rtfmup` takes a Git repo (a URL or a local path), works out what it is, and gets it running on your machine, whether or not you know its language, package manager, or runtime. Dependency manifests describe *what* a project needs but not the full path from clone to running. That path usually lives in the README. rtfmup reads manifests as ground truth and parses the README's structure (headings, fenced shell blocks, env vars, ports) as data. No LLM is required. It turns both into a reviewed, step-by-step plan: runtime → dependencies → environment → run. Nothing runs without your confirmation.

## Install

```console
uvx rtfmup --version
```

## Usage today

```console
rtfmup --version
rtfmup scan [path]          # detect manifests in a local repo (default: .)
rtfmup scan [path] --json   # same, as JSON
```

`scan` currently recognises `pyproject.toml`, `requirements.txt`, `package.json`, `Cargo.toml`, `go.mod`, `Dockerfile`, Compose files, and `.env.example` at the repo root.

## Planned CLI

```console
rtfmup <url|path>   # full flow: analyse, show plan, confirm, set up, run
rtfmup scan <path>  # analysis only (manifests + README), as summary or JSON
rtfmup plan <path>  # show the execution plan without running anything
```

## Roadmap

1. **Detection engine:** manifest scanner, README Markdown-AST parser, command classification (install / setup / run).
2. **Plan generator:** an ordered plan with gaps surfaced (missing runtimes, env values, external services).
3. **Executor (Windows first):** invokes existing tools (`uv`, `npm`, `cargo`, …), guides `.env` setup, runs the project, and health-checks it.
4. **Polish:** recovery from common failures and clearer diagnostics.

Later: cross-platform support, deployment-file awareness, a learning mode that writes the spec the repo was missing, and an opt-in local-LLM assist.

## License

[Apache-2.0](LICENSE)
