GitHub llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/github/llms-txt) # GitHub llms.txt Browse GitHub documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. github.com/llms.txt [Raw llms.txt](https://github.com/llms.txt) [Raw llms-full.txt](https://github.com/llms-full.txt) Copy Markdown [](https://github.com/llms.txt) llms.txt How to use Versions API Languages API Page List API Article API Article Body API Search API GitHub MCP server Building with GitHub, for coding agents and automation Extend Copilot Chat with MCP Use the GitHub MCP Server Set up the GitHub MCP Server About cloud agent Create custom agents in your IDE GitHub CLI Quickstart REST API GraphQL API GitHub Actions GitHub Copilot GitHub Copilot Copilot requests Individual plans Usage-based billing for individuals Usage-based billing for organizations and enterprises Usage limits Features Plans Quickstart What is GitHub Copilot? Copilot CLI best practices Install Copilot CLI Overview Add repository instructions Set up for students Get IDE code suggestions Preparing for usage-based billing Troubleshoot common issues Use code review Supported models Models and pricing Chat in GitHub Chat in GitHub Mobile GitHub Copilot Cookbook Get started Get started About remote repositories Ignoring files Manage remote repositories Set up Git GitHub's plans Types of GitHub accounts Start your journey About GitHub and Git Create an account Download files Hello World Docs versions Connectivity problems Basic formatting syntax Authentication Connect with SSH Add a new SSH key Check for existing SSH key Generate new SSH key Managing deploy keys Test your SSH connection Authentication to GitHub Manage personal access tokens Displaying verification for all commits Configure 2FA Configure 2FA recovery Recover an account with 2FA GitHub Pages GitHub Pages Configure a custom domain Custom domains in GitHub Pages Manage a custom domain Configure publishing source Create a GitHub Pages site What is GitHub Pages? Quickstart Add theme to Pages site Add content to Pages site Account and profile Account and profile Username changes How-tos Manage cookie preferences Troubleshoot missing contributions Primary email address Set commit email address Personalize your profile Repositories About rulesets About repositories Cloning a repository Quickstart for repositories About READMEs Licensing a repository About releases Apps About creating apps Writing code for a GitHub App Maintaining GitHub Apps Authorizing OAuth apps Authorize GitHub Actions Quickstart Understand GitHub Actions Workflow syntax Pull requests Compare branches About pull requests Fork a repository More pages GitHub Actions GitHub Models Configure security updates Codespaces Installation Prototype with AI models About Projects About GitHub Importer OAuth app restrictions Container registry Authenticating Permissions for fine-grained PATs Code search syntax ## What is GitHub's llms.txt? GitHub publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what GitHub offers and where to find details. Pass Spec 12 Sections 117 Links 28.1 KB Size ~7.2k Tokens Sections: How to use · Building with GitHub, for coding agents and automation · GitHub Copilot · Get started · Authentication · GitHub Pages · and 6 more ## Add GitHub Docs to Your AI Assistant Select your tool to see how to add GitHub's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://github.com/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about GitHub Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 2 notes ## Frequently Asked Questions Where is GitHub's llms.txt file? GitHub publishes its llms.txt at https://github.com/llms.txt. This file provides a structured, markdown-formatted index of GitHub's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use GitHub's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of GitHub's documentation so it can provide better code suggestions and answers about GitHub. What does GitHub's llms.txt contain? GitHub's llms.txt contains 12 sections and 117 documentation links in 28.1 KB (~7.2k tokens). Key sections include How to use, Building with GitHub, for coding agents and automation, GitHub Copilot, Get started, Authentication, GitHub Pages. How many tokens does GitHub's llms.txt use? The concise llms.txt index is approximately 7.2k tokens (28.1 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is GitHub? GitHub is a developer platform for building, shipping, and maintaining software. It provides cloud-based Git repository hosting, CI/CD via GitHub Actions, project management with Issues and Projects, code review via pull requests, AI-powered development with GitHub Copilot, and APIs (REST and GraphQL) for automation and integration.. GitHub's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with GitHub. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Heroku: Cloud Application Platform Heroku is an AI platform as a service (AI PaaS) that enables developers to build, run, and scale applications entirely in the cloud.](https://mdream.dev/llms-txt/github/llms-txt/heroku-cloud-application-platform) [TutorialEdge.net Practical, hands-on tutorials for software engineers covering Go, Python, JavaScript, cloud development, and computer science fundamentals. Written by Elliot Forbes, a software engineer and technical educator.](https://mdream.dev/llms-txt/github/llms-txt/tutorialedge-net) [CircleCI CircleCI is a cloud-native continuous integration and delivery (CI/CD) platform that enables software teams to automate build, test, and deployment workflows. The platform supports Docker, Linux, macOS, Windows, GPU, and Android environments for flexible, scalable execution across diverse application types.](https://mdream.dev/llms-txt/github/llms-txt/circleci) [Pinata Docs](https://mdream.dev/llms-txt/github/llms-txt/pinata-docs) [Aptabase Aptabase is an open-source, privacy-first analytics platform for Mobile, Desktop, and Web apps. It is GDPR-compliant by design - no cookies, no personal data, no IP tracking. Self-hostable or cloud-hosted. SDKs for 16+ platforms including Swift, Kotlin, Flutter, React Native, Electron, Tauri, .NET MAUI, Unity, Unreal, Python, and JavaScript (Web, React, Angular, Browser Extensions).](https://mdream.dev/llms-txt/github/llms-txt/aptabase) [Azure Azure is Microsoft's cloud computing platform, offering 200+ services for building, deploying, and managing applications. This file helps LLMs and coding agents understand how to build and deploy on Azure by providing links to key documentation as raw markdown files.](https://mdream.dev/llms-txt/github/llms-txt/azure) [OctoBot OctoBot is a cryptocurrency trading bot launched in 2018 by Drakkar Software, with its cloud-hosted version at `octobot.cloud` designed for simplicity and accessibility. OctoBot Cloud enables users to deploy pre-built or custom trading strategies on majors exchanges (e.g., Binance, KuCoin) without managing servers. Subscription plans - Investor (free), Investor Plus (paid), Pro (paid) and Elite (paid) offer escalating features like multi-bot support and TradingView integration. An open-source version (GPL-3.0) exists for self-hosting, offering customization via Python-based "tentacles."](https://mdream.dev/llms-txt/github/llms-txt/octobot) [Terragrunt Terragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.](https://mdream.dev/llms-txt/github/llms-txt/terragrunt) [View all 99 projects ](https://mdream.dev/llms-txt/github/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/github/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/github/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)