shine AGENTS.md

Repository instructions for Shine, a self-contained Rust command-line tool that installs shell scripts, app settings, and operating-system setup files.

In plain words
What is it for?
Use them when changing Shine’s Rust code, documentation, installation process, or uninstall behavior.
Why use it?
They tell coding agents what to read before changing code and where to record design decisions, lessons, and architecture changes.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/biulight/shine/agents-md
Clone the repo
git clone --depth 1 https://github.com/biulight/shine

Made for: Codex, OpenCode.

Per session 2,149 This file is loaded in full into every session.
When invoked 2,149 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.02149 $0.02149
Opus 5 $0.01074 $0.01074
Sonnet 5 $0.00430 $0.00430
Haiku 4.5 $0.00215 $0.00215

Measured 2d ago against content hash 800e894290cd, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

shine 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 2d 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 · 174 lines

How it starts

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

AGENTS.md

This file is the repository entry point for AI coding agents. Keep it concise: mandatory workflow, high-frequency commands, and pointers to authoritative detail belong here; architecture narratives and feature-specific authoring guidance belong in docs/kb/.

shine is a self-contained Rust CLI that bundles shell scripts, app config presets, and OS bootstrap presets into one binary (rust-embed), installs them under ~/.shine/, and supports safe, manifest-tracked uninstall. The workspace root is the publishable shine-cli package (binary plus the cli library); core/ is the reusable shine-core package.

Required workflow

  1. Before any non-trivial change, read architecture/invariants.md and grep lessons.md for the modules or behavior you will touch.
  2. Before proposing a design, check decisions/ for an existing ADR.
  3. Preserve unrelated working-tree changes. Do not overwrite or clean files you do not own.
  4. Update the KB in the same change whenever code makes it stale:
    • non-obvious bug cause → lessons.md
    • design choice → numbered ADR under decisions/
    • changed data flow or invariant → the matching file under architecture/
    • moved or renamed modules → architecture/module-map.md
  5. User-visible behavior changes must update both public manual locales in the same release change:
    • English source: docs/manual/
    • Simplified Chinese: website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/ Keep doc IDs, page sets, commands, identifiers, examples, and warnings semantically aligned.
  6. Do not publish docs/kb/, PRDs, release runbooks, private paths, or internal procedures through the public site. Root READMEs are summaries, not a second command/configuration reference.

Full KB maintenance protocol: docs/kb/README.md.

Knowledge map

Need Authoritative source
Build, test, lint, and common verification this file
Module ownership and command routing docs/kb/architecture/module-map.md
Cross-module data flows docs/kb/architecture/data-flows.md
Safety and behavioral invariants docs/kb/architecture/invariants.md
Declarative action/recovery design and executable inventory docs/declarative-action-recovery-prd.md, docs/kb/executable-preset-inventory.md
Platform coverage, gaps, and implementation priorities docs/kb/architecture/platform-support.md
Shell, app, and sys preset authoring docs/kb/preset-authoring.md
Design rationale docs/kb/decisions/
Commit, versioning, and testing conventions docs/kb/conventions.md
Release, CI, and troubleshooting docs/kb/operations/
Past bugs and derived rules docs/kb/lessons.md
Public user manual docs/manual/, website/i18n/zh-Hans/

Read the full file on GitHub · 174 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. 2d ago First seen · 174 lines · 2,149 tokens per session scan A 800e894290cd

Subscribe to this mod's changes

shine AGENTS.md is an instructions file published in the GitHub repository biulight/shine (5 stars, last pushed 2d ago), licensed MIT. It adds 2,149 tokens to every session, about $0.0107 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-31.

Related

Other instructions, from other repositories

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

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

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

next.js 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