hypershift: Instructions file for Codex

AGENTS.md

hypershift AGENTS.md is an instructions file for Codex, OpenCode from openshift/hypershift. It costs 1,220 tokens per session, scanned A, original, Apache-2.0.

A set of instructions for coding agents working on HyperShift, software that runs OpenShift control planes separately from worker machines. It points to the project’s architecture, development, API, and documentation guidance.

In plain words
What is it for?
Use it when changing HyperShift code, APIs, control-plane components, or project documentation.
Why use it?
It helps agents understand the repository and avoid missing related documentation or platform-specific rules.

Instructions file for CodexOpenCode

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

This is openshift/hypershift's own configuration. It tells Codex and OpenCode how to work on hypershift 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 hypershift configures →

Reuse

Borrowing it

Nothing to install: this file belongs to openshift/hypershift. 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/openshift/hypershift/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/openshift/hypershift

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 hypershift AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/openshift/hypershift/agents-md/github.svg)](https://agentmods.dev/instructions/openshift/hypershift/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/openshift/hypershift/agents-md"><img src="https://agentmods.dev/badge/instructions/openshift/hypershift/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 hypershift AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/openshift/hypershift/agents-md"><img src="https://agentmods.dev/badge/instructions/openshift/hypershift/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,220 This file is loaded in full into every session.
When invoked 1,220 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.01220 $0.01220
Opus 5.5 $0.00488 $0.00488
Sonnet 5.5 $0.00244 $0.00244
Haiku 4.5 $0.00122 $0.00122

Measured yesterday against content hash 54a88ebc51b3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

hypershift 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 yesterday.

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 · 47 lines

How it starts

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

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository. CLAUDE.md is a symlink to this file so that Claude Code auto-loads it; the AGENTS.md name is canonical.

HyperShift is middleware for hosting OpenShift control planes at scale, decoupling control planes (running as pods on a management cluster) from worker nodes (running in separate infrastructure).

This file is intentionally minimal — detailed guidance lives in the referenced files below and should be updated there, not here.

For architecture, components, and platform support, see ARCHITECTURE.md.

Project documentation is published via MkDocs. The site structure and navigation are defined in docs/mkdocs.yml, with content under docs/content/. When adding or reorganizing documentation pages, update the nav section in mkdocs.yml to keep the site navigation in sync.

Key References

Topic Where to look
Development commands and patterns DEVELOPMENT.md
API types and CRD machinery api/AGENTS.md
Control plane components (CPOv2) support/controlplane-component/AGENTS.md and support/controlplane-component/README.md
Control plane operator control-plane-operator/AGENTS.md
HC/HCP status patching control-plane-operator/AGENTS.md — never Status().Update()/unguarded MergeFrom() on HC/HCP; actively enforced by hcpstatuspatch; use support/statuspatching
E2E v2 test framework test/e2e/v2/AGENTS.md
Envtest (CEL validation tests) test/envtest/README.md — YAML-driven, runs across k8s 1.31–1.37, supports feature gate filtering
CEL over webhooks .claude/rules/webhook-validation.md
Restructuring commits skills/restructure-commits/SKILL.md — component-based commit layout; verify with make verify-commit-layout
Code formatting DEVELOPMENT.md — code quality commands and conventions
Unit test conventions TESTING.md — naming, placement, and creation requirements
Design invariants docs/content/reference/goals-and-design-invariants.md
Versioning and support docs/content/reference/versioning-support.md
Upgrades lifecycle docs/content/how-to/upgrades.md
Contributing and PR workflow CONTRIBUTING.md
Agentic SDLC framework docs/content/how-to/agentic-sdlc.md
Feature gates docs/content/how-to/feature-gates.md — two separate systems: management cluster gates vs hosted cluster gates
Pre-commit hooks docs/content/contribute/precommit-hook-help.md

Read the full file on GitHub · 47 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. yesterday Changed · +1 lines · +47 tokens per session 54a88ebc51b3
  2. 27d ago Changed 60f331a913b3
  3. 1mo ago Changed · +13 tokens per session 049df53ced4b
  4. 1mo ago Changed · +1 lines · +63 tokens per session 1e359252958c
  5. 1mo ago First seen · 45 lines · 1,097 tokens per session scan A 8b2488619407

Subscribe to this mod's changes

hypershift AGENTS.md is an instructions file published in the GitHub repository openshift/hypershift (548 stars, last pushed today), licensed Apache-2.0. It adds 1,220 tokens to every session, about $0.0049 per session on Opus 5.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

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 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 · 4,261 tokens