# effect-gh

> An Effect v4 SDK for the GitHub CLI.

## Docs

- [Overview](https://effect-gh.timmo.dev/): An Effect v4 SDK for the GitHub CLI.
- [Install](https://effect-gh.timmo.dev/install): Install effect-gh with Bun or Node and authenticate the GitHub CLI.
- [Core SDK](https://effect-gh.timmo.dev/core): The Gh service, its layer, options, errors and cancellation.
- [API requests](https://effect-gh.timmo.dev/api): REST and GraphQL requests, pagination, conditional requests, retries and rate limits.
- [GitHub operations](https://effect-gh.timmo.dev/github): The typed operations for repositories, issues, pull requests, workflows, reviews and more.
- [Agents](https://effect-gh.timmo.dev/agents): The effect-gh agent skill and the OpenCode plugin.
- [Development](https://effect-gh.timmo.dev/development): Run the checks, review gh tooling drift and release the package.

## Agent skills

- [effect-gh](https://effect-gh.timmo.dev/.well-known/agent-skills/effect-gh/SKILL.md): Read the effect-gh docs instead of answering from memory. An Effect v4 SDK for the GitHub CLI. Use when a task involves effect-gh: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://effect-gh.timmo.dev/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://effect-gh.timmo.dev/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://effect-gh.timmo.dev/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://effect-gh.timmo.dev/openapi.json.
- [MCP server](https://effect-gh.timmo.dev/mcp): Streamable HTTP Model Context Protocol server with search_docs, get_page, list_pages, and get_navigation tools, plus every page as a resource. Discovery document: https://effect-gh.timmo.dev/.well-known/mcp.json
- [Agent skills](https://effect-gh.timmo.dev/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://effect-gh.timmo.dev/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://effect-gh.timmo.dev/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://effect-gh.timmo.dev/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://effect-gh.timmo.dev/sitemap.xml): Every indexable page URL with its last-modified date.