What is gentelella AGENTS.md?

Project instructions for coding agents working on the Gentelella v4 admin dashboard template. They explain what the project is, how it is organized, and which commands it uses.

Use them when modifying pages, source files, styles, or build configuration in the Gentelella repository.

They give coding tools the project context needed to make compatible changes and run the right development or build commands.

How ColorlibHQ/gentelella configures Codex and OpenCode

About the project

Gentelella is a free admin dashboard template built with vanilla JavaScript, SCSS, and Vite, providing ready-made pages and interface components for web-based administration panels. It is intended for SaaS dashboards, CRM systems, internal tools, e-commerce backends, and project management applications.

ColorlibHQ/gentelella · 21,557 stars · on GitHub · gentelella.colorlib.com

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/ColorlibHQ/gentelella

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/colorlibhq/gentelella/agents-md/github.svg)](https://agentmods.dev/instructions/colorlibhq/gentelella/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/colorlibhq/gentelella/agents-md"><img src="https://agentmods.dev/badge/instructions/colorlibhq/gentelella/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/colorlibhq/gentelella/agents-md"><img src="https://agentmods.dev/badge/instructions/colorlibhq/gentelella/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,591 This file is loaded in full into every session.

When invoked 2,591 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.02591	$0.02591
Opus 5.5	$0.01036	$0.01036
Sonnet 5.5	$0.00518	$0.00518
Haiku 4.5	$0.00259	$0.00259

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

Security

Grade A, and why

gentelella 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 · 176 lines

How it starts

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

AGENTS.md

Cross-tool agent instructions for Gentelella v4. Read by Aider, Cline, Codex, Continue, and any tool following the agents.md convention. Claude Code reads CLAUDE.md; Cursor reads .cursor/rules/; GitHub Copilot reads .github/copilot-instructions.md. Content is intentionally overlapping — each tool only sees its own file.

What this is

Gentelella v4 (4.2.0) — free admin dashboard template by Colorlib. 58 server-rendered HTML pages in production/, built with Vite 8 (Rolldown). Vanilla ES2022, no Bootstrap, no jQuery, no SPA framework. SCSS only. Heavyweight runtime deps are limited to ECharts 6, DataTables.net 3, and Leaflet 1.9 — all lazy-imported per page.

Live preview: https://preview.colorlib.com/theme/gentelella/.

Setup

npm install
npm run dev               # Vite dev server on :9173 → opens /production/index.html

Build / preview / deploy:

npm run build             # → dist/
npm run preview           # serve built dist/ on :9174
npm run deploy:preview    # build + sync to R2 with cache headers

Architecture

Single entry src/main-v4.js. Imports scss/v4/main.scss, mounts the shell, runs initCharts/initTables/initCommandPalette/initPageActions, then lazy-imports page-specific modules guarded by DOM presence (if (document.getElementById('inbox-root')) import(...)).
Shell injection at build time. vite.config.js's shellInjectionPlugin inlines sidebar/topbar/footer into every page whose body has data-shell="admin". No FOUC. Runtime src/v4/shell.js mountShell() is a fallback for opening raw HTML.
Auto-discovered entries. discoverEntries() in vite.config.js walks production/*.html and registers each as a Rollup input. No hand-maintained input list.
Three lazy vendor chunks: vendor-echarts (chart pages), vendor-tables (table pages), vendor-maps (map page). Everything else ships in the main chunk.
NAV is one constant. NAV in src/v4/shell-render.js, 7 groups. Pages match into NAV by data-page ↔ leaf key.
Theming via CSS custom properties. Tokens in src/scss/v4/_tokens.scss under :root and [data-theme="dark"]. Pre-paint inline script (in the Vite plugin) sets data-theme on <html> from localStorage before body renders.
PWA. Service worker registered only in import.meta.env.PROD. site.webmanifest + meta tags injected into every page by the Vite plugin. Subpath-safe: paths use import.meta.env.BASE_URL.

Read the full file on GitHub · 176 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 7120ab74718e
2mo ago First seen · 176 lines · 2,591 tokens per session scan A 3e727e14382c

Subscribe to this mod's changes

gentelella AGENTS.md is an instructions file published in the GitHub repository ColorlibHQ/gentelella (21,557 stars, last pushed 6d ago), licensed MIT. It adds 2,591 tokens to every session, about $0.0104 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.

admin-dashboard bootstrap colorlib dashboard html html-template

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

gentelella: Instructions file for Codex