github-profile-ops

Make a GitHub profile README in one command — powered by prompt-ops-maker verification gates.

한국어 · Quick start · How it works · Security

---

One-line result

GitHub username in → profile README.md out

github-profile-ops fetches public GitHub profile data, builds a small profile ops spec, then renders a profile README with interactive sections, stats cards, badges, and setup guidance.

Why this exists

GitHub profile README setup is confusing for first-time users:

create a repo with the exact username → make it public → add README.md → push/upload → verify profile page

This tool turns that into a guided flow.

Quick start

# Interactive setup — recommended for first-time users
npx --yes --package=@veris.works/github-profile-ops github-profile-ops <username> --interactive

# Preview before writing
npx --yes --package=@veris.works/github-profile-ops github-profile-ops <username> --dry-run

# Write README.md in the current directory
npx --yes --package=@veris.works/github-profile-ops github-profile-ops <username>

No install. No API key. Node.js 18+ only.

First-time GitHub setup

After the README is generated, the CLI prints the exact setup guide:

1. Go to https://github.com/new
2. Repository name must exactly match your GitHub username
3. Choose Public
4. Upload or commit README.md
5. Open https://github.com/<username> and verify the profile page

What it produces

Generated README includes:

Animated typing header
Auto-selected repository cards
Stack badges from real repo languages
Profile counter
Stats and streak cards
Optional contribution snake
Theme selector
Contact section

Interactive mode

npx --yes --package=@veris.works/github-profile-ops github-profile-ops <username> --interactive

Questions:

1. One-line tagline
2. Theme: Ocean Blue / Forest Green / Sunset Purple / Minimal Gray
3. Include Stats & Streak cards?
4. Include Contribution snake?

How it works

fetchGitHubProfile(<username>)
  ↓
buildProfileOpsSpec()
  scope · verification gates · output constraints
  ↓
generateReadme(spec, opts)
  ↓
README.md

Inspect the generated ops spec:

npx --yes --package=@veris.works/github-profile-ops github-profile-ops <username> --show-spec

Example 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" }
}

Options

Flag                 Result
────────────────────────────────────────────────────────────
--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 instead of README.md

Security boundary

GitHub data          Public API only
API key              Not required
LLM call             None
File write           Only --output path, default README.md
Secret handling      no_secret_echo gate; tokens are not requested
CI baseline          verisworks-ai reusable security workflow

Part of the verisworks-ai pipeline

prompt-ops-maker (write) → github-profile-ops (profile) → vibecodecheck (audit)
        ↓
MCP servers (serve structured checks)

Requirements

Node.js >= 18
Internet connection for GitHub public API

License

MIT — verisworks-ai