Agent skill

Readme Guidelines

Review or write README content for open-source projects. An agent skill from CelestoAI/celesto.

Apache-2.0Auto-check passedDevelopment

Install Readme Guidelines

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/readme-guidelines .claude/skills/readme-guidelines && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .claude/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/readme-guidelines .agents/skills/readme-guidelines && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .agents/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/readme-guidelines .cursor/skills/readme-guidelines && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .cursor/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/CelestoAI/celesto.git --path .agents/skills/readme-guidelines

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/readme-guidelines .gemini/skills/readme-guidelines && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .gemini/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/readme-guidelines .github/skills/readme-guidelines && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .github/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add CelestoAI/celesto --skill readme-guidelines -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install CelestoAI/celesto readme-guidelines --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/CelestoAI/celesto.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/readme-guidelines .opencode/skills/readme-guidelines && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "readme-guidelines" agent skill from https://github.com/CelestoAI/celesto/tree/main/.agents/skills/readme-guidelines into .opencode/skills/readme-guidelines/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-guidelines", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: readme-guidelines
GitHub stars: 1k
Token cost: ~763 tokens
SKILL.md length: 357 words
Files: 1
Skills in repo: 2
Repo updated: Oct 8, 2026
First seen: Oct 7, 2026
Licence: Apache-2.0

At a glance

Review or write README content for open-source projects. An agent skill from CelestoAI/celesto.

Works in 4 steps: Progressive disclosure of complexity → One concept per code example → Jargon-free language first, depth second → …
Asked to write README
SKILL.md covers Core Principles, Review Checklist and Output Format
Needs API_KEY

What it does

Readme Guidelines is an agent skill from CelestoAI/celesto. Review or write README content for open-source projects. Enforces progressive disclosure, jargon-free language, and single-concept code examples. Use when asked to "write README", "review README", "update README", or "check docs".

Its SKILL.md is about 760 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation and Browser automation. The repository describes itself as: Secure and persistent computer for AI agents. The licence is Apache-2.0.

When your agent uses it

Asked to write README
Tasks that involve Technical documentation
Tasks that involve Browser automation

Example prompts

“write README”
“review README”
“update README”
“/readme-guidelines”

Requirements

Python 3
A credential in API_KEY

Workflow steps

4 steps, taken from the step headings in SKILL.md.

Progressive disclosure of complexity
One concept per code example
Jargon-free language first, depth second
Introduce before you use

What it can do on your machine

Read from SKILL.md and the folder at commit 2e2c72c. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are python).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names these keys or tokens, usually read from environment variables:
- API_KEY
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Guidelines loads about 763 tokens when it runs. Until then it costs about 62 tokens; SKILL.md has 357 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~62
When it runs · the whole SKILL.md, loaded when a task matches: ~763

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from CelestoAI/celesto at commit 2e2c72c, republished under its Apache-2.0 licence (© CelestoAI). 357 words, ~763 tokens.

Download SKILL.mdSave it as .claude/skills/readme-guidelines/SKILL.md (or your agent's skills folder).

name: readme-guidelines
description: Review or write README content for open-source projects. Enforces progressive disclosure, jargon-free language, and single-concept code examples. Use when asked to "write README", "review README", "update README", or "check docs".
argument-hint: <file-or-section>
metadata.author: Celesto Team
metadata.version: 1.0.0

README Guidelines

Review or write README content following these principles. The goal is easy onboarding for both newcomers and advanced users.

Core Principles

1. Progressive disclosure of complexity

Structure content so readers can stop at any point and still have a working mental model. Each section should be usable on its own:

Lead with the simplest outcome (one-liner, quickstart)
Add detail in subsequent sections
Advanced topics (integrations, internals, performance) come last
Never require reading ahead to understand what's in front of you

2. One concept per code example

Each code block should demonstrate exactly one idea. If a snippet requires the reader to understand two or more new things simultaneously, split it.

Wrong — introduces sandbox creation AND environment variables at the same time:

python

with Celesto(env={"API_KEY": "secret"}) as vm:
    vm.run("curl $API_KEY")

Right — teaches sandbox creation first, env vars in a separate example:

python

with Celesto() as vm:
    vm.run("echo 'hello'")

3. Jargon-free language first, depth second

Explain every concept as if talking to a first-year CS student before using technical terms. Then go deeper if the reader needs it.

Bad: "SSH host keys are accepted on first connection via TOFU"
Good: "Celesto uses SSH to run commands in a sandbox. SSH is a secure connection between your computer and the sandbox."

Show full SKILL.md (162 more words)Show less

4. Introduce before you use

Never use a value, flag, or identifier in a code block without explaining where it comes from. If a command prints a session_id, show that command before any command that takes session_id as input.

Review Checklist

When reviewing a README, check each section against these rules:

Tagline: does it describe a single, concrete outcome?
Intro paragraph: can a newcomer understand it without prior context?
Quickstart: does it follow install → configure → first run, in that order?
Each code block: does it introduce exactly one new concept?
Each new identifier (<session-id>, <sandbox-name>): is it introduced before it's used?
Jargon: is every technical term explained in plain language on first use?
Sections: does complexity increase monotonically top-to-bottom?
Examples table: are entries grouped by audience (getting started vs. advanced)?
Footer: does it duplicate links that already appear at the top?

Output Format

For each violation found, output:

Line <N>: [rule violated]
  Current: <quote the problematic text>
  Fix: <suggested rewrite>

Then provide a revised version of any section that has more than one violation.

Files

Just SKILL.md in .agents/skills/readme-guidelines of CelestoAI/celesto.

Open the folder on GitHubat commit 2e2c72c

Compare with similar skills

Readme Guidelines next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Guidelines compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Readme Guidelines this skillCelestoAI/celesto	1k	—	~763	Automated safety check: Pass	Apache-2.0	today
OpenCLI Adapter Authorjackwener/OpenCLI	30k	1 repos	~3.4k	Automated safety check: Pass	Apache-2.0	14 days ago
OpenCLI Adapter Autofixjackwener/OpenCLI	30k	1 repos	~3.2k	Automated safety check: Pass	Apache-2.0	14 days ago
Kimi WebbridgeMoonshotAI/kimi-code	7.8k	—	~3.6k	Automated safety check: Pass	MIT	today
Derive API Client from Browser Trafficvercel-labs/agent-browser	44k	1 repos	~1.3k	Automated safety check: Pass	Apache-2.0	yesterday
Bun 1.4 Builtins Guidecode-yeongyu/senpi	472	—	~1.3k	Automated safety check: Pass	MIT	today

Similar skills

OpenCLI Adapter Author
jackwener/OpenCLI
Walks through writing an OpenCLI adapter for a new site or a new command on an existing one, from first recon and field decoding to coding and verification.
30k GitHub starsUsed in 1 repo~3.4k tokens
DevelopmentAuto-check passed
OpenCLI Adapter Autofix
jackwener/OpenCLI
Repairs a broken OpenCLI site adapter after a command fails: collects a trace, patches only the adapter, retries, and files an upstream GitHub issue once fixed.
30k GitHub starsUsed in 1 repo~3.2k tokens
DevelopmentAuto-check passed
Kimi Webbridge
MoonshotAI/kimi-code
Kimi Browser Extension（Kimi 浏览器扩展，原 Kimi WebBridge）lets AI control the user's real browser — navigate, click, type, read, screenshot, and interact with any website using the user's actual login…
7.8k GitHub stars~3.6k tokensUpdated today
DevelopmentAuto-check passed
Derive API Client from Browser Traffic
vercel-labs/agent-browser
Official
Records a site's browser traffic into a HAR file, then builds a standalone client or CLI that calls its internal endpoints directly with no browser.
44k GitHub starsUsed in 1 repo~1.3k tokens
DevelopmentAuto-check passed
Bun 1.4 Builtins Guide
code-yeongyu/senpi
Points the agent at Bun 1.4 built-in APIs before it installs an npm package, so image, browser, markdown, cron, PTY and test work uses what Bun already ships.
472 GitHub stars~1.3k tokensUpdated today
DevelopmentAuto-check passed
Browser Harness Agentloom
linora-u/AgentLoom
A skill your agent uses when working on AgentLoom browser-harness integration or debugging applications/browserharnessprobe: creating or updating the probe Application, installing the external…
168 GitHub stars~1.3k tokensUpdated today
DevelopmentAuto-check passed

Questions about Readme Guidelines

What does Readme Guidelines do?

Review or write README content for open-source projects. An agent skill from CelestoAI/celesto. Readme Guidelines is an agent skill from CelestoAI/celesto. Review or write README content for open-source projects.

When should I use Readme Guidelines?

Readme Guidelines fits situations like: asked to write README; tasks that involve Technical documentation; tasks that involve Browser automation.

How do I install Readme Guidelines in Claude Code?

Run `npx skills add CelestoAI/celesto --skill readme-guidelines -a claude-code`. Or copy the skill folder (.agents/skills/readme-guidelines in CelestoAI/celesto) into .claude/skills/readme-guidelines in your project. Claude Code loads it when a task matches its description.

How do I install Readme Guidelines in Codex?

Run `npx skills add CelestoAI/celesto --skill readme-guidelines -a codex`. Or copy the skill folder (.agents/skills/readme-guidelines in CelestoAI/celesto) into .agents/skills/readme-guidelines in your project. Codex loads it when a task matches its description.

Can I use Readme Guidelines in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add CelestoAI/celesto --skill readme-guidelines -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-guidelines, .gemini/skills/readme-guidelines, .github/skills/readme-guidelines and .opencode/skills/readme-guidelines in your project.

What does Readme Guidelines need to run?

Going by SKILL.md and its folder, Readme Guidelines needs credentials named API_KEY. Our summary lists: Python 3; A credential in API_KEY.

Does Readme Guidelines access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme Guidelines safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme Guidelines use?

Readme Guidelines is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Readme Guidelines use?

About 763 tokens (SKILL.md is roughly 3.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme Guidelines?

Skills that share tags, products or a category with Readme Guidelines: OpenCLI Adapter Author (jackwener/OpenCLI, 30k stars), OpenCLI Adapter Autofix (jackwener/OpenCLI, 30k stars), Kimi Webbridge (MoonshotAI/kimi-code, 7.8k stars) and Derive API Client from Browser Traffic (vercel-labs/agent-browser, 44k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Guidelines?

CelestoAI (a GitHub organization) maintains it in CelestoAI/celesto, which has 1,019 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 8, 2026.

Source: CelestoAI/celesto on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Readme Guidelines

Install Readme Guidelines

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

README Guidelines

Core Principles

1. Progressive disclosure of complexity

2. One concept per code example

3. Jargon-free language first, depth second

4. Introduce before you use

Review Checklist

Output Format

Files

Compare with similar skills

Similar skills

OpenCLI Adapter Author

OpenCLI Adapter Autofix

Kimi Webbridge

Derive API Client from Browser Traffic

Bun 1.4 Builtins Guide

Browser Harness Agentloom

More from CelestoAI/celesto

CLI Docs Guidelines

Questions about Readme Guidelines

Install Readme Guidelines

Facts

At a glance

What it does

When your agent uses it

Example prompts

Requirements

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

README Guidelines

Core Principles

1. Progressive disclosure of complexity

2. One concept per code example

3. Jargon-free language first, depth second

4. Introduce before you use

Review Checklist

Output Format

Files

Compare with similar skills

Similar skills

OpenCLI Adapter Author

OpenCLI Adapter Autofix

Kimi Webbridge

Derive API Client from Browser Traffic

Bun 1.4 Builtins Guide

Browser Harness Agentloom

More from CelestoAI/celesto

CLI Docs Guidelines

Related

Questions about Readme Guidelines