omniscribe: Instructions file for Claude Code

CLAUDE.md

omniscribe CLAUDE.md is an instructions file for Claude Code from Shironex/omniscribe. It costs 1,744 tokens per session, scanned A, original, MIT.

Repository instructions for Omniscribe, a desktop app that runs multiple AI coding-assistant sessions at once. The project uses Electron, NestJS, React, and a monorepo, which is one repository containing several related packages or apps.

In plain words
What is it for?
Installing dependencies, running development and build commands, checking code with linting, formatting, tests, and type checks, and packaging the desktop app.
Why use it?
It gives coding agents the project’s required tools, commands, structure, and build order so they can work within the repository’s conventions.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/shironex/omniscribe/claude-md"><img src="https://agentmods.dev/badge/instructions/shironex/omniscribe/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,744 This file is loaded in full into every session.
When invoked 1,744 The same file — it is already loaded in full.
Security scan A 1 finding. 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.01744 $0.01744
Opus 5.5 $0.00698 $0.00698
Sonnet 5.5 $0.00349 $0.00349
Haiku 4.5 $0.00174 $0.00174

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

Security

Grade A, and why

omniscribe CLAUDE.md scanned grade A with 1 finding 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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

- **Backend:** Jest + `@nestjs/testing` TestingModule. Mock factories in `apps/desktop/test/mocks/` (MockPty, electron-store, child_process).
CLAUDE.md · 139 lines

How it starts

The opening of the file, as written. The whole thing — 139 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

Omniscribe is a desktop application for orchestrating multiple AI coding assistant sessions in parallel. It uses Electron with an embedded NestJS backend in the main process and a React frontend in the renderer.

Requirements

  • Node.js >= 22
  • pnpm 10.x

Commands

# Install dependencies
pnpm install

# Development (starts web + desktop concurrently)
pnpm dev

# Build all packages (shared must build first — all others depend on it)
pnpm build

# Build only shared package (required before desktop/web/mcp-server builds)
pnpm build:packages

# Lint / Format
pnpm lint
pnpm format          # write
pnpm format:check    # CI check (no write)

# Test / Type-check
pnpm test
pnpm typecheck

# Package desktop app for distribution
pnpm --filter @omniscribe/desktop package

# Platform-specific builds
pnpm package:win    # Windows
pnpm package:mac    # macOS

# Rebuild node-pty after electron update
pnpm --filter @omniscribe/desktop rebuild

Architecture

Monorepo Structure

  • apps/desktop/ - Electron main process with NestJS backend
  • apps/web/ - React frontend (served by Vite, loaded by Electron renderer)
  • apps/mcp-server/ - MCP server for Claude Code status reporting
  • packages/shared/ - Shared types and utilities

Backend (NestJS in Electron Main)

Located in apps/desktop/src/modules/:

  • TerminalModule - PTY management via node-pty, handles spawn/input/resize/kill (global module)
  • SessionModule - AI session lifecycle and state (Starting, Idle, Working, NeedsInput, Done, Error)
  • GitModule - Git operations (branches, worktrees, commits) via CLI execution with domain services
  • GithubModule - GitHub CLI operations (PRs, issues, repo info)
  • McpModule - MCP server discovery, config generation, status polling
  • WorkspaceModule - Project/tab management, persistence via electron-store
  • QuickActionModule - Quick action management and execution
  • UsageModule - Claude CLI usage data fetching
  • HealthModule - Periodic health checks and zombie session detection
  • SharedModule - CORS config, env-utils, throttler guard, NestJS logger adapter

Read the full file on GitHub · 139 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 · 139 lines · 1,744 tokens per session scan A 985c706874c7

Subscribe to this mod's changes

omniscribe CLAUDE.md is an instructions file published in the GitHub repository Shironex/omniscribe (9 stars, last pushed 3d ago), licensed MIT. It adds 1,744 tokens to every session, about $0.0070 per session on Opus 5.5. A static security scan graded it A with 1 finding (runs shell commands). 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

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 · 9,715 tokens

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,461 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens