NPM PACKAGE / NODE CLI AGENTS.MD

A TypeScript package published to npm, or a command-line tool. Libraries have users you never see, so these rules emphasize the public API, semantic versioning and keeping dependencies minimal.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The npm package / Node CLI filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: my-package. A TypeScript library and CLI published to npm.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: TypeScript
- Hosting: A package registry (npm, PyPI, crates.io)
- Tests: node:test
- Package manager: npm

## Commands

Run these from the repository root.

- Install dependencies: `npm ci`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `node --test dist/path/to/file.test.js`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npx prettier --write .`

## Project layout

- `src/`: Library source; src/index.ts is the public entry point
- `src/cli.ts`: The command-line entry (bin)
- `test/`: Tests
- `.changeset/`: Pending changelog entries
- `dist/`: Build output (never edit, never commit)

## Code style

- Indent with 2 spaces. Never tabs.
- TypeScript runs in strict mode. Do not use `any`; use `unknown` and narrow it, or write the real type.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Use named exports. Do not add default exports.
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.
- Delete code you make unused, including imports, flags and files. Do not leave commented-out code behind.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never delete, skip or loosen a test to make it pass. If a test is wrong, say why and ask before changing it.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
- When you change commands, structure or conventions, update this file and the README in the same change.

## Project-specific notes

- Everything exported from `src/index.ts` is public API. Do not remove or change an export, parameter or return type without calling it a breaking change.
- Every user-visible change adds a changeset with `npx changeset` choosing patch, minor or major per semver.
- Do not add runtime dependencies; dev dependencies are fine. If a runtime dependency seems necessary, ask first.
- Keep the `exports` map in `package.json` in sync with the files you add; consumers cannot import anything not listed there.
- The CLI exits with code 0 on success and non-zero on failure, writes results to stdout and errors to stderr.
- Never run `npm publish`; releases happen from CI.
- Public functions have JSDoc comments; they become the editor hover documentation for users.

## Project phase

This project is in maintenance. Make minimal, low-risk changes, preserve behavior and public APIs, and explain any change that could affect users.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: my-package. A TypeScript library and CLI published to npm.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: TypeScript
- Hosting: A package registry (npm, PyPI, crates.io)
- Tests: node:test
- Package manager: npm

## Commands

- Install dependencies: `npm ci`
- Build: `npm run build`
- Run all tests: `npm test`
- Run one test file: `node --test dist/path/to/file.test.js`
- Lint: `npm run lint`
- Type-check: `npx tsc --noEmit`
- Format: `npx prettier --write .`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never delete, skip or loosen a test to make it pass. If a test is wrong, say why and ask before changing it.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
- When you change commands, structure or conventions, update this file and the README in the same change.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the npm package / Node CLI preset

What Is in the npm package / Node CLI AGENTS.md?

The preset describes a a TypeScript library and CLI published to npm. Its AGENTS.md is 49 non-empty lines with 7 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: npm ci, npm run build, npm test, node --test dist/path/to/file.test.js, npm run lint, npx tsc --noEmit, npx prettier --write ..
  • Layout: src/, src/cli.ts, test/, .changeset/, dist/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for npm package / Node CLI?

You cannot see your users break

An app breaks loudly in its own tests. A library breaks silently in someone else repository a week later. Agents rename exports to tidy up without realizing the signature is a contract, so the rule defines what counts as public.

Every dependency is your users dependency

A runtime dependency adds install weight and supply-chain risk to every consumer. Libraries should be stingy, and an agent fixing a small problem should not pull in a large package to do it.

The exports map is a gate

Modern Node resolves package entry points through exports. A new file that is not listed simply does not exist for consumers, which is easy to miss when testing inside the repo.

Publishing is irreversible

npm versions cannot be reused once published. Releases should run from CI, never from an agent session.

Which Stack Rules Does the File Add?

  • Everything exported from src/index.ts is public API. Do not remove or change an export, parameter or return type without calling it a breaking change.
  • Every user-visible change adds a changeset with npx changeset choosing patch, minor or major per semver.
  • Do not add runtime dependencies; dev dependencies are fine. If a runtime dependency seems necessary, ask first.
  • Keep the exports map in package.json in sync with the files you add; consumers cannot import anything not listed there.
  • The CLI exits with code 0 on success and non-zero on failure, writes results to stdout and errors to stderr.
  • Never run npm publish; releases happen from CI.
  • Public functions have JSDoc comments; they become the editor hover documentation for users.

How Do You Add These Files to a npm package / Node CLI Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Which Similar Stacks Are in the Library?

All presets are on the stacks page.

Frequently Asked Questions

Why node:test instead of Vitest or Jest?

For a small library, the built-in runner means zero test dependencies. If your package already uses Vitest, choose it in the generator and the commands update.

What is a changeset?

A small Markdown file describing a change and its semver bump. The changesets tool collects them into the changelog and version number at release time.

Should dist be committed?

No. Build output is generated in CI before publishing. The rule tells the agent never to edit it, because changes there are overwritten on the next build.

Are these npm package / Node CLI files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?