Skip to content

README.md

Latest commit

 

History

History
127 lines (88 loc) · 3.57 KB

README.md

File metadata and controls

127 lines (88 loc) · 3.57 KB

notecli

Misskey をヘッドレスで操作する Rust ライブラリ & CLI デーモン。

GUI なしで Misskey の主要機能（タイムライン取得、投稿、リアクション、ストリーミング等）を CLI または REST API 経由で利用できます。NoteDeck の Rust バックエンドとしても利用されています。

インストール

GitHub Releases（ビルド済みバイナリ）

Releases からプラットフォームに合ったバイナリをダウンロードできます。

ファイル名 対象
notecli-linux-amd64 Linux x86_64
notecli-linux-arm64 Linux aarch64
notecli-darwin-amd64 macOS Intel
notecli-darwin-arm64 macOS Apple Silicon
notecli-windows-amd64.exe Windows x86_64 
# 例: Linux x86_64
curl -Lo notecli https://github.com/hitalin/notecli/releases/latest/download/notecli-linux-amd64
chmod +x notecli
sudo mv notecli /usr/local/bin/

Nix Flake

# そのまま実行
nix run github:hitalin/notecli

# プロファイルにインストール
nix profile install github:hitalin/notecli

Cargo（ソースからビルド）

cargo install --git https://github.com/hitalin/notecli.git

使いかた

# 1. アカウント登録（ブラウザで MiAuth 認証）
notecli login misskey.io

# 2. タイムラインを見る
notecli tl

# 3. ノートを投稿
notecli post "Hello from notecli!"

CLI

全コマンド・オプションは notecli --help で確認できます。各サブコマンドにも --help があります。

notecli --help            # コマンド一覧・出力形式・使用例
notecli post --help       # サブコマンドの詳細

HTTP API

デーモン起動後、localhost:19820 で REST API を提供します。

TOKEN=$(cat ~/.local/share/notecli/api-token)

# エンドポイント一覧（認証不要）
curl http://localhost:19820/api

# アカウント一覧（認証不要）
curl http://localhost:19820/api/accounts

# タイムライン
curl -H "Authorization: Bearer $TOKEN" http://localhost:19820/api/{host}/timeline/home

# ノート投稿
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"text": "Hello from notecli!"}' \
  http://localhost:19820/api/{host}/note

# SSE イベントストリーム
curl -N -H "Authorization: Bearer $TOKEN" http://localhost:19820/api/events

全エンドポイントは /api で確認できます（認証不要）:

curl http://localhost:19820/api

ライブラリとして使う

[dependencies]
notecli = { git = "https://github.com/hitalin/notecli.git" }
use notecli::streaming::FrontendEmitter;

// FrontendEmitter を実装すればストリーミングイベントを任意の宛先に転送可能
struct MyEmitter;
impl FrontendEmitter for MyEmitter {
    fn emit(&self, event: &str, payload: serde_json::Value) {
        println!("[{event}] {payload}");
    }
}

モジュール構成は ARCHITECTURE.md を参照してください。

認証

起動ごとにランダムトークンを生成し {data_dir}/api-token に書き出します（Unix: 0600）。 /api と /api/accounts 以外の全リクエストに Authorization: Bearer {token} ヘッダーが必要です。

アカウントの API トークンは OS のキーチェーン（Linux: Secret Service、macOS: Keychain、Windows: Credential Manager）に保存されます。

License

MIT