Skip to content

Repository files navigation

LaunchLens

Know if your repo is ready to launch before you share it.

LaunchLens is a local-first Python CLI that scans an open-source repository for launch-readiness signals, prints a colorful terminal score, and writes a shareable launch-report.md — no API key, no network calls, no source upload.

中文说明

python -m pip install -e .
launch-lens --path . --profile cli
LaunchLens: repository launch readiness
Profile: cli
Score: 78/100
Status: Almost ready

Strong signals
- README.md exists
- License file found
- Test directory found

Fix next
- Add a demo GIF, screenshot, or terminal recording link
- Add release notes or CHANGELOG.md

Why LaunchLens?

Most repositories lose attention in the first 10 seconds because the basics are missing: install steps, demo proof, license, changelog, security notes, or clear usage examples.

LaunchLens turns that pre-launch checklist into a fast local score with practical next actions.

Use it before you:

  • post a repo on GitHub, Hacker News, Reddit, X, or Product Hunt;
  • publish a CLI, library, app, research project, or security PoC;
  • ask for stars, users, feedback, or contributors;
  • cut a first release and want a clean GitHub first screen.

Features

  • Local-first: no API key, no telemetry, no network calls.
  • Fast launch score: get a repository readiness snapshot in seconds.
  • Profile-aware checks: choose cli, library, app, research, or security-poc.
  • Actionable fixes: not just pass/fail; LaunchLens tells you what to improve next.
  • Shareable report: writes launch-report.md for PRs, releases, and screenshots.
  • Small and explainable: simple static checks that are safe to run in any repo.

Quick start

Install in editable mode from the repository:

python -m pip install -e .

Run against the current repository:

launch-lens --path . --profile cli

Or use Python module mode:

python -m launch_lens --path . --profile cli

Generate a report at a custom path:

launch-lens --path . --profile library --output launch-report.md

Run tests:

python -m pytest -q

Profiles

Profile Best for Checks include
cli command-line tools usage, install steps, examples, tests, license, changelog
library packages and SDKs package metadata, API examples, versioning, tests, license
app web/desktop/mobile apps screenshots, setup steps, config notes, license, security notes
research papers, models, datasets citation, data/model notes, reproducibility, license
security-poc vulnerability demos legal disclaimer, affected versions, reproduction steps, mitigation notes

What LaunchLens looks for

LaunchLens checks common signals that help visitors trust and try a repository:

  • README presence and useful sections
  • install or setup instructions
  • usage examples
  • demo links, screenshots, GIFs, or terminal recordings
  • license file
  • tests or test instructions
  • changelog or release notes
  • security/disclaimer notes where relevant
  • package/project metadata
  • profile-specific launch gaps

Example workflow

launch-lens --path . --profile cli --output launch-report.md

Then:

  1. open launch-report.md;
  2. fix the top missing launch signals;
  3. rerun LaunchLens;
  4. commit the improved README/release materials;
  5. share the repo with more confidence.

Design goals

LaunchLens intentionally favors static, explainable checks over opaque scoring. It should be:

  • safe to run locally;
  • easy to understand;
  • useful before a public launch;
  • small enough to inspect and modify;
  • helpful for maintainers, indie hackers, researchers, and security authors.

License

MIT

About

Local-first CLI that scores an open-source repo's launch readiness and writes a shareable launch-report.md.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages