sui: Instructions file for Claude Code

CLAUDE.md

sui CLAUDE.md is an instructions file for Claude Code from MystenLabs/sui. It costs 1,650 tokens per session, scanned A, original, Apache-2.0.

Project instructions for MystenLabs’ Sui codebase, including repository rules, crate-specific guidance, required license comments, build commands, and test commands. Sui is a large Rust-based software project.

In plain words
What is it for?
Use them when editing Sui source files, selecting a Rust crate to build, checking code, running simulation tests, or running its unit-test suite.
Why use it?
They help a coding agent follow local conventions and avoid unreliable or excessively slow build and test workflows.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md.

This is MystenLabs/sui's own configuration. It tells Claude Code how to work on sui itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything sui configures →

About the project

Sui is a blockchain platform for running smart contracts and managing digital assets, using the Move programming language and a network of authorities to process transactions. It is intended for developers building web3 applications and on-chain assets.

MystenLabs/sui · 7,784 stars · on GitHub · sui.io

Reuse

Borrowing it

Nothing to install: this file belongs to MystenLabs/sui. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/MystenLabs/sui/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/MystenLabs/sui

Made for: Claude Code.

Wrote 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.

agentmods badge for sui CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/mystenlabs/sui/claude-md/github.svg)](https://agentmods.dev/instructions/mystenlabs/sui/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/mystenlabs/sui/claude-md"><img src="https://agentmods.dev/badge/instructions/mystenlabs/sui/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.

agentmods 80×15 button for sui CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/mystenlabs/sui/claude-md"><img src="https://agentmods.dev/badge/instructions/mystenlabs/sui/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,650 This file is loaded in full into every session.
When invoked 1,650 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.01650 $0.01650
Opus 5.5 $0.00660 $0.00660
Sonnet 5.5 $0.00330 $0.00330
Haiku 4.5 $0.00165 $0.00165

Measured 2d ago against content hash a76d94c25ff7, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

sui 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 · 165 lines

How it starts

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

CLAUDE.md

Crate-specific CLAUDE.md files

When a sub-crate's CLAUDE.md conflicts with this file, the sub-crate's instructions win.

Individual Preferences

Individual preferences supersede and extend project preferences:

  • @CLAUDE.local.md if present.

Essential Development Commands

License comments

All applicable source code files must start with the following license in comments at the top of the file:

Copyright (c) Mysten Labs, Inc.
SPDX-License-Identifier: Apache-2.0

Building and Installation

# Build a specific crate. Generally don't need to do release build.
cargo build -p sui-core

# Check code without code generation or linking (preferred)
cargo check

Testing

# Run e2e tests. simtests must be run with `cargo simtest` to avoid false negatives
cargo simtest -p sui-e2e-tests

# Run Rust unittests. skip simulation tests as they may cause false negatives with `cargo nextest`
SUI_SKIP_SIMTESTS=1 cargo nextest run -p <crate-name>

Important Notes for Testing:

  • When compiling or running tests in this repository, set timeout limits to at least 10 minutes due to the large codebase size
  • For faster iteration, use -p to select only the most relevant packages for testing. Use multiple -p flags if necessary, e.g. cargo nextest run -p sui-types -p sui-core
  • Use cargo nextest run --lib to run only library tests and skip integration tests for faster feedback
  • Use a scoped cargo insta test for the relevant package when snapshots are affected. Inspect the generated snapshot diffs. If they match the intended changes, update them with cargo insta accept. Do not accept unrelated snapshot changes.
  • Consult crate-specific CLAUDE.md files for instructions on which tests to run, when changing files in those crates

Linting and Formatting

# Formats & lints all Rust & Move (can be slow).
./scripts/lint.sh

# For formatting:
cargo fmt --all

# Lint a single crate in `crates/`, `consensus/`, `sui-execution/`:
cargo xclippy -p <crate-name>

# Linting all crates in `external-crates/`: cd into the crate directory and run:
cargo move-clippy

Read the full file on GitHub · 165 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 Changed · +6 lines · +54 tokens per session a76d94c25ff7
  2. 8d ago Changed · -1 lines · -20 tokens per session 47baf7951af1
  3. 9d ago Changed · -1 lines · -11 tokens per session c4fc9147087e
  4. 27d ago Changed · +2 tokens per session ef7dd1076f23
  5. 1mo ago Changed · +24 lines · +369 tokens per session b8e3cfaf76c5
  6. 1mo ago First seen · 137 lines · 1,256 tokens per session scan A c8dec36552d3

Subscribe to this mod's changes

sui CLAUDE.md is an instructions file published in the GitHub repository MystenLabs/sui (7,784 stars, last pushed today), licensed Apache-2.0. It adds 1,650 tokens to every session, about $0.0066 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.

Related

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).

microsoft/vscode · 9,649 tokens

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.

vercel/next.js · 7,549 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

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.

langchain-ai/langchain · 4,680 tokens

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).

microsoft/vscode · 2,731 tokens

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.

denoland/deno · 3,077 tokens