Borrowing it
Nothing to install: this file belongs to iceymoss/go-hichat-api. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/iceymoss/go-hichat-api/main/.claude/commands/sync-api-docs.mdgit clone --depth 1 https://github.com/iceymoss/go-hichat-apiWrote 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.
[](https://agentmods.dev/commands/iceymoss/go-hichat-api/sync-api-docs)<a href="https://agentmods.dev/commands/iceymoss/go-hichat-api/sync-api-docs"><img src="https://agentmods.dev/badge/commands/iceymoss/go-hichat-api/sync-api-docs/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.
<a href="https://agentmods.dev/commands/iceymoss/go-hichat-api/sync-api-docs"><img src="https://agentmods.dev/badge/commands/iceymoss/go-hichat-api/sync-api-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.00000 | $0.00730 |
| Opus 5.5 | $0.00000 | $0.00292 |
| Sonnet 5.5 | $0.00000 | $0.00146 |
| Haiku 4.5 | $0.00000 | $0.00073 |
Grade A, and why
sync-api-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 2mo 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.
How it starts
The opening of the file, as written. The whole thing — 83 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Sync API Documentation
You are an API documentation generator for the go-hichat-api project. Your task is to read all Go-Zero .api definition files and generate a complete, up-to-date API reference document at docs/api.md.
Steps
1. Discover all .api files
Search for all .api files under the apps/ directory:
apps/user/api/user.apiapps/user/api/domain.apiapps/social/api/social.apiapps/im/api/im.apiapps/trend/api/trend.api- Any other
.apifiles that may have been added
Read every .api file found.
2. Parse and extract
From each .api file, extract:
- Service info: title, author, version from the
info()block - Routes: HTTP method, path, prefix, group, JWT requirement,
@docdescription, handler name, request type, response type - Type definitions: all
typeblocks including struct fields, JSON tags, comments, andoptionalmarkers
3. Generate docs/api.md
Generate a well-structured Chinese-language Markdown document with the following format:
# HiChat API Reference
> Auto-generated from `.api` definition files. Do not edit manually.
> Last synced: {current date YYYY-MM-DD}
## Table of Contents
(auto-generate based on services)
---
## User Service (`/api/v1/user`)
### POST /api/v1/user/register - User Registration
(description from @doc)
**Auth:** None / JWT Required
**Request Body:**
| Field | Type | Required | JSON Key | Description |
|-------|------|----------|----------|-------------|
| ... | ... | ... | ... | (from comments) |
**Response:**
| Field | Type | JSON Key | Description |
|-------|------|----------|-------------|
| ... | ... | ... | ... |
---
(repeat for each endpoint)
4. Documentation rules
- Group endpoints by service (User, Social, IM, Trend)
- Within each service, group by functional module (e.g., Friend management, Group management, Comment, Like)
- For each endpoint include: HTTP method, full path (prefix + path), description (
@doc), auth requirement, request fields, response fields - Mark fields as Required or Optional based on the
optionaltag in the.apifile - Include field comments from the
.apifile as description - Include shared/common type definitions (like
User,Friends,Groups,Discuss,Like,ChatLog,Conversation, etc.) in a separate Data Models section at the end - Use Chinese for descriptions where the source
.apicomments are in Chinese - For enum-like fields (e.g.,
sex: 0-unknown, 1-male, 2-female), include the value mapping from comments
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.
- 2mo ago First seen · 83 lines · 0 tokens per session scan A cf304d4d35ae
sync-api-docs is a command published in the GitHub repository iceymoss/go-hichat-api (42 stars, last pushed 2mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 730 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.
Other commands, from other repositories
init
Initialize configurations for Supabase local development.
http-service
Build, review or debug a Bun HTTP service. Loads the http-service skill, then works the task through its workflow.
build
Discover an AI Gateway's models and MCP tools, retrieve a credential, and integrate them into your app — call a model, connect MCP tools, or scaffold a runnable agent.
api-contract-review
Review an API contract (shapes, errors, auth model) BEFORE implementation for naming, versioning, pagination, idempotency, and fit with existing endpoints. Use when designing or changing endpoints. Do not use when the API is already implemented (use review-hard or repo-consistency-sweep).
start-10-1
A guided lesson on setting up clasp, a command-line tool for managing Google Apps Script projects, and connecting it to Google’s Apps Script API.
fastapi
FastAPI application design and implementation conventions. Use this skill when building, updating, or reviewing FastAPI services, routers, dependencies, request/response schemas, streaming endpoints, or API tests. Trigger on FastAPI-specific work such as path operation design, dependency injection, response models…