無料GitHub で公開

api-docs

Document a module or public API surface (functions, classes, CLI commands, endpoints) from the code itself. Use when the user asks for API reference, to document a module, or to write usage docs for a public interface.

omnigent-ai/omnigent

インストール方法を見る

含まれるファイル（1）

SKILL.md2.0 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

api-docs — document a public API surface from the code

Produce reference docs that match the code exactly, derived from the source, not from assumptions about what the API "probably" does.

Read the surface

Identify the public surface to document (a module, class, CLI command group, or set of endpoints). Then have the researcher read it carefully:

Dispatch the researcher (purpose: explore) to enumerate the public entry points and report each one's real signature, parameters, defaults, return shape, and raised errors — with file:line evidence.
Prefer what the code declares (signatures, type hints, docstrings, default values) over prose descriptions. Public vs. private follows the project's convention (e.g. a leading underscore, or an __all__ / export list).

Structure

For each entry point:

### `<name>(<signature>)`

<one-line summary of what it does>

**Parameters**
- `<name>` (`<type>`, default `<value>`) — <meaning>

**Returns** — `<type>`: <meaning>

**Raises** — `<Error>`: <when>

**Example**
```
<minimal, runnable usage>
```

Write the entries

Keep the summary to one line; put detail in the parameter and example sections.
Document every public parameter, including defaults, in the order they appear in the signature.
Give one minimal example per entry point that actually runs against the documented signature.
Do not document private/internal helpers unless the user asks; a reference is the contract, not a code tour.

Verify

Signatures, defaults, and error types drift fastest, so route the finished reference through the reviewer (purpose: review) to confirm every signature and default matches the current code.

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインしてレビューを書く

同じリポジトリのスキル

概要と使いどころ

antigravity-native-e2e-dev

無料

Spin up a live local Omnigent server + runner and exercise the native Antigravity (agy) TUI harness (antigravity-native) end-to-end — launch the real `agy` CLI via `omnigent antigravity`, drive turns through the web UI, smoke-test, and bug-bash. Load when developing, testing, or debugging the antigravity-native harness (omnigent/inner/antigravity_native_executor.py, omnigent/antigravity_native.py, antigravity_native_bridge.py, antigravity_native_rpc.py, antigravity_native_reader.py, antigravity_native_launch.py) or its agy launch / RPC mirror / tmux delivery / OAuth / MCP-relay behavior. NOT the in-process `antigravity` Gemini SDK harness.

日本語の概要は準備中です。原文の説明を表示しています。