A tool for creating or updating HOW-TO-RUN.md, a guide that teaches a new developer how to set up and run a project locally.

Use it to document prerequisites, installation, configuration, building, running, and testing for a project without executing those steps itself.

It checks the actual project files to avoid documenting missing or incorrect commands, dependencies, services, and environment settings.

how-to-run — Skill for Claude Code and Codex by oprogramadorreal

Install

Getting it into your agent

This one installs as part of its plugin. Adding the marketplace and installing the plugin brings it with everything else the plugin ships.

Claude Code

/plugin marketplace add oprogramadorreal/optimus-claude

Claude Code

/plugin install optimus

Made for: Claude Code, Codex.

Or install optimus, the plugin that ships this one along with the rest of its 19 skills, 2 agents, 3 hooks.

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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/oprogramadorreal/optimus-claude/how-to-run/github.svg)](https://agentmods.dev/skills/oprogramadorreal/optimus-claude/how-to-run)

Your own site

<a href="https://agentmods.dev/skills/oprogramadorreal/optimus-claude/how-to-run"><img src="https://agentmods.dev/badge/skills/oprogramadorreal/optimus-claude/how-to-run/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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/oprogramadorreal/optimus-claude/how-to-run"><img src="https://agentmods.dev/badge/skills/oprogramadorreal/optimus-claude/how-to-run.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 79 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 3,569 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.

Model	Per session	Once invoked
Fable 5.1	$0.00079	$0.03569
Opus 5	$0.00039	$0.01784
Sonnet 5	$0.00016	$0.00714
Haiku 4.5	$0.00008	$0.00357

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

Security

Grade A, and why

how-to-run 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 10d 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.

skills/how-to-run/SKILL.md · 112 lines

How it starts

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

How to Run

Generate or update HOW-TO-RUN.md at the project (or workspace) root: OS/hardware prerequisites, toolchain and SDKs, source dependencies, install, external services, env config, build, run, and tests — every fact verified against the actual codebase.

Write scope: the only file this skill ever creates or modifies is HOW-TO-RUN.md. It never touches README.md, CONTRIBUTING.md, BUILDING.md, INSTALL.md, docs/*, or any other file — not even to add a link. Existing docs are input-only hypotheses. The guided walkthrough (Step 3a) is display-only — the skill never executes commands; the user runs every step locally.

Step 1: Detect project context (agent)

Read $CLAUDE_PLUGIN_ROOT/skills/how-to-run/agents/project-environment-detector.md and $CLAUDE_PLUGIN_ROOT/skills/how-to-run/agents/shared-constraints.md. Launch 1 general-purpose Agent tool call whose prompt is, in order: the Agent Constraints section of $CLAUDE_PLUGIN_ROOT/references/shared-agent-constraints.md, the shared-constraints file, the contents of $CLAUDE_PLUGIN_ROOT/skills/init/references/tech-stack-detection.md, and the detector prompt.

Two conditional additions, each gated on a check you run before dispatching — a plain single-project repo needs neither, and they are ~130 lines together:

Structure rules — include $CLAUDE_PLUGIN_ROOT/skills/init/references/project-detection.md when the layout is not obviously a single project: a workspace manifest (pnpm-workspace.yaml, lerna.json, turbo.json, a root package.json with workspaces, a Cargo or Go workspace, a .sln spanning several projects), or manifest files in two or more subdirectories. When you skip it, say so in the prompt so the detector reports Workspace kind: none instead of re-deriving it.
Multi-repo — when the current directory has no .git/ directory, include $CLAUDE_PLUGIN_ROOT/skills/init/references/multi-repo-detection.md; this skill supports multi-repo workspaces via a workspace-root file.

Read the full file on GitHub · 112 lines

Files

What ships with it

11 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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.

10d ago First seen · 112 lines · 79 tokens per session scan A 074fe11747b9

Subscribe to this mod's changes

how-to-run is a skill published in the GitHub repository oprogramadorreal/optimus-claude (73 stars, last pushed today), licensed MIT. It adds 79 tokens to every session and 3,569 once invoked, about $0.0004 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-30.

Claude Code Writing and docs ai anthropic automation claude claude-code-plugin

masterplan-detect

Suggest /masterplan import only when legacy masterplan bundle state files (docs/masterplan/ /state.yml at schema 5.x) exist without a matching v8 run. Generic planning artifacts (PLAN.md, TODO.md, ROADMAP.md, design docs, PR task lists) are NOT importable — no /masterplan import can ingest them; mention them only as…

rasatpetabit/masterplan · 116 tokens

claude-md-rules-creator

Authors and audits CLAUDE.md, CLAUDE.local.md and .claude/rules/.md: which scope to use, paths: scoping, @path imports, splitting an oversized file, and why an instruction is being ignored.

anilcancakir/claude-code · 60 tokens

skill-creator

Authors and audits Claude Code skills: frontmatter, directory layout, scope, invocation control, and bundled references or scripts.

anilcancakir/claude-code · 28 tokens

git-master

Git expert: atomic commits with style detection, rebase and squash, and history archaeology through blame, bisect and pickaxe.

anilcancakir/claude-code · 29 tokens

guide

Open the showreel visual setup guide, or walk the user through installing the plugin's dependencies. Use when the user asks how to set up showreel, install its dependencies, pre-warm the capture motor, install vhs, or says "showreel guide", "setup guide", "como instalar o showreel".

HeyRenan/showreel · 70 tokens

showreel

Use when the user wants to explain or document something visually — annotated screenshots, feature demos, flow GIFs, terminal recordings, before/after comparisons — or says "take a screenshot", "record this flow", "make a gif of", "show how this works", "annotate this page", "demo this feature", "grava um gif", "tira…

HeyRenan/showreel · 98 tokens