byaan: Instructions file for Claude Code

CLAUDE.md

byaan CLAUDE.md is an instructions file for Claude Code from byaan-ai/byaan. It costs 1,885 tokens per session, scanned A, original, MIT.

A project instruction file describing Byaan, a local data-analysis desktop app, and its development commands. It covers a React and TypeScript interface with a Python FastAPI backend.

In plain words
What is it for?
Understanding the project structure and running backend formatting, linting, and automated tests.
Why use it?
It gives a coding agent the project context and the commands used to format, check, and test the code.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md; mentions Claude Code.

This is byaan-ai/byaan's own configuration. It tells Claude Code how to work on byaan 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 byaan configures →

Reuse

Borrowing it

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

Made for: Claude Code.

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 byaan CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/byaan-ai/byaan/claude-md"><img src="https://agentmods.dev/badge/instructions/byaan-ai/byaan/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,885 This file is loaded in full into every session.
When invoked 1,885 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.01885 $0.01885
Opus 5 $0.00942 $0.00942
Sonnet 5 $0.00377 $0.00377
Haiku 4.5 $0.00188 $0.00188

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

Security

Grade A, and why

byaan CLAUDE.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 12d 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.

CLAUDE.md · 189 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Byaan is a secure, locally-running data analysis tool that connects to databases and AI models while keeping data private. It's a desktop application (macOS/Linux) built with React frontend, FastAPI backend, and Tauri wrapper. Users can connect to databases (PostgreSQL, MongoDB, MySQL, SQLite), analyze data through AI-powered queries, and build exportable dashboards.

Key Value Proposition: Data never leaves the local machine. Users connect to federated AI models (Azure, Bedrock, OpenRouter) and explore their databases securely without cloud dependencies.

Build & Development Commands

Backend (Python/FastAPI)

cd server && uv run ruff format . && uv run ruff check --fix .  # Format & lint
cd server && uv run ruff check .                                 # Lint check only
cd server && PYTHONPATH=..:tests uv run pytest                   # Run all tests
cd server && PYTHONPATH=..:tests uv run pytest tests/test_file.py::test_function  # Single test
cd server && uv run pytest --cov=server --cov-report=term-missing  # Tests with coverage

Frontend (React/TypeScript)

cd client && pnpm dev         # Development server (port 5173)
cd client && pnpm build       # Production build
cd client && pnpm build:check # TypeScript + Vite build check
cd client && pnpm lint        # ESLint

Desktop App (Tauri)

cd client && pnpm tauri:dev           # Dev mode with hot reload
cd client && pnpm tauri:build         # Production build (auto-detects arch)
cd client && pnpm tauri:build:m-series  # M-series Mac build
cd client && pnpm tauri:build:intel   # Intel Mac build

Docker

# Local/Community (default — SQLite, no PostgreSQL)
make setup        # Build images
make dev          # Run with logs (foreground)
make dev-detach   # Run in background
make dev-build    # Build + run with logs
make stop         # Stop all services
make rebuild      # Full rebuild (no cache)
make clean        # Remove containers/volumes

# Hosted (PostgreSQL, closer to production)
make hosted       # Start hosted environment (background)
make hosted-logs  # Start with visible logs
make hosted-stop  # Stop hosted services
make hosted-rebuild  # Rebuild hosted images
make hosted-clean    # Remove hosted containers/volumes

Read the full file on GitHub · 189 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. 12d ago First seen · 189 lines · 1,885 tokens per session scan A 2135a2798de3

Subscribe to this mod's changes

byaan CLAUDE.md is an instructions file published in the GitHub repository byaan-ai/byaan (95 stars, last pushed 16d ago), licensed MIT. It adds 1,885 tokens to every session, about $0.0094 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

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

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

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