sync-description

Analyze a README and update the GitHub repository description via gh CLI.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/cameronsjo/dev-toolkit --skill sync-description
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-description
Source: https://github.com/cameronsjo/dev-toolkit/tree/main/skills/sync-description
Command: npx skills add https://github.com/cameronsjo/dev-toolkit --skill sync-description

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill updates the GitHub repository description by analyzing the README to extract the project purpose and differentiators, then applies a concise, accurate description via gh CLI.

Core Features & Use Cases

  • Analyze README to identify the project’s purpose, differentiators, and target use cases.
  • Generate a concise, action-oriented description and apply it to the repository using gh repo edit.
  • Compare current vs proposed descriptions and provide a change-ready summary.

Quick Start

Invoke the sync-description skill to analyze the README and apply a new GitHub description.

Frequently Asked Questions about sync-description

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update my GitHub repository description based on the README?

To update a GitHub repository description based on the README, analyze the README content to extract the project purpose and differentiators, then apply the generated description using the gh repo edit command.

What is the best way to sync GitHub descriptions with README insights?

Syncing GitHub descriptions with README insights involves extracting the project purpose and target use cases from the README, generating a concise action-oriented summary, and applying it to the repository via the gh CLI.

Do I need gh CLI installed to automate GitHub repository description updates?

Yes, you need gh CLI installed to automate GitHub repository description updates, along with a valid in-repo git context and the necessary repository permissions to modify the description settings.

Can I compare my current GitHub description with a newly generated one before applying changes?

Yes, you can compare your current GitHub description with a proposed one. The skill generates a concise description from README insights and provides a change-ready summary comparing the current versus proposed text before applying updates.

How does analyzing a README improve GitHub repository management?

Analyzing a README improves GitHub repository management by automatically extracting the project's core purpose and differentiators to create an accurate, concise description, ensuring the repository metadata consistently reflects the actual documentation.

What should I do if my GitHub description is not updating from the README content?

If your GitHub description is not updating, verify that gh CLI is installed, ensure you are operating within a valid in-repo git context, and confirm your user account has the explicit permission to modify the repository description.