Skip to main content
Add one CLAUDE.md — and Claude Code understands Cerulion’s stack, CLI patterns, and documentation standards from its first response. Claude Code is Anthropic’s official CLI tool. Add the file below to the repository root to get on-brand results without re-explaining the product context.

​
Prerequisites

  • Active Claude subscription (Pro, Max, or API access)

​
Setup

  1. Install Claude Code globally: 
    npm install -g @anthropic-ai/claude-code
  2. Navigate to your cerulion-docs directory.
  3. Add the CLAUDE.md file below to the project root.
  4. Run claude to start.

​
Create CLAUDE.md

Create CLAUDE.md at the root of the cerulion-docs repository: 
# Cerulion documentation — Claude Code context

## Product

Cerulion is a high-performance middleware for robotics and real-time systems (closed alpha).

- **Stack**: Rust binary via Homebrew / install script
- **Core**: Zero-copy pub/sub (iceoryx2 shared memory), network transport (Zenoh), ROS2-compatible messages
- **Target users**: Robotics engineers, embedded developers
- **Key fact**: ~60 ns local latency via shared memory — serialization only when crossing a network boundary

## CLI commands (use exact forms in examples)

```bash
cerulion workspace create <name>
cerulion node create <type> [--period-ms N] [--ext-trigger]
cerulion node build <type>
cerulion graph create <name>
cerulion graph run <name>
cerulion topic list|info|echo|hz <topic>
cerulion tui         # interactive monitor
```

## Platform

- **Docs platform**: Mintlify (theme: maple), MDX + YAML frontmatter, `docs.json` for nav
- **Dev server**: `mint dev` → localhost:3000
- **Deploy**: push to `main` → auto-deploys via Mintlify GitHub app

## Component rules

- `<Tree>` for all file structures — never ASCII art (`├──`)
- `<Card>` always uses `color="#0080FF"` — no exceptions
- `<Badge>` named colors only: `blue green orange yellow purple red`
- `<Frame>` wraps `<img>` only — never mermaid or code blocks
- `fetchpriority="high"` on all above-the-fold hero `<img>` tags
- Every page ends with the standard `<Tip>` CTA linking to quickstart + founders email

## Writing standards

- Second person ("you"), active voice, present tense
- Language tags on every code block: `rust`, `bash`, `yaml`, `toml`, `text`
- Use `text` for terminal output and scaffold trees (not `bash`)
- Relative paths for internal links — never absolute URLs to own docs
- Realistic placeholders: `camera_pub`, `display_sub`, `perception` — never `foo` or `example`
- No H1 in body — title comes from frontmatter

## Git workflow

- Never use `--no-verify` when committing
- Never skip pre-commit hooks
- Create a new branch when no clear branch exists for the change
Ready to try Cerulion? Start with the quickstart and have a working camera-to-display pipeline in 5 minutes — or schedule a 15-min call with the team.