Agent skill

Cime Documentation Writer

by ESMCI in ESMCI/cime

“Use when writing CIME documentation”

— description from SKILL.md by ESMCI
Custom licenceAuto-check passedDevelopment

Install Cime Documentation Writer

skills CLI
$ npx skills add ESMCI/cime --skill cime-documentation-writer -a claude-code

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

GitHub CLI
$ gh skill install ESMCI/cime cime-documentation-writer --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/ESMCI/cime.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/cime-documentation-writer .claude/skills/cime-documentation-writer && 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/

Facts

Skill name
cime-documentation-writer
GitHub stars
174
Token cost
~459 tokens
SKILL.md length
218 words
Files
1
Skills in repo
3
Repo updated
First seen
Licence
Custom licence

At a glance

  • Works in 6 steps: Identify the topic being documented. → Locate where to place file under… → Add documentation and examples. → …
  • SKILL.md covers Overview, When to use, Formats and Documentation placement rules, plus 4 more sections
  • Calls make

About this skill

Cime Documentation Writer is a skill in ESMCI/cime (174 stars). Its SKILL.md is about 459 tokens. Licence: Custom licence.

Workflow steps

6 steps, taken from the first numbered list in SKILL.md.

  1. Identify the topic being documented.
  2. Locate where to place file under doc/source.
  3. Add documentation and examples.
  4. Find areas that should link to new documentation.
  5. Ask user to review.
  6. Apply feedback and loop until user is satisfied with documentation.

What it can do on your machine

Read from SKILL.md and the folder at commit 11e5d67. 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

    Shell commands in SKILL.md call:

    • make

    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 no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Cime Documentation Writer loads about 459 tokens when it runs. Until then it costs about 15 tokens; SKILL.md has 218 words of instructions outside code blocks.

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

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

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 218 words (~459 tokens).

“Use this skill to write documentation.”

— opening of SKILL.md by ESMCI, Custom licence
name
cime-documentation-writer

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/cime-documentation-writer of ESMCI/cime.

Open the folder on GitHubat commit 11e5d67

Compare with similar skills

Cime Documentation Writer 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.

Cime Documentation Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Cime Documentation Writer this skillESMCI/cime174—~459Automated safety check: PassCustom licence
Diagram Designcathrynlavery/diagram-design48k1 repos~7.6kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    48k GitHub starsUsed in 1 repo~7.6k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 8 days ago
    DevelopmentAuto-check: notes
  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from ESMCI/cime

  • A skill your agent uses when writing or modifying CIME sys (end-to-end) tests.

    174 GitHub stars~475 tokensUpdated today
    Auto-check passed
  • Cime Unit Test

    ESMCI/cime

    A skill your agent uses when writing/modifying CIME unit tests.

    174 GitHub stars~543 tokensUpdated today
    Auto-check passed

Categories

Questions about Cime Documentation Writer

How do I install Cime Documentation Writer in Claude Code?

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

How do I install Cime Documentation Writer in Codex?

Run `npx skills add ESMCI/cime --skill cime-documentation-writer -a codex`. Or copy the skill folder (.agents/skills/cime-documentation-writer in ESMCI/cime) into .agents/skills/cime-documentation-writer in your project. Codex loads it when a task matches its description.

Can I use Cime Documentation Writer 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 ESMCI/cime --skill cime-documentation-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/cime-documentation-writer, .gemini/skills/cime-documentation-writer, .github/skills/cime-documentation-writer and .opencode/skills/cime-documentation-writer in your project.

What does Cime Documentation Writer need to run?

Going by SKILL.md and its folder, Cime Documentation Writer needs the command-line tools its instructions call (make).

Does Cime Documentation Writer 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 Cime Documentation Writer 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 Cime Documentation Writer use?

Cime Documentation Writer has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Cime Documentation Writer use?

About 459 tokens (SKILL.md is roughly 1.8k 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 Cime Documentation Writer?

Skills that share tags, products or a category with Cime Documentation Writer: Diagram Design (cathrynlavery/diagram-design, 48k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Cime Documentation Writer?

ESMCI (a GitHub organization) maintains it in ESMCI/cime, which has 174 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on October 9, 2026.

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