---
title: はじめに
description: commentor の API と CLI で文書を共有し、コメントを扱うための入口。
---

commentor は、HTML の文書にコメントを付けて共有するサービスです。API と CLI を使うと、文書を作成し、コメントを読み書きし、題名・共有先・版をプログラムから操作できます。

社外のアカウントによる利用は準備中です。公開サイトの例は、組織内の利用を前提にしています。

## 最初に読むページ

1. [ログインと個人トークン](/login)：CLI のログイン、範囲、保存、取り消し。
2. [トークンと認証](/auth)：API の認証方式、要求の形、失敗したときの見方。
3. [CLI（cr）](/cr)：文書、コメント、共有を操作するコマンド。
4. [API リファレンス](/reference)：操作ごとの項目、応答、エラー。
5. [エラーと対処](/errors)：よく返るエラーと対処方法。

## できること

| やりたいこと | 主な操作 | 読むページ |
|---|---|---|
| HTML の文書を配信する | `POST /api/reviews/import-html`、`cr docs upload` | [文書を上げる](/guides/upload) |
| 文書とコメントを読む | `GET /api/reviews`、`cr docs list`、`cr comments list` | [コメントを読む](/guides/read-comments) |
| コメントを書き、返信し、解決する | `POST /api/reviews/{reviewId}/comments`、`cr comments add` | [コメントを扱う](/guides/agent-comments) |
| 指摘を反映して版を追加する | `POST /api/reviews/{reviewId}/import-html`、`cr docs add-version` | [反映して版を上げる](/guides/apply-and-version) |
| 題名・タグ・共有先を変える | `PATCH /api/reviews/{reviewId}/meta`、`cr share`、`cr invite` | [共有を管理する](/guides/manage) |

## API の定義を読む

操作ごとの要求項目・応答・エラーは、サイトの `/openapi.json`（OpenAPI 3.1）にまとまっています。AI エージェントへ渡す場合は `/llms.txt` または `/llms-full.txt` を使えます。

各ページの URL に `.md` を付けると、説明を Markdown として取得できます。認証方式や個人トークンの範囲は、操作の `security` と [トークンと認証](/auth)を合わせて確認してください。