plugins CLAUDE.md

A repository instruction file documents how to develop NotePlan plugins, extensions for the NotePlan note-taking app. It covers build, test, lint, type-checking, style, and logging practices.

In plain words
What is it for?
Building plugins, running tests and checks, fixing lint issues, and troubleshooting plugin logs.
Why use it?
It gives agents the project-specific commands and conventions needed to make safe plugin changes.

Instructions file

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/noteplan/plugins/claude-md
Clone the repo
git clone --depth 1 https://github.com/NotePlan/plugins
Per session 1,050 This file is loaded in full into every session.
When invoked 1,050 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.01050 $0.01050
Opus 5 $0.00525 $0.00525
Sonnet 5 $0.00210 $0.00210
Haiku 4.5 $0.00105 $0.00105

Measured yesterday against content hash 6215eaf33268, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

plugins 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 yesterday.

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 · 67 lines

How it starts

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

NOTEPLAN PLUGINS DEVELOPMENT GUIDE

Build/Test Commands

  • Build plugin: npc plugin:dev <plugin-id> -nc
  • Build react runtime: node ./<plugin-id>/src/react/support/performRollup.node.js
  • Lint code: npm run lint or fix issues with npm run lint-fix
  • Type check: npm run typecheck
  • Run all tests: npm run test
  • Run single test: npx jest path/to/file.test.js -t "test name"
  • Watch tests: npm run test:watch
  • Development mode: npm run dev

Code Style Guidelines

  • Use Flow for static typing
  • No semicolons (enforced by ESLint/Prettier)
  • Single quotes for strings
  • Max line length: 180 characters
  • Keep logDebug, logInfo, logWarn, logError, and clo() calls on a single line when possible; do not wrap them across multiple lines to satisfy the max line length rule
  • Use template literals instead of string concatenation
  • Use ES6+ features (const/let, arrow functions)
  • Use async/await and handle promises properly (no floating promises)
  • Follow existing naming patterns in the codebase
  • Proper error handling with try/catch blocks
  • Follow import order: external libs -> internal libs -> local files
  • Keep code DRY and modular with clear function responsibilities
  • Use JSDoc comments for public functions
  • Always research the helpers/ folder before writing new code
  • Prefer writing explicit functions over constant declarations

Common Helper Functions

The most frequently used functions in the codebase are:

  • Logging: logDebug, logError, clo, logInfo, logWarn
  • Note utilities: findNote, getParagraphs, getSelectedParagraphs, getTasksFromNote
  • Date handling: getTodaysDateHyphenated, getDateStringFromCalendarFilename
  • Configuration: getSettings, updateSettingsForPlugin
  • UI interaction: showMessage, showMessageYesNo, displayTitle

Viewing Plugin Logs

Use nplog (in scripts/nplog/) to read NotePlan's plugin log. Do not grep the raw log file — the three obvious greps all silently return zero results, which reads as "no errors": ^JSLog: misses the timestamp prefix, | ERROR | misses the emoji delimiters (🥺 WARN 🥺, ❗️ ERROR ❗️), and the leading timestamp is the flush time, wrong on about two thirds of lines.

Read the full file on GitHub · 67 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. yesterday First seen · 67 lines · 1,050 tokens per session scan A 6215eaf33268

Subscribe to this mod's changes

plugins CLAUDE.md is an instructions file published in the GitHub repository NotePlan/plugins (204 stars, last pushed 2d ago), licensed MIT. It adds 1,050 tokens to every session, about $0.0052 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

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,182 tokens

buildNext

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

next.js 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

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

spec-kit 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,040 tokens

langchain 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,345 tokens