One-line result

GitHub API data + profile ops spec → README.md

Quick start

# Interactive setup (recommended for first-timers)
npx --yes [email protected]/github-profile-ops github-profile-ops <username> --interactive

# Preview before writing
npx --yes [email protected]/github-profile-ops github-profile-ops <username> --dry-run

# Write directly
npx --yes [email protected]/github-profile-ops github-profile-ops <username>

No install required. No API key. Works with any public GitHub account.

What it produces

Generated README includes:

• Animated typing header (capsule-render + readme-typing-svg)
• Auto-detected repo table (description, language — meta repos filtered)
• Stack badges from actual repo languages
• Stats & streak cards (toggleable)
• Contribution snake (optional)
• Color theme of your choice

How it works

fetchGitHubProfile(<username>)
  ↓
buildProfileOpsSpec()     ← same structure as prompt-ops-maker
  scope · verification gates · output constraints
  ↓
generateReadme(spec, opts)
  ↓
README.md

--show-spec to inspect the generated ops spec:

npx ... github-profile-ops <username> --show-spec

{
  "scope": "Generate a GitHub profile README for <username>",
  "gates": ["no_unverified_claims", "no_marketing_hype", "result_first", "no_secret_echo"],
  "output": { "format": "github_flavored_markdown", "style": "verification-first" }
}

Interactive mode

npx ... github-profile-ops <username> --interactive

Asks 4 questions:

1. Custom tagline (or use existing bio)
2. Color theme — Ocean Blue / Forest Green / Sunset Purple / Minimal Gray
3. Include Stats & Streak cards?
4. Include Contribution snake?

After generating, prints a step-by-step guide to activate the profile README on GitHub.

Options

| Flag | Description | |------|-------------| | --interactive, -i | Guided setup with questions | | --dry-run | Preview to stdout, no file written | | --show-spec | Print the profile ops spec as JSON | | --output=FILE | Write to FILE (default: README.md) |

Security boundary

• GitHub public API only. No authentication needed.
• No external LLM calls. All processing is local.
• File write: only the --output path. Default: README.md in current directory.
• no_secret_echo gate: tokens and internal paths are excluded from output.

Part of the verisworks-ai pipeline

prompt-ops-maker (write) → vibecodecheck (audit) → MCP servers (serve)
        ↑
github-profile-ops — profile README, same ops-spec structure

Requirements

• Node.js 18+
• Internet connection (GitHub API)

License

MIT — verisworks-ai