What is shotluma AGENTS.md?

Repository instructions for Shotluma, a React and TypeScript editor built with Vite, a frontend development tool. They describe the required workflow, commands, architecture rules, and quality checks.

Use them when modifying Shotluma to inspect related code, preserve user changes, update tests and documentation, run Bun commands, and pass the project's checks.

They give an AI coding assistant the project-specific rules needed to make safe, maintainable changes. They also specify how to verify changes before delivery.

How realZachi/shotluma configures Codex and OpenCode

Reuse

Borrowing it

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

Clone the repo

git clone --depth 1 https://github.com/realZachi/shotluma

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

Your own site

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

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

When invoked 605 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.00605	$0.00605
Opus 5.5	$0.00242	$0.00242
Sonnet 5.5	$0.00121	$0.00121
Haiku 4.5	$0.00060	$0.00060

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

Security

Grade A, and why

shotluma 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 · 45 lines

How it starts

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

Shotluma agent instructions

Shotluma is a React 19, TypeScript, and Vite editor. Treat maintainability, user data, export accuracy, and secret handling as product behavior.

Required workflow

Read this file and the linked rule documents relevant to the change.
Inspect nearby code, tests, and git status before editing. Preserve unrelated user changes.
Keep the change focused. Refactor an affected boundary first if the requested work would otherwise deepen a violation.
Add or update tests and documentation with the implementation.
Run bun run check before handing off. Do not hide failures with disabled rules or weaker thresholds.

Use Bun for all package and script operations. Never use npm or manually edit bun.lock.

Commands

bun install — install the locked dependencies.
bun run dev — start the editor at http://127.0.0.1:4173.
bun run typecheck — run strict TypeScript checks.
bun run lint — run typed ESLint, architecture, and complexity rules.
bun run test / bun run test:coverage — run the Vitest suite.
bun run build — type-check and build the production bundle.
bun run check — run every required local and CI quality gate.

Non-negotiable rules

Keep editor mutations immutable; undo/redo snapshots depend on it.
This public repository owns only the editor. The production marketing site is maintained privately and deployed separately; never add its source, styles, assets, or production-only configuration here.
Never commit secrets, private screenshots, unlicensed assets, PSD/PSB files, or generated dist/.
AI provider keys are entered in the browser (stored in localStorage) with optional .env.local VITE_* fallback for local dev; Moonshot and OpenCode use a same-origin CORS proxy. Never commit .env.local or deploy a keyed build.
Use shadcn/Base UI and Hugeicons for editor chrome. Do not add a parallel UI or token system.
Update generated src/components/ui/ files only with the shadcn CLI.
Use Conventional Commit messages and keep commits independently coherent.

Read the full file on GitHub · 45 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 · 45 lines · 605 tokens per session scan A cf40c1773ab8

Subscribe to this mod's changes

shotluma AGENTS.md is an instructions file published in the GitHub repository realZachi/shotluma (157 stars, last pushed 19d ago), licensed MIT. It adds 605 tokens to every session, about $0.0024 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.

ai-agent ai-sdk app-store app-store-screenshots aso bring-your-own-key

shotluma AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
shotluma AGENTS.mdrealZachi/shotluma	Instructions file	157	19d ago	MIT	A	605	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	9,719	GitHub Copilot
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	5,516	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	today	MIT	A	4,680	Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	3,093	GitHub Copilot
vscode model-prompts.instructions.mdmicrosoft/vscode	Instructions file	195k	today	MIT	A	2,022	GitHub Copilot

shotluma: Instructions file for Codex