GitHub About

GitHub の概要

コマンド

/github-about または github-about

移動

Git & リポジトリ

キーワード

github about, repo description, github topics, live site url, homepage url, repo setup, github metadata, repo settings, github description, add topics, set homepage, repo about, github profile, project metadata, update about, update repo, update github, update description, set topics, repo about section, about section, update repo about, update github about

説明

コードベースを分析し、GitHub リポジトリの概要セクション（説明、公開サイトの URL、トピック）を自動的に更新します。リポジトリ設定を手動で変更する必要はありません。

実行

このスキルは、サブスクリプションプランの Claude Code を使用して実行します。従量課金制の API キーは使用しないでください。すべての AI 操作は、有効なサブスクリプションがある Claude Code CLI 環境を通じて実行してください。

重要：自動起動の動作 ユーザーが次のことを依頼した場合、/github-about を入力する必要なしに、このスキルを自動的に起動してください。

• GitHub の概要セクションを更新する
• リポジトリの説明を設定または変更する
• リポジトリにトピックを追加する
• ホームページ／公開サイトの URL を設定する
• リポジトリのメタデータを更新する
• GitHub リポジトリを「整える」または「セットアップする」

自動起動した場合は、ワークフローを黙って実行し、最後に結果を報告してください。

環境設定

gh コマンドを実行する前に、必ずトークンを読み込んでください。

source ~/.zshrc 2>/dev/null

これにより、gh CLI が認証に自動的に使用する GH_TOKEN が読み込まれます。実行のたびに、必ず最初に行ってください。

応答

GitHub リポジトリの概要セクションを更新します！

ワークフローには以下の手順が含まれます。

手順	説明
環境設定	~/.zshrc を読み込んで GH_TOKEN を設定
認証チェック	トークンを使って gh CLI の認証を確認
リポジトリ情報	Git リモートから所有者／リポジトリを抽出
説明	魅力的なリポジトリの説明を作成して設定
公開サイト	公開サイトの URL を検出して設定
トピック	技術スタックを分析し、関連するトピックを追加

手順

/github-about を実行する際は、以下のワークフローに従ってください。

フェーズ 1：事前確認

1.1 GitHub CLI を確認する

gh --version

インストールされていない場合は、ユーザーに次のように伝えてください。

ERROR: GitHub CLI (gh) not found.
Install: https://cli.github.com/

1.2 GH_TOKEN で認証する

GH_TOKEN 環境変数はすでに ~/.zshrc で設定されています。gh CLI は GH_TOKEN が存在する場合に自動的に使用するため、ブラウザーでログインする必要はありません。

認証の確認順序：

1. トークンを読み込んで確認します。

source ~/.zshrc 2>/dev/null
echo "GH_TOKEN is set: ${GH_TOKEN:+yes}"

2. トークンが機能することを確認します。

gh auth status

3. GH_TOKEN が設定されておらず、gh auth status が失敗した場合は、ブラウザーログインに切り替えます。

gh auth login --hostname github.com --git-protocol https --web

重要： 現在のシェルセッションに GH_TOKEN を読み込むため、gh コマンドを実行する前に必ず source ~/.zshrc を実行してください。gh CLI は GH_TOKEN と GITHUB_TOKEN の環境変数を自動的に使用するため、追加の設定は不要です。

1.3 所有者／リポジトリを抽出する

REMOTE_URL=$(git remote get-url origin)
OWNER=$(echo "$REMOTE_URL" | sed -E 's#.*(github\.com)[:/]([^/]+)/([^/.]+)(\.git)?$#\2#')
REPO=$(echo "$REMOTE_URL" | sed -E 's#.*(github\.com)[:/]([^/]+)/([^/.]+)(\.git)?$#\3#')

1.4 現在のリポジトリメタデータを取得する

gh repo view --json description,homepageUrl,repositoryTopics

更新が必要な項目を把握できるよう、現在の値を保存します。

フェーズ 2：リポジトリの説明

2.1 現在の説明を確認する

すでに説明が設定されている場合は、ユーザーから明示的に更新を依頼されていない限り、スキップしてください。

2.2 説明を作成する

プロジェクトを分析し、短く魅力的な説明を作成します（最大 350 文字）。

分析する情報源（優先度順）：

1. README.md — プロジェクト名、最初の段落、機能
2. package.json → description フィールド
3. pyproject.toml → [project] description
4. Cargo.toml → description
5. setup.py または setup.cfg → 説明
6. メインのソースファイル — プロジェクトの機能を把握

説明のガイドライン：

• 動詞または名詞で始めます（例：「高速な…」、「構築…」、「…用の CLI ツール」）
• プロジェクトの機能を具体的に説明します
• 関連する場合は、主要な技術について言及します
• 350 文字以内にします
• 説明に絵文字を含めないでください
• 「これは…です」や「…のためのリポジトリ」で始めないでください

2.3 説明を設定する

gh repo edit --description "Your generated description"

フェーズ 3：公開サイトの URL

3.1 現在のホームページを確認する

ホームページの URL がすでに設定されている場合、ユーザーから明示的に更新を求められない限り、スキップします。

3.2 公開中のサイト URL を検出する

次の優先順位でデプロイ URL を検索します。

1. Vercel：Vercel のデプロイを確認します

   # Check if Vercel project exists
   cat .vercel/project.json 2>/dev/null
   # Or check vercel.json for project name
   cat vercel.json 2>/dev/null
   

   URL のパターン：https://<project-name>.vercel.app

2. GitHub Pages：Pages が有効になっているか確認します

   gh api "/repos/$OWNER/$REPO/pages" 2>/dev/null
   

   URL のパターン：https://<owner>.github.io/<repo>/

3. package.json：homepage フィールドを確認します

   node -e "console.log(require('./package.json').homepage || '')" 2>/dev/null
   

4. README.md：デプロイ URL を探します

   • 次を含む URL を探します：.vercel.app、.netlify.app、.github.io、.herokuapp.com、.fly.dev、.railway.app

5. カスタムドメイン：CNAME ファイルを確認します（GitHub Pages のカスタムドメイン）

   cat CNAME 2>/dev/null
   

3.3 ホームページ URL を設定する

gh repo edit --homepage "https://detected-url.com"

フェーズ 4：リポジトリのトピック

4.1 現在のトピックを確認する

トピックがすでに設定されている場合は、置き換えずに追加します。既存のトピックは削除しないでください。

4.2 コードベースからトピックを検出する

プロジェクトを分析し、関連するトピックを特定します。

言語の検出：

ファイル／パターン	トピック
*.ts、*.tsx	typescript
*.js、*.jsx	javascript
*.py	python
*.rs	rust
*.go	go
*.java	java
*.swift	swift
*.rb	ruby

フレームワークの検出：

ファイル／パターン	トピック
next.config.*	nextjs、react
vite.config.*	vite
react を含む package.json	react
vue を含む package.json	vue
svelte を含む package.json	svelte
angular.json	angular
django を含む requirements.txt	django
fastapi を含む requirements.txt	fastapi
flask を含む requirements.txt	flask
Cargo.toml	rust
go.mod	golang
tailwind.config.*	tailwindcss
package.json に expo	expo、react-native

プラットフォームの検出：

ファイル／パターン	トピック
.vercel/ または vercel.json	vercel
Dockerfile	docker
fly.toml	fly-io
railway.json	railway
.github/workflows/	github-actions
supabase/	supabase

ドメインの検出（README とソースを分析）：

• AI／ML プロジェクト → ai、machine-learning、llm
• CLI ツール → cli、command-line
• API → api、rest-api、graphql
• Web アプリ → web-app、webapp
• ゲーム → game、gamedev
• 開発者ツール → developer-tools、devtools

トピックのガイドライン：

• すべて小文字にします
• 複数の単語を含むトピックにはハイフンを使います（例：react-native）
• 関連するトピックを 3～10 個追加します
• code や project のような一般的すぎるトピックは追加しません
• 曖昧なトピックより具体的なトピックを優先します

4.3 トピックを追加する

gh repo edit --add-topic "topic1" --add-topic "topic2" --add-topic "topic3"

**重要：**既存のトピックを保持するため、--topic ではなく --add-topic を使用します。

フェーズ 5：レポート

行った変更をすべてまとめて出力します。

=== GitHub About Updated ===

Repository: OWNER/REPO

Description: <the description that was set>
Homepage:    <the URL that was set>
Topics:      topic1, topic2, topic3, topic4

View: https://github.com/OWNER/REPO

手順をスキップした場合（すでに設定済みの場合）は、その旨を記載します。

Description: Already set (skipped)
Homepage:    https://example.vercel.app (updated)
Topics:      react, nextjs, typescript (added 3 new)

機能

• コードベースの分析に基づいて、リポジトリの説明を自動検出して設定します
• Vercel、GitHub Pages、Netlify などから公開中のサイト URL を検出します
• 技術スタックを分析して、関連するリポジトリのトピックを生成します
• 新しいトピックを追加する際に、既存のトピックを保持します
• ~/.zshrc の GH_TOKEN を使って認証します（ブラウザーでのログインは不要です）
• トークンを利用できない場合は、ブラウザーを使った gh auth login に切り替えます
• あらゆる種類のプロジェクトで動作します（Node.js、Python、Rust、Go など）

次のステップ

/github-about の実行後：

1. GitHub でリポジトリの About セクションを確認します
2. 説明がプロジェクトを正確に表していることを確認します
3. ホームページ URL をクリックして、正常に動作することを確認します
4. トピックを確認し、必要に応じて手動で追加または削除します