cli-anything-joplin

O que cli-anything-joplin faz?

Use esta habilidade para automatizar fluxos de trabalho de cadernos, notas, tarefas, etiquetas, anexos, busca, sincronização e importação/exportação do Joplin por meio de um invólucro com estado que utiliza o binário real do terminal joplin.

Requisitos

• Python 3.10+
• Binário do terminal Joplin disponível como joplin
• Opcional: use --profile para direcionar um perfil específico do Joplin

Instalação

cd joplin/agent-harness
pip install -e .

Uso

# Modo REPL (padrão)
cli-anything-joplin

# Comando único legível por máquina
cli-anything-joplin --json notebooks list

# Projeto com estado
cli-anything-joplin project new --name demo -o ./demo.joplin-harness.json
cli-anything-joplin --project ./demo.joplin-harness.json notes create "Nota de reunião"

# Simulação (sem salvamento automático)
cli-anything-joplin --json --dry-run --project ./demo.joplin-harness.json notes create temp

Contrato de saída JSON

Quando --json está ativado, os comandos retornam:

• ok: booleano
• command: identificador de comando estável, como notes.list, todos.toggle
• data: payload do comando
• error: null em caso de sucesso, ou { type, message } em caso de falha

Grupos de comandos

• 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

Orientações para o agente

• Prefira --json para saída parseável.
• Use --project ao executar fluxos de múltiplas etapas para que o histórico seja persistido.
• Comandos de mutação únicos salvam automaticamente o projeto, a menos que --dry-run esteja definido.
• O modo REPL não salva automaticamente; execute project save explicitamente.
• Algumas compilações do CLI do Joplin bloqueiam a search atrás do modo GUI; se você vir "only available in GUI mode", trate a busca como melhor esforço.
• O Joplin 3.6.x pode ter um comando version quebrado em layouts globais do npm; o invólucro recorre aos metadados do pacote instalado para backend version, sondando o diretório do binário resolvido por symlink, o node_modules/joplin irmão no estilo Windows, o lib/node_modules/joplin pai no estilo Unix e, por fim, npm root -g.
• O stdout/stderr do backend nos resultados dos comandos são literais; não presuma que avisos foram removidos dos corpos das notas ou exportações.
• Em caso de falha, analise error usando o mesmo campo command que no sucesso (config.import_file, e2ee.decrypt_file). Subcomandos com várias palavras usam um único ponto entre o grupo e o subcomando.

Fluxo de teste

# Ciclo de feedback rápido
python -m pytest -q cli_anything/joplin/tests/test_core.py
python -m pytest -q cli_anything/joplin/tests/test_full_e2e.py::TestCLISubprocess

# Backend real (joplin deve estar no 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

# Suíte completa
python -m pytest -v --tb=no cli_anything/joplin/tests

# Verificar o ponto de entrada do script de console instalado
CLI_ANYTHING_FORCE_INSTALLED=1 python -m pytest -v -s cli_anything/joplin/tests/test_full_e2e.py

Linha de base de validação atual (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