What is whiteboard AGENTS.md?

A set of instructions for coding agents working on Whiteboard, a project that installs software, runs checks, and creates short demonstration videos.

Use it when setting up Whiteboard from a fresh clone, resuming a project, running offline checks, or generating a 30-second demo.

It gives an agent clear safety rules, required inputs, and a reliable installation sequence without exposing secret keys or overwriting protected outputs.

How shaomingchan/whiteboard configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to shaomingchan/whiteboard. 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/shaomingchan/whiteboard/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/shaomingchan/whiteboard

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

Your own site

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

Per session 586 This file is loaded in full into every session.

When invoked 586 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.00586	$0.00586
Opus 5.5	$0.00234	$0.00234
Sonnet 5.5	$0.00117	$0.00117
Haiku 4.5	$0.00059	$0.00059

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

Security

Grade A, and why

whiteboard 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 2mo 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 · 74 lines

How it starts

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

Agent Guide

This is the canonical entry point for Codex, Claude Code, OpenClaw, and other coding agents.

Objective

Install the project from a fresh clone, request only the required secrets, run the offline checks, generate the 30-second demo, and report verifiable output paths and metrics.

Guardrails

Never print, commit, or echo complete API keys.
Never stage auto-whiteboard/config/config.ini, skills/whiteboard-video-workflow/.env, output/, or user transcripts unless explicitly requested.
Preserve the locked production defaults in README.md.
Reuse an existing --project-dir when resuming; do not regenerate expensive stages without a reason.
Treat scripts/ as the canonical public interface. Do not use historical commands from old commits or generated reports.

Required Inputs

For video generation, ask for:

A MiniMax or 302.AI-compatible TTS key.
One supported image-provider key.

For cover generation, also ask for a 302.AI key stored as AI302_KEY. Claude is optional and is not required by the default workflow.

Supported image providers: apimart_image2, kie_image2, t8_image2, macode_image2.

Install Sequence

Windows:

powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap.ps1
.\.venv\Scripts\python.exe scripts\configure_keys.py
powershell -ExecutionPolicy Bypass -File .\scripts\doctor.ps1
powershell -ExecutionPolicy Bypass -File .\scripts\run_demo.ps1

macOS/Linux:

bash scripts/bootstrap.sh
./.venv/bin/python scripts/configure_keys.py
bash scripts/doctor.sh
bash scripts/run_demo.sh

If covers are requested, run scripts/doctor.py --require-cover before generation.

Skills

skills/auto-whiteboard-video: generate a complete narrated whiteboard video from a transcript.
skills/youtube-cover-generator: generate YouTube and platform covers in the locked visual style.
skills/whiteboard-animation: internal renderer used by the main pipeline.
skills/whiteboard-video-workflow: internal storyboard and image-generation workflow.

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

2mo ago First seen · 74 lines · 586 tokens per session scan A 4c259378652c

Subscribe to this mod's changes

whiteboard AGENTS.md is an instructions file published in the GitHub repository shaomingchan/whiteboard (50 stars, last pushed 3mo ago), licensed MIT. It adds 586 tokens to every session, about $0.0023 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.

whiteboard AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
whiteboard AGENTS.mdshaomingchan/whiteboard	Instructions file	50	3mo ago	MIT	A	586	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	yesterday	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

whiteboard: Instructions file for Codex