hype AGENTS.md

Repository instructions for Hype, a Go project with a command-line program, documentation templates, examples, and tests. The guide describes its folders, build commands, formatting rules, and test command.

In plain words
What is it for?
They help build and install the Hype command-line program, run its tests, regenerate documentation, inspect command options, and follow the project’s Go conventions.
Why use it?
They make the project’s structure and expected development checks explicit. This helps an agent avoid putting code in the wrong package or skipping race, coverage, and other test checks.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/gopherguides/hype/agents-md
Clone the repo
git clone --depth 1 https://github.com/gopherguides/hype

Made for: Codex, OpenCode.

Per session 552 This file is loaded in full into every session.
When invoked 552 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00552 $0.00552
Opus 5 $0.00276 $0.00276
Sonnet 5 $0.00110 $0.00110
Haiku 4.5 $0.00055 $0.00055

Measured 2d ago against content hash 96bd0ed261ae, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

hype 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 2d 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 · 26 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

Core packages live at repo root (e.g., element.go, parser.go) and follow Go's standard package-per-file pattern, each paired with *_test.go. The CLI wrapper sits in cmd/hype, which builds the hype binary. Content templates and examples live under docs/, mdx/, and slides/, while reusable fixtures are stored in testdata/. Helper utilities and adapters reside in internal/ plus feature-specific subfolders such as atomx/ and binding/.

Build, Test, and Development Commands

  • make test: runs go test -count 1 -race -vet=off -cover across all packages except generated docs.
  • make build: produces a local hype binary from cmd/hype/.
  • go run ./cmd/hype --help: inspect CLI options without installing.
  • make docs or make hype: regenerate README.md from hype.md; run after changing documentation templates.
  • go install ./cmd/hype: install the CLI into your $GOBIN for reuse in other projects.

Coding Style & Naming Conventions

Use Go 1.25+ features conservatively and keep compiler warnings at zero. Format code via gofmt (tabs for indentation, blank lines between logical sections) and lint with revive using revive.toml. Exported identifiers should read like Parser, ExecuteError, while private helpers stay lowerCamel. Keep package boundaries focused; avoid cyclic imports by adding shared helpers to internal/.

Testing Guidelines

Unit tests mirror their source files (e.g., figure_test.go) and should cover happy paths plus failure parsing cases. Add integration coverage for the CLI in cli_integration_test.go when touching command behavior. Run make cov to inspect HTML coverage locally and target meaningful assertions rather than snapshot dumps. Table-driven tests are preferred; name cases with short strings describing the scenario. All new features require a failing test before implementation when practical.

Commit & Pull Request Guidelines

Read the full file on GitHub · 26 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. 2d ago First seen · 26 lines · 552 tokens per session scan A 96bd0ed261ae

Subscribe to this mod's changes

hype AGENTS.md is an instructions file published in the GitHub repository gopherguides/hype (56 stars, last pushed 5mo ago), licensed MIT. It adds 552 tokens to every session, about $0.0028 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-08-30.

Related

Other instructions, from other repositories

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,182 tokens

buildNext

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

next.js 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

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

spec-kit AGENTS.md

Instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,040 tokens

langchain 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,345 tokens