Agent instructions
Add these instructions to your project so AI coding agents discover and reuse your Bit components. Choose the set that matches how you use Bit.
Where to add
Claude CodeAdd to
CLAUDE.md in your project root.CodexAdd to
AGENTS.md in your project root.CursorAdd to
.cursorrules in your project root.WindsurfAdd to
.windsurfrules in your project root.GitHub CopilotAdd to
.github/copilot-instructions.md in your project root.Instructions
For any project that consumes Bit components as packages. Teaches your agent to search and reuse components instead of writing code from scratch.
## Bit Cloud component reuse
When building features, always check Bit Cloud for existing components
before writing new code.
1. **Orient first** — Use `orientation` to get a high-level map of the
organization's scopes and domains. This tells you where components live.
2. **Search before building** — Before implementing a feature, UI element, or utility,
use `search_components` to check the Bit Cloud registry.
3. **Read before installing** — Use `read_components` to review the API
reference, dependencies, and usage examples before adding a component.
4. **Reuse over rewrite** — Bit components are versioned, tested packages.
Installing an existing component is faster and more reliable than
writing from scratch.
5. **Install as packages** — Components are standard npm packages. Install
with your package manager: `npm install @org/scope.component-name`.
6. **Check for design systems** — If the project needs a theme or design
system, search for one first to ensure UI consistency.