nb-cli: Instructions file for Codex

AGENTS.md

nb-cli AGENTS.md is an instructions file for Codex, OpenCode from jupyter-ai-contrib/nb-cli. It costs 843 tokens per session, scanned A, original, BSD-3-Clause.

Project instructions for nb-cli, a command-line tool for working with Jupyter notebooks, which are interactive documents containing code, results, and notes. They also explain how to test two incompatible collaboration backends separately.

In plain words
What is it for?
Use them when reading, editing, executing, or testing notebooks, and when selecting the Jupyter collaboration backend for integration tests.
Why use it?
They prevent notebook work from using the wrong tooling and keep competing server extensions from being installed together in one test environment.

Instructions file for CodexOpenCode

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

This is jupyter-ai-contrib/nb-cli's own configuration. It tells Codex and OpenCode how to work on nb-cli 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 nb-cli configures →

Reuse

Borrowing it

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

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 nb-cli AGENTS.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/jupyter-ai-contrib/nb-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/jupyter-ai-contrib/nb-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 843 This file is loaded in full into every session.
When invoked 843 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.00843 $0.00843
Opus 5.5 $0.00337 $0.00337
Sonnet 5.5 $0.00169 $0.00169
Haiku 4.5 $0.00084 $0.00084

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

Security

Grade A, and why

nb-cli 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 1mo 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 · 59 lines

How it starts

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

Agent Guidelines

Working with Notebooks (.ipynb files)

When the user asks to read, edit, execute, or work with .ipynb files, use the notebook-cli skill, which provides the nb command-line tool. Do not use the built-in Read/Write tools for .ipynb files.

Connect-mode integration tests: backend selection

tests/integration_connect_mode.rs exercises connect-mode against whatever collaboration backend is installed in the active test venv. jupyter-collaboration and jupyter-server-documents (JSD) are competing collaborative-editing server extensions and must never be installed into the same venv — each has its own:

  • tests/.test-venv — JSD + local-mode tests (default). Pinned: jupyter_server==2.20.0, jupyter-server-documents==0.2.5.
  • tests/.test-venv-collab — jupyter-collaboration. Pinned: jupyter_server==2.20.0, jupyter-collaboration==4.4.1.

Set up a venv with ./tests/setup_test_env.sh [jsd|jupyter-collaboration] (defaults to jsd). Select which backend a test run targets with NB_TEST_BACKEND=<jsd|jupyter-collaboration> (read by test_helpers::test_backend()); this also picks the matching venv directory automatically. Run with:

NB_TEST_BACKEND=jupyter-collaboration cargo test --test integration_connect_mode -- --test-threads=1

The shared Jupyter server is spawned once per test process (OnceLock) with its current_dir set to a tempdir root, so backend-specific artifacts like jupyter-collaboration's .jupyter_ystore.db land there instead of the crate root. On teardown, an atexit hook calls jupyter server stop <port> -y to cleanly shut down the server. Each notebook-executing test also explicitly deletes its Jupyter session/kernel via DELETE /api/sessions/{id} when its NotebookSession guard drops (production code intentionally never deletes sessions, so tests must do this themselves).

Known state (2026-07-05): against jupyter-collaboration, the 4 execute/restart tests (what PR #99 / issue #92 fixed — FileID fallback, sessionId on the Y.js room WS handshake, v1 kernel-WS subprotocol, client-side output writing) pass 10/10 runs with zero flakiness, and gate the test-connect-collab CI job. test_clear_outputs_in_connect_mode and test_clear_outputs_specific_cell_in_connect_mode are marked #[ignore] against jupyter-collaboration (issue #100): nb output clear correctly edits the Y.js room, but jupyter_server_ydoc only flushes the room to disk on a debounced ~1s timer (document_save_delay), so nb read immediately afterward races that debounce and can observe stale content — confirmed by direct measurement (still stale at +0.7s, cleared by +1.7s). This is a different root cause from #90 (JSD's clear never persists, permanently, because externalized output files get unconditionally re-materialized into the notebook on every save) — don't conflate the two if either gets fixed.

Read the full file on GitHub · 59 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. 1mo ago Changed · -11 lines · -191 tokens per session a685e6a0039d
  2. 1mo ago First seen · 70 lines · 1,034 tokens per session scan A d72754ebd733

Subscribe to this mod's changes

nb-cli AGENTS.md is an instructions file published in the GitHub repository jupyter-ai-contrib/nb-cli (94 stars, last pushed 1mo ago), licensed BSD-3-Clause. It adds 843 tokens to every session, about $0.0034 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

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,581 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,731 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 · 4,261 tokens