What is react-nprogress AGENTS.md?

Project instructions for coding agents working on a TypeScript React library that provides a slim progress bar's logic. They describe the project, commands, coding standards, and comment rules.

Use them when developing, testing, formatting, building, or reviewing the react-nprogress library.

They give agents the project-specific rules they need before changing code, reducing guesswork and inconsistent edits.

How tanem/react-nprogress configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to tanem/react-nprogress. 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/tanem/react-nprogress/master/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/tanem/react-nprogress

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/tanem/react-nprogress/agents-md/github.svg)](https://agentmods.dev/instructions/tanem/react-nprogress/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/tanem/react-nprogress/agents-md"><img src="https://agentmods.dev/badge/instructions/tanem/react-nprogress/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/tanem/react-nprogress/agents-md"><img src="https://agentmods.dev/badge/instructions/tanem/react-nprogress/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,256 This file is loaded in full into every session.

When invoked 1,256 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.

Model	Per session	Once invoked
Fable 5.1	$0.01256	$0.01256
Opus 5.5	$0.00502	$0.00502
Sonnet 5.5	$0.00251	$0.00251
Haiku 4.5	$0.00126	$0.00126

Measured 1mo ago against content hash c0191496b593, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

react-nprogress 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 1mo 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 · 65 lines

How it starts

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

Agent Instructions for react-nprogress

Keep this file short. Only add what changes agent behaviour and cannot be inferred from the codebase or tooling.

Headless React progress bar logic, exposed as the useNProgress hook and the NProgress render-props component. There are no runtime dependencies: React and React DOM are peers.

Commands

npm run test:src  # source-only tests with coverage: the development loop
npm run format    # fix lint and formatting
npm test          # full suite: checks, lint, build, size gate, every test:*

Run npm test before finishing a change.

Conventions

Comments: // line comments only, never /* */ or /** */. Explain why, not what. Wrap at 80 characters and end with a full stop.
Use New Zealand English ("colour", "behaviour") in prose, comments, and identifiers. Standardised API names such as color stay as they are.
Commits: capitalised imperative subject of at most 50 characters with no type prefix and no trailing full stop, then a blank line and a body wrapped at 72. PR titles are plain sentences too, since they become the release notes.
Pin devDependencies to exact versions. Renovate manages updates: do not add allowedVersions to renovate.json without a documented reason.
Strict semver: a breaking change, including a technical refactor, needs a major bump and a MIGRATION.md entry under that major's heading, describing the change and the action required.
Update related docs (README.md, MIGRATION.md, example READMEs) in the same change as the code.
Do not modify CHANGELOG.md. It is frozen as of v7.1.0. Later history lives on GitHub Releases.

Testing

src requires 100% coverage. Only npm run test:src collects it, and no coverageThreshold is configured, so a drop does not fail the run: read the report.
test:cjs, test:es and test:bundles run against dist and need a build first. npm test builds before running them.
A new spec that reads dist belongs in scripts/jest/config.bundles.js, not alongside the source specs. test:src and the React matrix must stay runnable without a build.
size-limit gates the gzipped size of both bundles, with the limits in package.json. Only raise a limit when the added size is intended.

Read the full file on GitHub · 65 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.

1mo ago Changed · -124 lines · -640 tokens per session c0191496b593
2mo ago First seen · 189 lines · 1,896 tokens per session scan A 5861816db94a

Subscribe to this mod's changes

react-nprogress AGENTS.md is an instructions file published in the GitHub repository tanem/react-nprogress (466 stars, last pushed 2d ago), licensed MIT. It adds 1,256 tokens to every session, about $0.0050 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.

Frontend React animation component higher-order-component hoc hook hooks

react-nprogress AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
react-nprogress AGENTS.mdtanem/react-nprogress	Instructions file	466	2d ago	MIT	A	1,256	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

react-nprogress: Instructions file for Codex