PortalJS is a framework for building data portals that present searchable datasets through a home page, catalog, and dataset showcase. It is for teams that want to choose a data backend, scaffold a Next.js portal, load CSV or JSON data, connect services such as CKAN, and deploy the result. The catalogue entries are agent commands, skills, instructions, and a plugin that guide portal creation and data loading.
Borrowing it
Nothing to install: this file belongs to datopian/portaljs. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/datopian/portaljs/main/CLAUDE.mdgit clone --depth 1 https://github.com/datopian/portaljsWrote 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.
[](https://agentmods.dev/instructions/datopian/portaljs/claude-md)<a href="https://agentmods.dev/instructions/datopian/portaljs/claude-md"><img src="https://agentmods.dev/badge/instructions/datopian/portaljs/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.
<a href="https://agentmods.dev/instructions/datopian/portaljs/claude-md"><img src="https://agentmods.dev/badge/instructions/datopian/portaljs/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.02961 | $0.02961 |
| Opus 5.5 | $0.01184 | $0.01184 |
| Sonnet 5.5 | $0.00592 | $0.00592 |
| Haiku 4.5 | $0.00296 | $0.00296 |
Grade A, and why
portaljs 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 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.
How it starts
The opening of the file, as written. The whole thing — 240 lines — stays where its author put it; the contents beside it link to each section on GitHub.
PortalJS — AI Development Guide
PortalJS is a Next.js framework for building data portals and catalogs. This file teaches AI assistants the conventions, patterns, and idioms used across this repo.
Core concepts — three surfaces
Every data portal is built from three surfaces. The template and routes map directly onto them; reason in these terms:
- Home (
/,pages/index.tsx) — what the portal is + a search box that routes to the catalog. - Catalog (
/search,pages/search.tsx) — find/browse datasets. Static = full-text filter overdatasets.json; scales to a search backend (CKAN/Solr) via/portaljs-connect-ckan. - Showcase (
/@<namespace>/<slug>,pages/[owner]/[slug].tsx) — one dataset: metadata, aTablepreview, download/API, and a Views slot for charts/maps.
Datasets are @-namespaced so they never collide with content pages. See docs/core-concepts.
Repo structure
packages/
ckan/ — CKAN catalog UI + React components (@portaljs/ckan)
ckan-api-client-js/ — pure CKAN API client (@portaljs/ckan-api-client-js)
examples/ — portaljs-catalog, the canonical template (read it before building)
.claude/
commands/ — Claude Code slash commands (OSS skills)
datopian/ — Datopian-internal skills (require API keys)
AUTHORING.md — how to write new skills
Component selection
The template ships its own lightweight components in components/. Do not add @portaljs/components — it bundles leaflet, vega, ag-grid, and pdf.js into a single non-tree-shakeable bundle and is not kept up to date with the local source.
| Need | Where |
|---|---|
| Show tabular data (CSV/TSV/JSON) | components/Table.tsx — uses papaparse + @tanstack/react-table |
| Charts | Add a chart library directly (e.g. recharts, victory) — do not use @portaljs/components |
| Map (GeoJSON) | Add react-leaflet + leaflet directly if needed |
| Page layout, nav | Plain Tailwind — no layout package needed |
| CKAN catalog | @portaljs/ckan only if connecting to a CKAN backend |
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.
- 2d ago Changed · +12 lines · +495 tokens per session 5360aa836001
- 1mo ago First seen · 228 lines · 2,466 tokens per session scan A c0d9cf9dfa5d
portaljs CLAUDE.md is an instructions file published in the GitHub repository datopian/portaljs (2,370 stars, last pushed 2d ago), licensed MIT. It adds 2,961 tokens to every session, about $0.0118 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.
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).
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.
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).
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.
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).
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.