opik AGENTS.md

A shared repository guide for Opik, a multi-part codebase for monitoring and evaluating AI applications. A monorepo is one repository containing several related parts, such as the backend, web interface, libraries, and tests.

In plain words
What is it for?
Working on Opik’s Java backend, React and TypeScript interface, documentation, software libraries, deployment files, and end-to-end or performance tests. It also lists commands for starting, rebuilding, checking, and stopping the local application.
Why use it?
It gives contributors one place to find the project layout, development commands, testing expectations, and coding conventions. This reduces confusion about where changes belong and how to verify them.

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/comet-ml/opik/agents-md
Clone the repo
git clone --depth 1 https://github.com/comet-ml/opik

Made for: Codex, OpenCode.

Per session 1,289 This file is loaded in full into every session.
When invoked 1,289 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.01289 $0.01289
Opus 5 $0.00645 $0.00645
Sonnet 5 $0.00258 $0.00258
Haiku 4.5 $0.00129 $0.00129

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

Security

Grade A, and why

opik 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 · 78 lines

How it starts

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

Repository Guidelines

Scope & Inheritance

  • This is the canonical monorepo guide for shared contribution policy.
  • Module-level AGENTS.md files should keep only module-specific guidance and reference this file for shared rules.

Project Structure & Module Organization

This repository is a multi-module Opik codebase. Main areas:

  • apps/opik-backend: Java backend (source in src/main/java, tests in src/test/java).
  • apps/opik-frontend: React/TypeScript frontend (src and related assets/config).
  • apps/opik-documentation: documentation website and generated API docs.
  • sdks/python, sdks/typescript, sdks/opik_optimizer: SDK packages and examples.
  • deployment, scripts, extensions: infra, tooling, and integration extension points.
  • tests_end_to_end, tests_load: cross-stack and performance test suites.

Build, Test, and Development Commands

  • ./opik.sh — run default local stack via Docker.
  • ./opik.sh --build — rebuild images and run the full stack.
  • ./opik.sh --verify — run stack health checks.
  • ./opik.sh --stop — stop local services.
  • scripts/dev-runner.sh — fast local process mode (BE + FE).
  • scripts/dev-runner.sh --be-only-restart — backend-focused local development.
  • scripts/dev-runner.sh --build-be / --build-fe — build one side only.
  • scripts/dev-runner.sh --lint-be — Java lint/format checks.
  • scripts/dev-runner.sh --lint-fe — frontend lint/type checks via npm.
  • cd apps/opik-frontend && npm run lint && npm run test — run ESLint + Vitest.
  • cd apps/opik-frontend && npm run build — production frontend build.
  • cd apps/opik-backend && mvn test — backend unit/integration tests.
  • cd apps/opik-backend && mvn spotless:apply — apply Java formatting.
  • cd sdks/python && pip install -r tests/test_requirements.txt && pip install -r tests/unit/test_requirements.txt && pytest tests/unit tests/e2e — Python SDK test suites.
  • make precommit — run pre-commit hooks on changed files (vs origin/main) from the root .pre-commit-config.yaml across all modules (do not duplicate per-module command lines in multiple places).
  • cd sdks/typescript && npm run lint && npm run test && npm run build — TS SDK checks.
  • cd tests_end_to_end/e2e && npx playwright test — cross-stack Playwright E2E suite.

Read the full file on GitHub · 78 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 · 78 lines · 1,289 tokens per session scan A 0e4442cff9c7

Subscribe to this mod's changes

opik AGENTS.md is an instructions file published in the GitHub repository comet-ml/opik (21,685 stars, last pushed 2d ago), licensed Apache-2.0. It adds 1,289 tokens to every session, about $0.0064 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