claude-workspace: Command for Claude Code

.claude/commands/onboard.md

onboard is a command for Claude Code from Piyush8296/claude-workspace. It costs 7 tokens per session (502 once invoked), scanned A, original, MIT.

A codebase onboarding guide that explores an unfamiliar project and documents its structure, technologies, architecture, and main entry points.

In plain words
What is it for?
Use it when joining a project or taking over a repository to map folders, identify frameworks and testing tools, inspect routing and state management, and find important files.
Why use it?
It reduces the time needed to understand where the application starts, how its parts fit together, and which tools it uses.

Command for Claude Code

Written for Claude Code: allowed-tools in frontmatter.

This is Piyush8296/claude-workspace's own configuration. It tells Claude Code how to work on claude-workspace 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 claude-workspace configures →

Reuse

Borrowing it

Nothing to install: this file belongs to Piyush8296/claude-workspace. 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/Piyush8296/claude-workspace/main/.claude/commands/onboard.md
Clone the repo
git clone --depth 1 https://github.com/Piyush8296/claude-workspace

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 onboard

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

Your own site · 80×15
<a href="https://agentmods.dev/commands/piyush8296/claude-workspace/onboard"><img src="https://agentmods.dev/badge/commands/piyush8296/claude-workspace/onboard.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 7 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 502 The whole file, excluding the scripts and references it only reads on demand.
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.00007 $0.00502
Opus 5 $0.00003 $0.00251
Sonnet 5 $0.00001 $0.00100
Haiku 4.5 $0.00001 $0.00050

Measured 9d ago against content hash 60b3cdb6fa42, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

onboard 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 9d 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/commands/onboard.md · 71 lines

What it actually says

Codebase Onboarding

Explore and map: $ARGUMENTS

Instructions

1. High-level structure

# Directory tree (2 levels deep)
find . -maxdepth 2 -type d | grep -v node_modules | grep -v .git | grep -v dist | grep -v .next | sort

# File counts by extension
find src/ -type f | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -15

# Package.json essentials
cat package.json | head -50

2. Technology stack

Identify from package.json and config files:

  • Framework (React, Next.js, Remix, etc.)
  • Language (TypeScript version, strict mode?)
  • Styling (Tailwind, CSS Modules, styled-components)
  • State management (Zustand, Redux, Jotai, Context)
  • Data fetching (TanStack Query, SWR, tRPC)
  • Testing (Vitest, Jest, Playwright, Cypress)
  • Build tool (Vite, Turbopack, webpack)

3. Architecture patterns

Examine:

  • Routing strategy (file-based, config-based)
  • Component organization (feature-based, type-based)
  • State management patterns
  • API layer structure
  • Error handling approach

4. Key entry points

Find and read:

  • Main app entry (src/app/layout.tsx, src/main.tsx, src/App.tsx)
  • Route definitions
  • Global providers/wrappers
  • Shared types/constants

5. Development workflow

Document:

  • Available scripts (package.json scripts)
  • Environment setup (.env.example, config files)
  • Git workflow (branch naming, PR templates)
  • CI/CD pipeline (.github/workflows/)

6. Produce onboarding doc

Generate a concise summary covering:

  • Stack overview (one line per technology)
  • Directory map with purpose of each top-level folder
  • Key patterns to follow
  • How to run locally
  • How to run tests
  • Where to find things (components, hooks, utils, types, tests)
  • Known gotchas or quirks
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. 9d ago First seen · 71 lines · 7 tokens per session scan A 60b3cdb6fa42

Subscribe to this mod's changes

onboard is a command published in the GitHub repository Piyush8296/claude-workspace (2 stars, last pushed 4mo ago), licensed MIT. It adds 7 tokens to every session and 502 once invoked, about $0.0000 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.