tuui: Instructions file for Codex

AGENTS.md

tuui AGENTS.md is an instructions file for Codex, OpenCode from AI-QL/tuui. It costs 496 tokens per session, scanned A, original, Apache-2.0.

Repository instructions for an Electron desktop app, covering its development workflow, dependencies, coding style, and project layout.

In plain words
What is it for?
Use them when adding or changing Vue, TypeScript, or Pinia code, updating dependencies, or working on the app while it runs in development mode.
Why use it?
They tell coding agents how to work without interrupting the development server's live reload, and help keep dependencies and code structure consistent.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions Claude Code; mentions Codex.

This is AI-QL/tuui's own configuration. It tells Codex and OpenCode how to work on tuui 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 tuui configures →

About the project

TUUI is a desktop chat application that connects AI models to tools and other MCP servers through the Model Context Protocol, while coordinating APIs from different providers. It is intended for people who want a local interface for experimenting with LLMs, tools, and cross-vendor model services. The catalogue instruction helps guide work with the application.

AI-QL/tuui · 1,159 stars · on GitHub · tuui.com

Reuse

Borrowing it

Nothing to install: this file belongs to AI-QL/tuui. 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/AI-QL/tuui/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/AI-QL/tuui

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 tuui AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ai-ql/tuui/agents-md"><img src="https://agentmods.dev/badge/instructions/ai-ql/tuui/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 496 This file is loaded in full into every session.
When invoked 496 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.00496 $0.00496
Opus 5.5 $0.00198 $0.00198
Sonnet 5.5 $0.00099 $0.00099
Haiku 4.5 $0.00050 $0.00050

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

Security

Grade A, and why

tuui 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 · 44 lines

How it starts

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

AGENTS Guidelines for This Repository

This repository contains an Electron application located in the root of this repository. When working on the project interactively with an agent (e.g. Codex, Claude Code) please follow the guidelines below so that the development experience – in particular Hot Module Replacement (HMR) – continues to work smoothly.

1. Use the Development Server, not npm run build

  • Always use npm run dev while iterating on the application. This starts Electron in development mode by Vite with hot-reload enabled.

  • Do not run npm run build inside the agent session. If a production build is required, do it outside of the interactive agent workflow.

2. Keep Dependencies in Sync

If you add or update dependencies remember to:

  1. Update the appropriate lockfile (package-lock.json).
  2. Re-start the development server so that Vite picks up the changes.

3. Coding Conventions

  • Prefer TypeScript (.vue/.ts) for new components and utilities.
  • Co-locate component-specific styles in the same folder as the component when practical.
  • For Vue-related components, prefer Vue 3 with the script setup syntax.
  • Use Pinia as the preferred state management.

4. Project Structure

  • When adding new files, be mindful of the differences between the renderer, main, and preload processes.
  • For components required by the renderer, most can be reused from Vuetify.js’s existing components — only create new ones when absolutely necessary.
  • For components needed by the main process, most can be reused from Electron’s built‑in APIs.
  • After adding new files, re-start the development server so that Vite picks up the changes.

5. Useful Commands Recap

Command Purpose
npm run dev Start the Vite dev server with HMR.
npm run lint:fix Run ESLint checks and fix.
npm run test Execute the test suite.
npm run build:pre Production build – do not run during agent sessions

Read the full file on GitHub · 44 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. 2mo ago First seen · 44 lines · 496 tokens per session scan A d91a12dbc953

Subscribe to this mod's changes

tuui AGENTS.md is an instructions file published in the GitHub repository AI-QL/tuui (1,159 stars, last pushed 5mo ago), licensed Apache-2.0. It adds 496 tokens to every session, about $0.0020 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.

Related

tuui AGENTS.md compared with instructions from other repositories

tuui AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
tuui AGENTS.mdAI-QL/tuuiInstructions file1.2k5mo agoApache-2.0A496Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode