cli-anything-joplin

Was macht cli-anything-joplin?

Nutzen Sie diese Fähigkeit, um Joplin-Notizbücher, Notizen, Aufgaben, Tags, Anhänge, Suche, Synchronisation und Import/Export-Workflows über einen zustandsbehafteten Harness zu automatisieren, der auf dem echten joplin-Terminal-Binary basiert.

Voraussetzungen

• Python 3.10+
• Joplin-Terminal-Binary als joplin verfügbar
• Optional: --profile übergeben, um ein bestimmtes Joplin-Profil anzusprechen

Installation

cd joplin/agent-harness
pip install -e .

Verwendung

# REPL-Modus (Standard)
cli-anything-joplin

# Maschinenlesbarer Einmal-Befehl
cli-anything-joplin --json notebooks list

# Zustandsbehaftetes Projekt
cli-anything-joplin project new --name demo -o ./demo.joplin-harness.json
cli-anything-joplin --project ./demo.joplin-harness.json notes create "Besprechungsnotiz"

# Testlauf (kein automatisches Speichern)
cli-anything-joplin --json --dry-run --project ./demo.joplin-harness.json notes create temp

JSON-Ausgabe-Vertrag

Wenn --json aktiviert ist, geben Befehle Folgendes zurück:

• ok: boolesch
• command: stabiler Befehlsbezeichner wie notes.list, todos.toggle
• data: Befehlsnutzdaten
• error: null bei Erfolg, oder { type, message } bei Fehlschlag

Befehlsgruppen

• 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

Agenten-Hinweise

• Bevorzugen Sie --json für auswertbare Ausgabe.
• Verwenden Sie --project bei mehrschrittigen Workflows, damit der Verlauf gespeichert wird.
• Einmalige mutierende Befehle speichern das Projekt automatisch, es sei denn --dry-run ist gesetzt.
• Der REPL-Modus speichert nicht automatisch; führen Sie project save explizit aus.
• Einige Joplin-CLI-Builds schränken die search-Funktion auf den GUI-Modus ein; wenn Sie "only available in GUI mode" sehen, behandeln Sie die Suche als bestenfalls versuchsweise.
• Joplin 3.6.x kann einen defekten version-Befehl in npm-globalen Layouts haben; der Harness greift auf installierte Paketmetadaten für backend version zurück, indem er das symlink-aufgelöste Binary-Verzeichnis, das Windows-artige Geschwisterverzeichnis node_modules/joplin, das Unix-artige Elternverzeichnis lib/node_modules/joplin und schließlich npm root -g durchsucht.
• Backend-stdout/stderr in Befehlsergebnissen sind unverändert; gehen Sie nicht davon aus, dass Warnungen aus Notiztexten oder Exporten entfernt wurden.
• Parsen Sie bei Fehlschlag error mit dem gleichen command-Feld wie bei Erfolg (config.import_file, e2ee.decrypt_file). Mehrwort-Unterbefehle verwenden einen einzelnen Punkt zwischen Gruppe und Unterbefehl.

Test-Workflow

# Schnelle Rückmeldung
python -m pytest -q cli_anything/joplin/tests/test_core.py
python -m pytest -q cli_anything/joplin/tests/test_full_e2e.py::TestCLISubprocess

# Echtes Backend (joplin muss im PATH sein)
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

# Gesamte Testsuite
python -m pytest -v --tb=no cli_anything/joplin/tests

# Installierten Konsolenskript-Einstiegspunkt überprüfen
CLI_ANYTHING_FORCE_INSTALLED=1 python -m pytest -v -s cli_anything/joplin/tests/test_full_e2e.py

Aktuelle Validierungsbasis (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