Sync GitHub Repo Metadata
Use the repository and its configuration as the source of truth. Treat the current README, docs, and existing GitHub metadata as weak hints unless they still match the codebase.
Workflow
- Gather repo facts.
- Read the current remote metadata with:
- gh repo view --json nameWithOwner,description,repositoryTopics,homepageUrl,url
- Infer:
- one concise repository description - a focused topic set based on actual language, framework, domain, and tooling
- Preview the current values, proposed values, and the exact
gh repo editcommand. - Apply changes only after explicit confirmation.
Guidelines
- Do not change homepage or other repo settings unless the user explicitly asks.
- Focus on GitHub description and topics only.
- Prefer a single-sentence description that matches the repo's real purpose.
- Prefer accurate, specific, stable topics over broad buzzwords.
- Prefixing description with an emoji is encouraged.
- Remove stale topics instead of only appending new ones.
- Use lowercase kebab-case topics.
Preview Format
- Current description
- Proposed description
- Current topics
- Proposed topics
- Exact
gh repo editcommand with--description,--add-topic, and--remove-topicarguments as needed
Apply Step
- Never apply blindly.
- After confirmation, run the exact previewed command.
- If authentication or permissions fail, report the command and the failure instead of guessing an alternative.