Skip to content

Commit 830136d

Browse files
hitalinclaude
andcommitted
docs: README から陳腐化しやすい詳細リストを削除し自己文書化ソースへ誘導
CLI コマンド一覧・HTTP エンドポイント表・モジュール構成表を削除し、 `--help`、`/api`、ARCHITECTURE.md へ誘導する形に変更。 開発中にコマンドやエンドポイントが増減しても README が乖離しなくなる。 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1ae572b commit 830136d

1 file changed

Lines changed: 9 additions & 112 deletions

File tree

README.md

Lines changed: 9 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -56,88 +56,11 @@ notecli post "Hello from notecli!"
5656

5757
## CLI
5858

59-
### アカウント管理
59+
全コマンド・オプションは `notecli --help` で確認できます。各サブコマンドにも `--help` があります。
6060

6161
```sh
62-
notecli login misskey.io # MiAuth でアカウント登録
63-
notecli accounts # 登録済みアカウント一覧
64-
notecli logout @user@misskey.io # アカウント削除
65-
```
66-
67-
### ノート操作
68-
69-
```sh
70-
notecli post "Hello!" [--cw TEXT] [--visibility home] [--reply-to ID] [--local-only]
71-
notecli note <ID> # ノート詳細
72-
notecli update <ID> "新しいテキスト" [--cw TEXT] # ノート編集
73-
notecli delete <ID> # ノート削除
74-
notecli renote <ID> # リノート(ブースト)
75-
```
76-
77-
### タイムライン・検索
78-
79-
```sh
80-
notecli tl [home|local|social|global] [-l 20] # タイムライン取得
81-
notecli search "キーワード" [-l 20] # 全文検索
82-
notecli replies <ID> [-l 20] # 返信一覧
83-
notecli thread <ID> [-l 20] # 会話スレッド
84-
```
85-
86-
### 通知・メンション
87-
88-
```sh
89-
notecli notifications [-l 20] # 通知一覧
90-
notecli mentions [-l 20] # メンション一覧
91-
```
92-
93-
### リアクション
94-
95-
```sh
96-
notecli react <NOTE_ID> ":star:" # リアクション追加
97-
notecli unreact <NOTE_ID> # リアクション削除
98-
```
99-
100-
### ユーザー操作
101-
102-
```sh
103-
notecli user @user@host # ユーザー詳細
104-
notecli user-notes <USER_ID> [-l 20] # ユーザーのノート一覧
105-
notecli follow <USER_ID> # フォロー
106-
notecli unfollow <USER_ID> # フォロー解除
107-
```
108-
109-
### お気に入り
110-
111-
```sh
112-
notecli favorite <NOTE_ID> # お気に入り追加
113-
notecli unfavorite <NOTE_ID> # お気に入り削除
114-
notecli favorites [-l 20] # お気に入り一覧
115-
```
116-
117-
### その他
118-
119-
```sh
120-
notecli emojis # カスタム絵文字一覧
121-
notecli daemon [--port 19820] # HTTP APIサーバー起動
122-
```
123-
124-
### 共通オプション
125-
126-
| オプション | 説明 |
127-
|-----------|------|
128-
| `--account / -a` | 操作するアカウントを指定 |
129-
| `--json` | JSON 配列/オブジェクトで出力 |
130-
| `--jsonl` | NDJSON 出力(jq 向け) |
131-
| `--compact / -c` | TSV 1行1レコード(fzf/grep 向け) |
132-
| `--ids` | ID のみ出力(パイプ/xargs 向け) |
133-
134-
### Unix ツール連携
135-
136-
```sh
137-
notecli tl -c | fzf --with-nth=2.. | cut -f1 | xargs -I{} notecli react {} :star:
138-
notecli tl --ids -l 5 | xargs -I{} notecli react {} :thumbsup:
139-
notecli tl --jsonl | jq -r 'select(.user.username == "taka") | .id'
140-
notecli tl -c -l 100 | grep "Rust" | cut -f1
62+
notecli --help # コマンド一覧・出力形式・使用例
63+
notecli post --help # サブコマンドの詳細
14164
```
14265

14366
## HTTP API
@@ -165,26 +88,11 @@ curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/jso
16588
curl -N -H "Authorization: Bearer $TOKEN" http://localhost:19820/api/events
16689
```
16790

168-
### エンドポイント一覧
169-
170-
| メソッド | パス | 説明 |
171-
|---------|------|------|
172-
| GET | `/api` | エンドポイント一覧 + トークンパス |
173-
| GET | `/api/accounts` | アカウント一覧 |
174-
| GET | `/{host}/timeline/{type}` | タイムライン取得 |
175-
| GET | `/{host}/notifications` | 通知取得 |
176-
| POST | `/{host}/note` | ノート投稿 |
177-
| GET | `/{host}/notes/{id}` | ノート詳細 |
178-
| DELETE | `/{host}/notes/{id}` | ノート削除 |
179-
| GET | `/{host}/notes/{id}/children` | リプライ一覧 |
180-
| GET | `/{host}/notes/{id}/conversation` | 会話スレッド |
181-
| GET | `/{host}/notes/{id}/reactions` | リアクション一覧 |
182-
| POST | `/{host}/notes/{id}/reactions` | リアクション追加 |
183-
| DELETE | `/{host}/notes/{id}/reactions` | リアクション削除 |
184-
| GET | `/{host}/users/{id}` | ユーザー詳細 |
185-
| GET | `/{host}/users/{id}/notes` | ユーザーのノート |
186-
| GET | `/{host}/search?q=...` | ノート検索 |
187-
| GET | `/events` | SSE イベントストリーム |
91+
全エンドポイントは `/api` で確認できます(認証不要):
92+
93+
```sh
94+
curl http://localhost:19820/api
95+
```
18896

18997
## ライブラリとして使う
19098

@@ -205,18 +113,7 @@ impl FrontendEmitter for MyEmitter {
205113
}
206114
```
207115

208-
### モジュール構成
209-
210-
| モジュール | 役割 |
211-
|-----------|------|
212-
| `api` | Misskey HTTP API クライアント |
213-
| `db` | SQLite データベース(WAL、FTS5 全文検索) |
214-
| `streaming` | WebSocket ストリーミング(自動再接続) |
215-
| `http_server` | Axum HTTP API サーバー |
216-
| `event_bus` | tokio broadcast ベースの pub/sub |
217-
| `models` | データモデル(Raw → Normalized 変換) |
218-
| `keychain` | OS ネイティブ資格情報ストレージ |
219-
| `error` | 統一エラー型 |
116+
モジュール構成は [ARCHITECTURE.md](ARCHITECTURE.md) を参照してください。
220117

221118
## 認証
222119

0 commit comments

Comments
 (0)