home-dashboard: Instructions file for Codex

AGENTS.md

home-dashboard AGENTS.md is an instructions file for Codex, OpenCode from kyleturman/home-dashboard. It costs 991 tokens per session, scanned A, original, MIT.

Project instructions for a home dashboard that gathers information from services, caches it, renders it as HTML, and turns it into a simple image for an e-ink display.

In plain words
What is it for?
Use them when adding or changing dashboard services, cache behavior, data assembly, image output, or service-specific tests.
Why use it?
They explain how data flows through the application so changes use the existing service, caching, and testing patterns.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

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

Reuse

Borrowing it

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

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 home-dashboard AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/kyleturman/home-dashboard/agents-md.svg)](https://agentmods.dev/instructions/kyleturman/home-dashboard/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/kyleturman/home-dashboard/agents-md"><img src="https://agentmods.dev/badge/instructions/kyleturman/home-dashboard/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 991 This file is loaded in full into every session.
When invoked 991 The same file — it is already loaded in full.
Security scan A 1 finding. 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.00991 $0.00991
Opus 5 $0.00495 $0.00495
Sonnet 5 $0.00198 $0.00198
Haiku 4.5 $0.00099 $0.00099

Measured 8d ago against content hash 4700b835d270, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

home-dashboard AGENTS.md scanned grade A with 1 finding 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 8d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl http://localhost:<PORT>/api/services/status
AGENTS.md · 105 lines

How it starts

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

Agent Developer Guide

This application uses different services to collect data and display insights on a dashboard sent to an e-ink display. It renders the dashboard in HTML and CSS and then converts it to a 1-bit PNG image which is retrieved by the display every 10~ minutes. This project is meant to be open source and easy to follow, modular, and customizable.

Architecture Overview

Node and Express This application is built using Node.js and Express.js.

Service-Based Architecture: All data services extend BaseService (lib/BaseService.js) which provides automatic caching, retry logic with exponential backoff, stale cache fallback, and status tracking. All services are located in services/ directory.

Data Flow:

  1. Enabled services are called in lib/dataBuilder.js.
  2. Service data is either fetched from the API or retrieved from the cache using lib/state.js.
  3. New service data is cached, each service has its own cache TTL.
  4. Data is built in lib/dataBuilder.js.
  5. Data is sent to the dashboard.

State Management: Centralized in lib/state.jsdata/state.json. All service caches and status are stored here. Use getStateKey(), setStateKey(), updateState().

Routes: All routes are defined in routes.js. Here are the key routes:

  • /dashboard - Dashboard HTML used for development
  • /dashboard/image - 1-bit PNG image sent to e-ink display
  • /admin - Admin page for auth and monitoring
  • /api/dashboard - Returns dashboard data in JSON format
  • /api/services/status - Returns status of all services

OAuth: Visit /admin to re-authenticate. Tokens are stored in data/auth.json.

PM2: This application is run as a PM2 daemon. Use npm start, npm stop, npm restart to manage it.

Views: Views are located in views/ directory, built using EJS templates. Relevant styles are in views/styles/ directory.

Code Style

  • Use best practices for JavaScript, CSS, and HTML. Follow the style of the existing code.
  • Keep code DRY and avoid unnecessary code duplication or complex logic.
  • Organize code into logical groupings, files, and directories as needed, but DO NOT over-engineer or over-architect.
  • Use comments to make key logic and decisions clear for an open source audience.
  • Update README.md as needed, do not create separate documentation.

Read the full file on GitHub · 105 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. 8d ago First seen · 105 lines · 991 tokens per session scan A 4700b835d270

Subscribe to this mod's changes

home-dashboard AGENTS.md is an instructions file published in the GitHub repository kyleturman/home-dashboard (301 stars, last pushed 11mo ago), licensed MIT. It adds 991 tokens to every session, about $0.0050 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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

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

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

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

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

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