thingsboard.io CLAUDE.md

Project-specific instructions for maintaining the ThingsBoard documentation website, a multilingual site built with Astro and Starlight.

In plain words
What is it for?
Use them when installing dependencies, starting development, building or checking the site, validating links and translations, or editing documentation content.
Why use it?
They explain the repository structure, required package manager, available checks, and a build confirmation rule before verification.

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/thingsboard/thingsboard.io/claude-md
Clone the repo
git clone --depth 1 https://github.com/thingsboard/thingsboard.io
Per session 4,320 This file is loaded in full into every session.
When invoked 4,320 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.04320 $0.04320
Opus 5 $0.02160 $0.02160
Sonnet 5 $0.00864 $0.00864
Haiku 4.5 $0.00432 $0.00432

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

Security

Grade A, and why

thingsboard.io 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.

CLAUDE.md · 262 lines

How it starts

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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is the ThingsBoard documentation site, built with Astro + Starlight. It's a multi-language documentation site with 14 supported languages.

Commands

# Install dependencies (requires pnpm)
pnpm install

# Development
pnpm dev              # Start dev server
pnpm build            # Production build
pnpm build:fast       # Fast build (skips OG image generation) — use this for verification

**Build policy:** Before running any build, always ask the user: "Run `pnpm build:fast` to verify, or skip?"
pnpm preview          # Preview production build

# Quality checks
pnpm check            # TypeScript/Astro type checking
pnpm lint:eslint      # ESLint
pnpm lint:linkcheck   # Link validation (runs build first)
pnpm lint:linkcheck:nobuild  # Link validation (skip build)
pnpm lint:slugcheck   # Validate slugs match across languages
pnpm lint:dualrender  # Validate IoT Hub server/client card render parity (needs a build)
pnpm format           # Format with Prettier

Architecture

Content System

All documentation lives in src/content/docs/{lang}/ as .mdx files with YAML frontmatter. Content uses Astro's Content Collections with type-safe Zod schemas defined in src/content.config.ts.

Schema types determine frontmatter shape: base, deploy, backend, cms, media, integration, migration, tutorial, recipe. The type frontmatter field selects the schema.

Sidebar is configured in astro.sidebar.ts with 5 top-level tabs (Start, Guides, Reference, Integrations, Third-Party). Labels are translated via src/content/nav/{lang}.ts files.

i18n

  • 14 languages configured in config/locales.ts
  • English (en) is the default/fallback language
  • Each language has its own directory under src/content/docs/
  • i18nReady: true frontmatter marks pages ready for translation
  • Translation status tracked by Lunaria (lunaria.config.ts)
  • Arabic (ar) uses RTL

Read the full file on GitHub · 262 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 · 262 lines · 4,320 tokens per session scan A 953ef73a575e

Subscribe to this mod's changes

thingsboard.io CLAUDE.md is an instructions file published in the GitHub repository thingsboard/thingsboard.io (2 stars, last pushed 4d ago), licensed MIT. It adds 4,320 tokens to every session, about $0.0216 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-31.