cli-anything-joplin

cli-anything-joplin は何をしますか？

このスキルを使用すると、実際の joplin ターミナルバイナリをバックエンドとする状態管理可能なハーネスを通じて、Joplin のノートブック、ノート、ToDo、タグ、添付ファイル、検索、同期、インポート/エクスポートワークフローを自動化できます。

必要条件

• Python 3.10+
• Joplin ターミナルバイナリが joplin として利用可能であること
• オプション: 特定の Joplin プロファイルをターゲットにする場合は --profile を渡す

インストール

cd joplin/agent-harness
pip install -e .

使用法

# REPL モード（デフォルト）
cli-anything-joplin

# マシンリーダブルなワンショットコマンド
cli-anything-joplin --json notebooks list

# 状態管理可能なプロジェクト
cli-anything-joplin project new --name demo -o ./demo.joplin-harness.json
cli-anything-joplin --project ./demo.joplin-harness.json notes create "ミーティングノート"

# ドライラン（自動保存なし）
cli-anything-joplin --json --dry-run --project ./demo.joplin-harness.json notes create temp

JSON 出力コントラクト

--json が有効な場合、コマンドは以下を返します:

• ok: ブール値
• command: notes.list、todos.toggle などの安定したコマンド識別子
• data: コマンドのペイロード
• error: 成功時は null、失敗時は { type, message }

コマンドグループ

• project: new、open、save、info、json、status
• notebooks: list、create、use、remove
• notes: list、create、set、get、remove、copy、move、rename
• todos: list、create、toggle、clear、done、undone
• tags: list、add、remove、notetags、tagnotes
• search: run
• sync: run (--target、--upgrade、--use-lock)
• interop: import、export
• config: get、set、list、export、import-file
• attach: add
• status: show、restore
• backend: version、dump、keymap、geoloc、export-sync-status
• server: status、start、stop
• e2ee: status、target-status、decrypt、decrypt-file
• session: status、undo、redo、history

エージェント向けガイダンス

• 解析可能な出力を得るには --json を使用することを推奨します。
• マルチステップワークフローを実行する際は --project を使用して履歴を永続化してください。
• ワンショットの変更コマンドは、--dry-run が設定されていない限りプロジェクトを自動保存します。
• REPL モードは自動保存しません。明示的に project save を実行してください。
• 一部の Joplin CLI ビルドでは、search が GUI モードの後ろにゲートされています。"only available in GUI mode" が表示された場合は、検索をベストエフォートとして扱ってください。
• Joplin 3.6.x では、npm のグローバルレイアウトで version コマンドが壊れている可能性があります。ハーネスはインストール済みパッケージのメタデータにフォールバックして backend version を実行し、シンボリックリンクを解決したバイナリディレクトリ、Windows スタイルの兄弟 node_modules/joplin、Unix スタイルの親 lib/node_modules/joplin、そして最終的に npm root -g をプローブします。
• バックエンドの stdout/stderr はコマンド結果にそのまま含まれます。警告がノート本文やエクスポートから削除されたと想定しないでください。
• エラー発生時は、成功時と同じ command フィールド（config.import_file、e2ee.decrypt_file）を使用して error を解析してください。複数単語のサブコマンドはグループとサブコマンドの間に単一のドットを使用します。

テストワークフロー

# クイックフィードバックループ
python -m pytest -q cli_anything/joplin/tests/test_core.py
python -m pytest -q cli_anything/joplin/tests/test_full_e2e.py::TestCLISubprocess

# 実際のバックエンド（joplin が PATH にあること）
python -m pytest -v cli_anything/joplin/tests/test_full_e2e.py::TestBackendCommands
python -m pytest -v cli_anything/joplin/tests/test_full_e2e.py::TestBackendWorkflows
python -m pytest -v cli_anything/joplin/tests/test_full_e2e.py::TestBackendIntegration

# 全スイート
python -m pytest -v --tb=no cli_anything/joplin/tests

# インストールされたコンソールスクリプトのエントリポイントを確認
CLI_ANYTHING_FORCE_INSTALLED=1 python -m pytest -v -s cli_anything/joplin/tests/test_full_e2e.py

現在の検証ベースライン（Windows + Joplin CLI 3.6.2）:

• python -m pytest -q cli_anything/joplin/tests/test_core.py -> 107 passed
• python -m pytest -q cli_anything/joplin/tests -> 134 passed, 1 skipped