What is Shiori-v1 AGENTS.md?

A set of instructions for developing Shiori, an AI study companion for students. The project has a React and Vite client, an Express backend, and integrations for AI, authentication, classroom data, grades, notes, email, calendars, and payments.

Starting the full app or either part separately, building the client, running lint checks, and locating pages, components, state stores, API routes, and backend services.

It gives an agent the commands and project layout needed to install dependencies, run the app, build the client, and check its code.

How kaorii-ako/Shiori-v1 configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to kaorii-ako/Shiori-v1. 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/kaorii-ako/Shiori-v1/master/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/kaorii-ako/Shiori-v1

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/kaorii-ako/shiori-v1/agents-md/github.svg)](https://agentmods.dev/instructions/kaorii-ako/shiori-v1/agents-md)

Your own site

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

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

When invoked 1,083 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.01083	$0.01083
Opus 5	$0.00541	$0.00541
Sonnet 5	$0.00217	$0.00217
Haiku 4.5	$0.00108	$0.00108

Measured 10d ago against content hash 12bcad7f068a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

Shiori-v1 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 10d 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 · 109 lines

How it starts

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

Shiori — Codex Guide

Open-source AI study companion for students. React + Vite frontend, Express backend, Google Gemini AI.

Commands

# Install all deps (root + client + server)
npm install

# Dev (runs both client :5173 and server :3001)
npm run dev

# Client only
cd client && npm run dev

# Server only
cd server && npm run dev

# Build
cd client && npm run build

# Type check
cd client && npm run lint

Architecture

Shiori-v1/
├── client/               # React 18 + Vite frontend
│   └── src/
│       ├── pages/        # 15 pages (Home, Assignments, Grades, Notes, Flashcards, Quiz, Leaderboard…)
│       ├── components/   # GlassCard, Button, Sidebar, AIChat, PomodoroTimer, ShortcutModal…
│       ├── stores/       # Zustand stores (auth, assignments, grades, notes, flashcards, ui)
│       ├── hooks/        # useKeyboardShortcuts
│       ├── utils/        # gemini.js, pdfExport, icalExport, demoData, sounds
│       └── lib/          # api.js (axios), appwrite.js
├── server/               # Express.js backend
│   ├── routes/           # ai, auth, classroom, gmail, calendar, grades, stripe
│   └── services/         # Google OAuth wrappers
├── extension/            # Chrome MV3 extension
│   ├── manifest.json
│   ├── popup.html/js
│   ├── background.js
│   ├── content-classroom.js
│   └── icons/            # PNG icons (run node generate-icons.js to regenerate)
├── .env.example          # All required environment variables
└── LAUNCH.md             # Reddit/HN/Twitter/Product Hunt post copy

Key Files

File	Purpose
`client/src/utils/gemini.js`	Client-side Gemini REST wrapper — bring-your-own-key
`client/src/utils/demoData.js`	Demo mode seed data (5 courses, assignments, grades, notes, flashcards)
`client/src/stores/index.js`	All Zustand stores with zustand/persist
`client/src/hooks/useKeyboardShortcuts.js`	Two-key nav shortcuts (gh, ga, gq, gl…)
`client/src/pages/Quiz.jsx`	AI Quiz Generator — MCQ from notes via Gemini
`client/src/pages/Leaderboard.jsx`	Social leaderboard — share codes, compare streaks
`client/src/pages/FocusMode.jsx`	Fullscreen distraction-free Pomodoro
`server/routes/ai.js`	Gemini endpoints (study plan, flashcards, chat)

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

10d ago First seen · 109 lines · 1,083 tokens per session scan A 12bcad7f068a

Subscribe to this mod's changes

Shiori-v1 AGENTS.md is an instructions file published in the GitHub repository kaorii-ako/Shiori-v1 (44 stars, last pushed 1mo ago), licensed MIT. It adds 1,083 tokens to every session, about $0.0054 per session on Opus 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.

Building agents Frontend React gemini google-classroom open-source pomodoro

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

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,153 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

Shiori-v1: Instructions file for Codex