Skip to content

Repository files navigation

LaunchSmith — Launch your GitHub repo like a product, with proof not hype

LaunchSmith

Launch your GitHub repo like a product — with proof, not hype.

CI GitHub CLI extension Zero runtime dependencies MIT License

Live self-audit · Launch evidence · Discussion · Agent Skill

LaunchSmith is a local, evidence-first launch-readiness auditor for open-source repositories. It inspects real repository files and GitHub metadata, scores the gaps that block adoption, then generates a reviewable launch pack without inventing claims.

LaunchSmith auditing a repository, showing its evidence report, and generating a reviewable launch pack

Why LaunchSmith?

Most repository launch advice stops at “improve the README.” LaunchSmith checks the full path from discovery to trust:

  • Can a visitor understand the outcome in ten seconds?
  • Is there a copy-paste route to the first useful result?
  • Does the repository show real screenshots, tests, releases, and limitations?
  • Are license, security, contribution, and issue paths ready?
  • Can every launch claim be traced to a file, command, screenshot, or GitHub URL?

The result is a prioritized forge report instead of a generic checklist.

GitHub Actions job summary

When GITHUB_STEP_SUMMARY is set (GitHub Actions), gh launchsmith audit appends a compact Markdown summary — score, category table, and unresolved findings — with no extra flags or runtime dependencies.

- uses: actions/checkout@v4
- run: gh extension install Lwu0rup/gh-launchsmith
- run: gh launchsmith audit --no-github

Installation

GitHub CLI extension

Requirements: GitHub CLI and Node.js 18 or newer.

gh extension install Lwu0rup/gh-launchsmith

Upgrade later with:

gh extension upgrade launchsmith

Run from a clone

git clone https://github.com/Lwu0rup/gh-launchsmith.git
cd gh-launchsmith
node ./gh-launchsmith --help

Quick start

Run this inside any Git repository:

gh launchsmith audit --html .launchsmith/report.html

Expected output:

LAUNCHSMITH
owner/project  76/100  NEARLY FORGED

Positioning   ███████████████░░░  82%
Proof         ████████████░░░░░░  67%
Onboarding    ████████████████░░  88%
Trust         █████████████░░░░░  72%
Distribution  ██████████░░░░░░░░  58%

Priority fixes (6)
FAIL  README shows the product
      Add a real screenshot, GIF, terminal capture, or short video near the top.
LaunchSmith self-audit report preview

Then generate the reviewable launch pack:

gh launchsmith pack

LaunchSmith writes .launchsmith/ with:

audit.json             Full machine-readable audit
report.html            Self-contained visual forge report
launch.json            Explicit facts, claims, and verification slots
LAUNCH_CHECKLIST.md     Priority-ordered release gate
EVIDENCE.md             Claim-to-evidence register
ANNOUNCEMENT.md         General launch draft
HACKER_NEWS.md          Show HN draft
REDDIT.md               Community-first draft
X.md                    Short launch draft
RELEASE_NOTES.md        First-release draft

Generated placeholders stay visibly marked as [ADD: ...]. LaunchSmith will not turn missing evidence into confident marketing copy.

Usage examples and commands

Command Result
gh launchsmith audit Terminal scorecard and prioritized fixes
gh launchsmith audit --json Complete JSON audit on stdout
gh launchsmith audit --html report.html Offline interactive-style HTML report
gh launchsmith pack Evidence register, launch drafts, checklist, report
gh launchsmith preview Regenerate .launchsmith/report.html
gh launchsmith watch Append a local GitHub metrics snapshot

Useful options:

--cwd <path>       Inspect another repository
--no-github        Run with local evidence only
--strict           Exit non-zero below 80/100
--force            Replace generated launch-pack files
--output <path>    Choose the pack/report/metrics location

What the audit checks

Area Examples of inspectable evidence
Positioning README opening, GitHub description, audience, use cases, topics
Proof Demo assets, runnable commands, tests, CI, expected output, releases
Onboarding Installation, quick start, examples, prerequisites, troubleshooting
Trust License, security policy, contribution guide, conduct, change history
Distribution Social preview, homepage/demo, issue templates, launch materials

Each rule returns its score, the evidence LaunchSmith observed, and one concrete next action.

Companion Agent Skill

The repository includes skills/launchsmith, compatible with agent-skill workflows for Codex and Claude Code.

npx skills add Lwu0rup/gh-launchsmith

Example prompt:

Use $launchsmith to audit this repository, fix the highest-value launch gaps,
capture real proof, and prepare a reviewed launch pack.

The skill runs the deterministic audit first, improves the repository from evidence, and reruns the audit before preparing public copy.

Evidence-first design

LaunchSmith deliberately separates facts from creative work:

  1. Local files and Git metadata are collected.
  2. GitHub metadata is queried through your authenticated gh session.
  3. Deterministic rules produce findings and scores.
  4. Launch materials cite observed evidence or retain an explicit placeholder.

The default audit is read-only. LaunchSmith does not run arbitrary repository commands, publish releases, post to communities, buy engagement, or automate stars.

Troubleshooting

Run LaunchSmith inside a Git repository

Change into the project root, or pass --cwd /path/to/repo.

GitHub checks are skipped

Authenticate the GitHub CLI and ensure the repository has a GitHub origin remote:

gh auth login
git remote -v

Local auditing still works with --no-github.

A launch pack already exists

Review the existing files first. Use --force only when replacement is intentional.

Development

npm test
node ./gh-launchsmith audit --no-github
node ./gh-launchsmith pack --no-github --output /tmp/launchsmith-pack

LaunchSmith has zero runtime dependencies and uses the Node.js standard library.

Roadmap

Contributing

See CONTRIBUTING.md. Bug reports should include the command, platform, Node.js version, and a redacted audit fixture when possible.

License

MIT

About

Evidence-first launch readiness for GitHub repositories — audit, prove, and package your open-source launch.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages