cli-anything-siyuan

O que cli-anything-siyuan faz?

Interface de linha de comando para o SiYuan (思源笔记), um aplicativo de anotações e gestão de conhecimento focado em privacidade.

Esta CLI conecta-se a um kernel SiYuan em execução por meio de sua API HTTP (http://127.0.0.1:6806) e fornece acesso estruturado a cadernos, documentos, blocos, pesquisa e exportação.

Pré-requisitos

• O SiYuan deve estar em execução (Configurações → Sobre mostra o token da API)
• Python 3.10+
• Instalação: pip install cli-anything-siyuan ou pip install -e . a partir de agent-harness/

Grupos de Comandos

notebook — Gerenciamento de cadernos

Subcomando	Descrição
list	Listar todos os cadernos
create <nome>	Criar um novo caderno
rename <id> <nome>	Renomear um caderno
remove <id>	Excluir um caderno
open <id>	Abrir um caderno

doc — Gerenciamento de documentos

Subcomando	Descrição
create <caderno> <caminho> [--md "conteúdo"]	Criar um documento
list <caderno> [caminho]	Listar documentos
tree <caderno> [--path / --depth]	Exibir árvore de documentos
get <id>	Obter caminho do documento pelo ID
rename <id> <título>	Renomear um documento
remove <id>	Excluir um documento

block — Operações em blocos

Subcomando	Descrição
insert <dados> [--previous / --parent]	Inserir um bloco
update <id> <dados>	Atualizar um bloco
delete <id>	Excluir um bloco
get <id>	Obter fonte kramdown do bloco
children <id>	Obter blocos filhos

Outros comandos

Comando	Descrição
sql <consulta>	Executar SQL no banco de blocos
search <consulta>	Pesquisa de texto completo nos blocos
export md <doc-id>	Exportar documento como Markdown
tag list	Listar todas as tags
version	Exibir versão do kernel SiYuan
status	Exibir status da conexão e da sessão
repl	Iniciar REPL interativo

Orientação para Agentes

• Sempre use --json para saída legível por máquina
• Pesquisa avançada: use sql "SELECT * FROM blocks WHERE content LIKE '%palavra-chave%'" para acesso a nível SQL
• IDs de documentos têm o formato 20210817205410-2kvfpfn (baseado em timestamp)
• O token da API pode ser encontrado em Configurações do SiYuan → Sobre
• Endereço padrão de conexão: http://127.0.0.1:6806

Exemplos

# Listar cadernos (JSON)
cli-anything-siyuan --json notebook list

# Criar um documento com Markdown (flag --md, cuidado com escaping do shell)
cli-anything-siyuan doc create nb1 /projects/new --md "## Título\n\nConteúdo"

# Criar um documento — passar Markdown via stdin (evita escaping do shell)
# PowerShell here-string (literal, sem necessidade de escaping):
@'
## Título
Conteúdo com `backticks` e (parênteses) e "aspas"
'@ | cli-anything-siyuan doc create nb1 /projects/new --md -

# Bash heredoc:
# cat <<'EOF' | cli-anything-siyuan doc create nb1 /projects/new --md -
# ## Título
# Conteúdo com `backticks` e (parênteses)
# EOF

# Pesquisa SQL
cli-anything-siyuan sql "SELECT id, content FROM blocks WHERE content LIKE '%reunião%' LIMIT 5"

# Exportação
cli-anything-siyuan export md doc123

# Iniciar REPL
cli-anything-siyuan

Tratamento de Erros

• Erros de conexão: verifique se o SiYuan está em execução e se o token da API está correto
• Erros da API: retornados como {"code": N, "msg": "..."} — verifique o campo message
• Erros de autenticação: verifique o token em ~/.siyuan-cli.json ou na variável de ambiente SIYUAN_TOKEN