A command that creates or updates a README.md file with the project’s current task list and progress. A README is the main introductory document in a code repository.

Use it to publish pending tasks, subtasks, priorities, sprint work, dependencies, and completion statistics in the README.

It keeps task status visible in the repository without requiring readers to open the task-management tool.

sync-readme — Command by snarktank

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods

npx agentmods add commands/snarktank/code-editing-agent/sync-readme

Clone the repo

git clone --depth 1 https://github.com/snarktank/code-editing-agent

Made for: Claude Code.

Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 553 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. Scan, not verified.

Origin 100% copy Near-identical to another mod 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	$0.00000	$0.00553
Opus 5	$0.00000	$0.00277
Sonnet 5	$0.00000	$0.00111
Haiku 4.5	$0.00000	$0.00055

Measured 2d ago against content hash a22ca9aa463c, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

sync-readme 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 2d 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.

Origin

This is a copy

100% identical to sync-readme — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.claude/commands/tm/sync-readme/sync-readme.md · 117 lines

How it starts

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

Export tasks to README.md with professional formatting.

Arguments: $ARGUMENTS

Generate a well-formatted README with current task information.

README Synchronization

Creates or updates README.md with beautifully formatted task information.

Argument Parsing

Optional filters:

"pending" → Only pending tasks
"with-subtasks" → Include subtask details
"by-priority" → Group by priority
"sprint" → Current sprint only

Execution

task-master sync-readme [--with-subtasks] [--status=<status>]

README Generation

1. Project Header

# Project Name

## 📋 Task Progress

Last Updated: 2024-01-15 10:30 AM

### Summary
- Total Tasks: 45
- Completed: 15 (33%)
- In Progress: 5 (11%)
- Pending: 25 (56%)

2. Task Sections

Organized by status or priority:

Progress indicators
Task descriptions
Dependencies noted
Time estimates

3. Visual Elements

Progress bars
Status badges
Priority indicators
Completion checkmarks

Smart Features

Intelligent Grouping
- By feature area
- By sprint/milestone
- By assigned developer
- By priority
Progress Tracking
- Overall completion
- Sprint velocity
- Burndown indication
- Time tracking
Formatting Options
- GitHub-flavored markdown
- Task checkboxes
- Collapsible sections
- Table format available

Example Output

## 🚀 Current Sprint

### In Progress
- [ ] 🔄 #5 **Implement user authentication** (60% complete)
  - Dependencies: API design (#3 ✅)
  - Subtasks: 4 (2 completed)
  - Est: 8h / Spent: 5h

### Pending (High Priority)
- [ ] ⚡ #8 **Create dashboard UI**
  - Blocked by: #5
  - Complexity: High
  - Est: 12h

Customization

Based on arguments:

Include/exclude sections
Detail level control
Custom grouping
Filter by criteria

Post-Sync

After generation:

Show diff preview
Backup existing README
Write new content
Commit reminder
Update timestamp

Integration

Read the full file on GitHub · 117 lines

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.

2d ago First seen · 117 lines · 0 tokens per session scan A a22ca9aa463c

Subscribe to this mod's changes

sync-readme is a command published in the GitHub repository snarktank/code-editing-agent (24 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 553 tokens. A static security scan graded it A with 0 findings. It is 100% identical to sync-readme, differing in 0 lines, and is treated as a copy.

Documents Project management Writing and docs

sync-readme