qdoc: Instructions file for Codex

AGENTS.md

qdoc AGENTS.md is an instructions file for Codex, OpenCode from ibrhr/qdoc. It costs 3,453 tokens per session, scanned A, original, MIT.

Repository instructions for qdoc, a command-line and terminal interface tool that retrieves documentation for software libraries. They describe how to build, test, verify, document, and understand the project's structure.

In plain words
What is it for?
Use them when changing qdoc code, its documentation site, or its dependencies. They cover Go build and test commands, documentation-site commands, and the dependency structure.
Why use it?
They give a coding agent project-specific rules and commands instead of making it guess how the repository works. This helps avoid broken builds, missed tests, and architecture mistakes.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex.

This is ibrhr/qdoc's own configuration. It tells Codex and OpenCode how to work on qdoc itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything qdoc configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ibrhr/qdoc. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/ibrhr/qdoc/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/ibrhr/qdoc

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for qdoc AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ibrhr/qdoc/agents-md/github.svg)](https://agentmods.dev/instructions/ibrhr/qdoc/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/ibrhr/qdoc/agents-md"><img src="https://agentmods.dev/badge/instructions/ibrhr/qdoc/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for qdoc AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ibrhr/qdoc/agents-md"><img src="https://agentmods.dev/badge/instructions/ibrhr/qdoc/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,453 This file is loaded in full into every session.
When invoked 3,453 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.03453 $0.03453
Opus 5 $0.01726 $0.01726
Sonnet 5 $0.00691 $0.00691
Haiku 4.5 $0.00345 $0.00345

Measured 4d ago against content hash 3c7af07cfce7, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

qdoc AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 239 lines

How it starts

The opening of the file, as written. The whole thing — 239 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md — qdoc

qdoc - Query the Docs — qdoc is a tui/cli that you or your coding agent can use to get fast, accurate, relevant, and up-to-date information about any library or framework you're using!

Build & verify

export PATH=$PATH:/usr/local/go/bin  # Go 1.26.3 lives here
go build ./...   # builds all packages
go vet ./...
go test ./...    # runs all tests
go test -race ./...

Docs site

cd docs
npm install
npx vitepress dev    # http://localhost:5173
npx vitepress build  # output: docs/.vitepress/dist/

The docs site is built with VitePress v1.6+. Config at docs/.vitepress/config.ts.

Architecture

Module path: github.com/ibrhr/qdoc

main.go                          # CLI routing + print commands
internal/
  config/
    config.go                    # Config struct, load, save, configPath
  auth/
    auth.go                      # Token, AuthMethod interface, ProviderInfo, AuthStatus, ForProvider
    token_store.go               # TokenStore — disk-backed token persistence, IsExpired
    device_flow.go               # DeviceFlowAuth — GitHub Copilot device flow OAuth
    pkce.go                      # PkceAuth — PKCE OAuth (OpenAI ChatGPT subscription)
  provider/
    provider.go                  # Provider, AccessMethod structs, registry, Find, ResolveClient, error types
    providers.json               # Provider registry data
  retry/
    retry.go                     # Shared retry Config, BackoffDelay, IsRetryableHTTP/Error
  llm/
    client.go                    # Client (OpenAI-compat), NewClient, Send(), Stream()
    codex_client.go              # CodexClient — OpenAI Codex Responses API (SSE stream)
    prompt.go                    # BuildSystemPrompt()
    parse.go                     # ParsedAction, ParseResponses()
    types.go                     # ChatMessage, StreamDelta, Streamer interface, Config
  docsource/
    source.go                    # Source, Entry, KnownSources, Find, fetch methods, retryableHTTPGet
    html.go                      # extractLinks, extractMainContent (unexported HTML helpers)
  runner/
    runner.go                    # Headless query runner (--no-tui, --json)
  tui/
    model.go                     # Model struct, phase/state types, constructors (New*), Init
    update.go                    # Update + query-mode handlers + streaming pipeline
    setup.go                     # Setup update handlers + setup view renderers
    view.go                      # View + query-mode rendering (header, progress, content, footer)
    styles.go                    # Theme colors + lipgloss styles + spinner
    render.go                    # renderMarkdown, renderInlineMarkdown, wordWrap
    messages.go                  # All tea.Msg types (docIndexMsg, streamDeltaMsg, etc.)
  sessionlog/
    log.go                       # Session logging to ~/.config/qdoc/logs/ (per-query .log files)

Read the full file on GitHub · 239 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 239 lines · 3,453 tokens per session scan A 3c7af07cfce7

Subscribe to this mod's changes

qdoc AGENTS.md is an instructions file published in the GitHub repository ibrhr/qdoc (2 stars, last pushed 8d ago), licensed MIT. It adds 3,453 tokens to every session, about $0.0173 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-05.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens