shinkai-local-ai-agents: Instructions file for Codex

AGENTS.md

shinkai-local-ai-agents AGENTS.md is an instructions file for Codex, OpenCode from dcSpark/shinkai-local-ai-agents. It costs 670 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for Shinkai Local AI Agents, a desktop application built with React, Vite, and Tauri, a framework for desktop apps using web interfaces and native code. They describe the project structure, commands, style, and testing practices.

In plain words
What is it for?
Use them when developing the Shinkai desktop app or its libraries, running builds, tests, linting, TypeScript checks, or Rust checks.
Why use it?
They help changes fit the project’s app, shared libraries, Rust desktop layer, and Nx-based build and test setup.

Instructions file for CodexOpenCode

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

This is dcSpark/shinkai-local-ai-agents's own configuration. It tells Codex and OpenCode how to work on shinkai-local-ai-agents 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 shinkai-local-ai-agents configures →

Reuse

Borrowing it

Nothing to install: this file belongs to dcSpark/shinkai-local-ai-agents. 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/dcSpark/shinkai-local-ai-agents/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/dcSpark/shinkai-local-ai-agents

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 shinkai-local-ai-agents AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/dcspark/shinkai-local-ai-agents/agents-md/github.svg)](https://agentmods.dev/instructions/dcspark/shinkai-local-ai-agents/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/dcspark/shinkai-local-ai-agents/agents-md"><img src="https://agentmods.dev/badge/instructions/dcspark/shinkai-local-ai-agents/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.

agentmods 80×15 button for shinkai-local-ai-agents AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/dcspark/shinkai-local-ai-agents/agents-md"><img src="https://agentmods.dev/badge/instructions/dcspark/shinkai-local-ai-agents/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 670 This file is loaded in full into every session.
When invoked 670 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.

ModelPer sessionOnce invoked
Fable 5.1 $0.00670 $0.00670
Opus 5 $0.00335 $0.00335
Sonnet 5 $0.00134 $0.00134
Haiku 4.5 $0.00067 $0.00067

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

Security

Grade A, and why

shinkai-local-ai-agents 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 · 42 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • apps: Desktop app at apps/shinkai-desktop (React + Vite + Tauri). Source in src/, static in public/, Rust in src-tauri/.
  • libs: Shared packages (e.g., libs/shinkai-ui, libs/shinkai-i18n, libs/shinkai-message-ts).
  • assets, docs, ci-scripts, tools: Shared resources and automation.
  • Tests: Co-located using __tests__/ and *.test|spec.(ts|tsx).

Build, Test, and Development Commands

  • Dev (desktop): npx nx serve shinkai-desktop (Tauri dev; uses src-tauri/tauri.conf.local.json).
  • Build (desktop): npx nx build shinkai-desktop (Tauri build).
  • Unit tests: npx nx test shinkai-desktop (Vitest; reports to coverage/apps/shinkai-desktop).
  • Lint: npx nx lint shinkai-desktop (ESLint config at repo root and app-level).
  • Type check: npx nx run shinkai-desktop:typecheck.
  • Rust check (tauri): npx nx run shinkai-desktop:cargo-check.
  • Alternative (inside app): cd apps/shinkai-desktop && npm run dev|build|lint.

Coding Style & Naming Conventions

  • Indentation: 2 spaces (.editorconfig).
  • Formatting: Prettier with Tailwind plugin; single quotes enforced. Run: npx prettier --write ..
  • Linting: ESLint with import ordering, React Hooks rules, Vitest rules (no focused tests).
  • Naming: files/dirs kebab-case (vector-search/), React components/types PascalCase, variables/functions camelCase.

Testing Guidelines

  • Framework: Vitest + @testing-library/react.
  • Locations: co-locate next to source (e.g., component/__tests__/x.test.tsx).
  • Conventions: use *.test.ts(x); avoid only/focused tests (linted).
  • Run locally: npx nx test shinkai-desktop.

Commit & Pull Request Guidelines

  • Commits: Prefer Conventional Commits (e.g., feat:, fix:, chore:, docs:). Example: feat: reasoning streaming UI and markdown support.
  • PRs must include:
    • Clear description and linked issues (e.g., Closes #123).
    • Screenshots/GIFs for UI changes.
    • Scope-limited diff; updated docs/i18n when relevant.
    • Local verification: lint, unit tests, and cargo-check pass.

Read the full file on GitHub · 42 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. 10d ago First seen · 42 lines · 670 tokens per session scan A 78b7fc660aaf

Subscribe to this mod's changes

shinkai-local-ai-agents AGENTS.md is an instructions file published in the GitHub repository dcSpark/shinkai-local-ai-agents (433 stars, last pushed 2mo ago), licensed Apache-2.0. It adds 670 tokens to every session, about $0.0034 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.

Related

Other instructions, from other repositories

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

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

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

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 3,735 tokens