القائمة
Fetch the README content from a GitHub repository. Use when the user asks for a repository README, documentation, or wants to read the repo's main documentation file.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | github-readme |
| description | Fetch the README content from a GitHub repository. Use when the user asks for a repository README, documentation, or wants to read the repo's main documentation file. |
Fetch and decode the README content from a GitHub repository.
npx tsx scripts/readme.ts <repository> [options]
| Argument | Required | Description |
|---|---|---|
repository | Yes | Repository in format owner/repo or full GitHub URL |
| Option | Description |
|---|---|
--token=TOKEN | GitHub Personal Access Token (optional, overrides GITHUB_TOKEN env var) |
--no-cache | Bypass cache and fetch fresh data from API |
README.md from facebook/react
-----------------------------
Size: 12.3 KB
URL: https://github.com/facebook/react/blob/main/README.md
# README Contents
[decoded README content displayed here]
npx tsx scripts/readme.ts <repository> [options]
Options:
--token=TOKEN - GitHub Personal Access Token (optional, overrides GITHUB_TOKEN env var)--no-cache - Bypass cache and fetch fresh data from APIRun from the github-api plugin directory: ~/.claude/plugins/cache/github-api/
GET https://api.github.com/repos/{owner}/{repo}/readme
| Parameter | Required | Description |
|---|---|---|
owner | Yes | Repository owner (user or organization) |
repo | Yes | Repository name |
Get README content:
https://api.github.com/repos/facebook/react/readme
The response contains README metadata and base64-encoded content:
name - README filename (e.g., "README.md")path - Path to the READMEsha - Git SHA for the filesize - File size in bytesurl - API URL for the filehtml_url - GitHub URL to view the READMEcontent - Base64-encoded contentencoding - Encoding type (always "base64")GitHub automatically detects and prioritizes README files in this order:
README.mdREADME.markdownREADME.rstREADME.asciidocREADME.textileREADME.creoleREADMEThe API returns the first matching file found.
The script accepts various URL formats:
owner/repo (simple format)https://github.com/owner/repogit+https://github.com/owner/repogit@github.com:owner/repossh://git@github.com/owner/repoREADME access follows GitHub visibility rules:
repo scope requiredTo access private repositories, provide a GitHub Personal Access Token:
Via environment variable:
export GITHUB_TOKEN=your_token_here
npx tsx scripts/readme.ts private/repo
Via command-line option:
npx tsx scripts/readme.ts private/repo --token=your_token_here
README content is cached for 1 hour. READMEs change relatively infrequently, so this provides a good balance between freshness and performance.
Use the --no-cache flag to bypass the cache.
github-repo to get repository metadatagithub-user to get owner profile informationgithub-rate-limit to check your remaining API quotaNo README found: Not all repositories have READMEs. The API will return 404 if no README file exists.
Repository not found: Verify the owner and repository name are correct.
Private repository: Authentication required for private repositories. Provide a valid token.
Rate limit exceeded: Use a Personal Access Token for higher rate limits.
Read package documentation from source:
npx tsx scripts/readme.ts facebook/react
npx tsx scripts/readme.ts vercel/next.js
Get quick reference for a repository:
npx tsx scripts/readme.ts nodejs/node
Access private repository documentation:
npx tsx scripts/readme.ts mycompany/private-repo --token=$GITHUB_TOKEN
Use when the user needs help with path queries, JSON transformations, schema validation, or safe JSON editing workflows. Triggered by questions about JSON operations, data extraction, file merging, or validation strategies.
Scan project dependencies for known vulnerabilities. Automatically detect and parse package files (package.json, requirements.txt, Gemfile, go.mod, pom.xml) and check all dependencies against the CVE database. Use when you want to audit a project for security vulnerabilities, check if dependencies have known CVEs, or generate a vulnerability report for compliance.
Search for Common Vulnerabilities and Exposures (CVEs) by ID (e.g., CVE-2024-1086) or by product name (e.g., OpenSSL, Apache Tomcat). Get detailed vulnerability information including severity scores, affected software versions, and references. Use when the user wants to look up CVE information, check if a product has known vulnerabilities, or research security issues.
Validate a JSON file against the schema referenced in its $schema property. Use when the user asks to check JSON against its own schema, validate self-describing JSON, auto-validate JSON files, or verify JSON with embedded schema reference.
Validate JSON data against a JSON Schema. Use when the user asks to validate JSON against a schema, check if JSON conforms to a schema, test JSON data validity, or verify JSON structure matches a schema definition.
Validate that a JSON Schema is well-formed and conforms to the JSON Schema specification. Use when the user asks to check if a schema is valid, verify schema syntax, validate schema structure, or check a JSON Schema file for errors.