update-docs

A command for reviewing and updating three project README files so they match the current Rust codebase. It checks documentation against SDK, derive-macro, CLI, and generated client code.

In plain words
What is it for?
Use it to update the SDK README, CLI README, and top-level README after code changes.
Why use it?
It helps prevent documentation from describing outdated commands, methods, examples, or features.

Command for Claude Code

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/flipbit03/lineark/update-docs
Clone the repo
git clone --depth 1 https://github.com/flipbit03/lineark

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 483 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00000 $0.00483
Opus 5 $0.00000 $0.00242
Sonnet 5 $0.00000 $0.00097
Haiku 4.5 $0.00000 $0.00048

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

Security

Grade A, and why

update-docs 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 yesterday.

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/update-docs.md · 35 lines

What it actually says

Review and update all project documentation to reflect the current codebase.

Documentation files to update (in order):

  1. crates/lineark-sdk/README.md — SDK crate README (published to crates.io)
  2. crates/lineark/README.md — CLI crate README (published to crates.io)
  3. README.md — Top-level project README (GitHub landing page)

Steps:

  1. Read all three README files listed above.
  2. Read these source files to understand the current state of the codebase:
    • crates/lineark-sdk/src/field_selection.rs — GraphQLFields trait, FieldCompatible
    • crates/lineark-sdk/src/lib.rs — public re-exports
    • crates/lineark-derive/src/lib.rs — derive macro capabilities
    • crates/lineark/src/commands/mod.rs — CLI command list
    • crates/lineark/src/commands/viewer.rs — example of lean type with full_type
    • crates/lineark-sdk/src/generated/client_impl.rs — available query/mutation methods
  3. For each README, check that:
    • Code examples compile against the current API (generic queries need turbofish or type inference)
    • All available commands/methods are listed
    • Feature descriptions match actual capabilities (e.g., compile-time validation, custom field selection, FullType constraints)
    • The three READMEs are consistent with each other (don't contradict)
  4. Update each README with accurate information. Keep the existing structure and tone. Don't bloat — be concise.
  5. Run cargo fmt if any code examples were changed.
  6. Report what changed in each file.

Key things to verify are accurate:

  • Query methods table (SDK README) — return types, generic signatures
  • Mutation methods table (SDK README) — generic signatures
  • CLI command table (top-level README + CLI README) — all subcommands listed
  • Custom field selection examples — #[graphql(full_type = X)], #[graphql(nested)] attributes
  • The search_issues return type is Connection<IssueSearchResult>, NOT Connection<Issue>
  • Mutations are generic: client.issue_create::<Issue>(input) or with type inference
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. yesterday First seen · 35 lines · 0 tokens per session scan A df09a364f71d

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository flipbit03/lineark (54 stars, last pushed 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 483 tokens. 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.