Metadata-Version: 2.5
Name: minit-runtime
Version: 0.1.0
Summary: From localhost to real users in one command.
Project-URL: Homepage, https://junghoonwoo-stack.github.io/minit/
Project-URL: Repository, https://github.com/junghoonwoo-stack/minit
Project-URL: Issues, https://github.com/junghoonwoo-stack/minit/issues
Author: Junghoon Woo
License: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Keywords: ai-coding,deployment,developer-tools,localhost,prototyping,tunnel
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.11
Requires-Dist: rich>=13.7
Requires-Dist: typer>=0.12
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Description-Content-Type: text/markdown

# Minit

**From localhost to real users in one command.**

> **Your PC is the first server.**

Minit is an open-source tool for people who build apps with Claude Code, Codex, Cursor, or other AI coding tools and want real users to try them immediately — without setting up cloud infrastructure first.

Your app keeps running on your own PC. Minit gives it a shareable URL.

![Minit demo](assets/demo.svg)

No account. No cloud setup. No separate server software.

**Website:** https://junghoonwoo-stack.github.io/minit/

## Install

With `pipx`:

```bash
pipx install https://github.com/junghoonwoo-stack/minit/archive/refs/heads/main.zip
```

Or with `uv`:

```bash
uv tool install https://github.com/junghoonwoo-stack/minit/archive/refs/heads/main.zip
```

For development:

```bash
git clone https://github.com/junghoonwoo-stack/minit.git
cd minit
pip install -e .
```

## Use

Run your app locally, then:

```bash
minit run
```

Or specify the port:

```bash
minit run --port 8501
```

Minit returns a public URL. Send it to users. Keep your PC on while the app is being used. Press `Ctrl+C` to stop.

## Try it in one minute

```bash
cd examples/hello-minit
python -m http.server 8000
```

In another terminal:

```bash
minit run --port 8000
```

Open the generated URL from another device.

## Security — MVP

`minit run` makes your local app reachable from the public internet. Treat the generated URL as public.

For the current MVP:

- Do not expose apps containing secrets, private files, personal data, or sensitive company data.
- Do not rely on the URL itself as authentication.
- If your app needs access control, add authentication in the app before publishing it.
- Review AI-generated apps for hard-coded API keys, debug endpoints, and unintended file/data access before sharing them.

Minit is currently intended for lightweight prototypes and early user testing, not sensitive or production workloads.

Read the full [Security Policy](SECURITY.md).

## Why Minit?

AI coding made building software much easier. Getting a local app in front of real users should be just as easy.

```text
Build → launch → share → learn
```

Minit is open source and focused first on making this local-to-live experience as simple as possible.

For implementation details, see [Architecture](docs/ARCHITECTURE.md) and [Product Principles](docs/PRODUCT.md).

---

# 미닛

**Minit은 내 PC에서 실행 중인 앱을 바로 외부 사용자에게 공개할 수 있게 해주는 오픈소스 도구입니다.**

Claude Code, Codex, Cursor 등으로 앱을 빠르게 만들었지만, 클라우드나 서버 설정 없이 바로 실제 사용자에게 보여주고 싶을 때 사용합니다.

```text
AI로 앱 개발 → 내 PC에서 실행 → minit run → URL 공유 → 실제 사용자 테스트
```

## 설치

`pipx` 사용 시:

```bash
pipx install https://github.com/junghoonwoo-stack/minit/archive/refs/heads/main.zip
```

또는 `uv`:

```bash
uv tool install https://github.com/junghoonwoo-stack/minit/archive/refs/heads/main.zip
```

## 사용

앱을 실행한 뒤:

```bash
minit run
```

생성된 링크를 사용자에게 보내면 됩니다. **내 PC가 첫 번째 서버**가 되고, PC를 끄면 서비스도 종료됩니다.

## 보안 — 현재 MVP

`minit run`을 실행하면 로컬 앱이 인터넷에서 접근 가능해집니다. 생성된 URL은 **공개 URL**이라고 생각하는 것이 안전합니다.

현재 MVP에서는 비밀번호·API Key·개인정보·회사 내부자료 등 민감한 정보가 들어 있는 앱은 공개하지 않는 것을 권장합니다. 인증이 필요한 앱이라면 Minit으로 공개하기 전에 앱 자체에 인증을 구현해야 합니다. 특히 AI로 생성한 앱은 hard-coded API key, debug endpoint, 의도하지 않은 파일·데이터 접근이 없는지 확인한 뒤 공유하세요.

현재 Minit은 민감하거나 production 용도보다는 **가벼운 prototype과 초기 사용자 테스트**를 위한 도구입니다.

Minit의 첫 번째 목표는 단순합니다.

> **AI로 만든 앱을 localhost에서 실제 사용자에게 가장 쉽게 보여주는 것.**

가입도, 별도 서버도, 클라우드 설정도 최대한 필요 없게 만드는 것을 지향합니다.

## License

[Apache License 2.0](LICENSE).
