Skip to content

Phase 1: fix port/name inconsistencies, add --version - #2

Merged
melvincarvalho merged 1 commit into
gh-pagesfrom
issue-1-phase-1-fix-inconsistencies
May 15, 2026
Merged

melvincarvalho merged 1 commit into
gh-pagesfrom
issue-1-phase-1-fix-inconsistencies

Conversation

@melvincarvalho

Copy link
Copy Markdown
Contributor

Summary

Phase 1 of #1 — eliminate first-run friction caused by jspod's own internal inconsistencies. A new user following the README literally now lands on a working URL with correct branding.

  • Port: unify on 5444 across README and CLI (README documented 3000, code defaulted to 5444 → dead URL for new users)
  • Branding: replace 7 stale jssd references in index.js (help banner, examples, repo URLs, TOKEN_SECRET default) with jspod
  • Discoverability: add -v / --version flag (reads from package.json so it stays in sync)
  • Docs cleanup: remove broken jspod --verbose example from production-deploy section (flag never existed)
  • Version: bump jspod to 0.0.8

Acceptance criteria (from #1 phase 1)

  • npx jspod --help output matches what the README documents
  • URL printed at startup matches the URL the README tells users to open (http://localhost:5444)
  • grep -i 'jssd' . (excluding node_modules) returns nothing
  • --version flag added

Test plan

  • node index.js --version → jspod v0.0.8
  • node index.js -v → jspod v0.0.8
  • node index.js --help shows correct binary name, port, and version flag
  • node index.js --bogus errors cleanly with usage hint
  • node index.js --port 9999 --no-auth boots and shows correct URL in banner
  • grep -rn 'jssd' --include='*.js' --include='*.md' --include='*.json' . (excluding node_modules / lockfile) returns no matches

Not in scope

Phases 2-7 of #1 (demo-by-default, auto-open browser, seed content, visual assets, cross-repo, telemetry) — each will land as its own PR per the issue's "ship small" guidance.

Refs #1

- Unify default port on 5444 across README and CLI (was: README 3000 / code 5444)
- Replace 7 jssd references with jspod (help banner, examples, URLs, env var)
- Add -v/--version flag reading from package.json
- Remove broken --verbose example from production deploy section
- Bump jspod to 0.0.8

A new user following the README literally now hits a working URL, sees
the correct binary name in help output, and can query the version.

Refs #1
@melvincarvalho
melvincarvalho merged commit b713558 into gh-pages May 15, 2026
@melvincarvalho
melvincarvalho deleted the issue-1-phase-1-fix-inconsistencies branch May 15, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant