cli-anything-obsidian

O que cli-anything-obsidian faz?

Gerenciamento de conhecimento e anotações via API REST local do Obsidian. Projetado para agentes de IA e usuários avançados que precisam gerenciar notas, pesquisar no vault e executar comandos sem a interface gráfica.

Instalação

Este CLI é instalado como parte do pacote cli-anything-obsidian:

pip install cli-anything-obsidian

Pré-requisitos:

• Python 3.10+
• O Obsidian deve estar instalado e em execução com o plugin Local REST API habilitado

Uso

Comandos Básicos

# Mostrar ajuda
cli-anything-obsidian --help

# Iniciar modo REPL interativo
cli-anything-obsidian

# Listar arquivos do vault
cli-anything-obsidian vault list

# Executar com saída JSON (para consumo por agentes)
cli-anything-obsidian --json vault list

Modo REPL

Quando invocado sem um subcomando, o CLI entra em uma sessão REPL interativa:

cli-anything-obsidian
# Digite comandos interativamente com autocompletar e histórico

Grupos de Comandos

Vault

Comandos de gerenciamento de arquivos do vault.

Comando	Descrição
list	Listar arquivos no vault ou em um subdiretório
read	Ler o conteúdo de uma nota
create	Criar uma nova nota
update	Sobrescrever uma nota existente
delete	Deletar uma nota do vault
append	Adicionar conteúdo ao final de uma nota existente

Search

Comandos de pesquisa no vault.

Comando	Descrição
query	Pesquisar usando sintaxe de consulta do Obsidian
simple	Pesquisa de texto simples em todo o vault

Note

Comandos para nota ativa.

Comando	Descrição
active	Obter a nota atualmente ativa no Obsidian
open	Abrir uma nota no editor do Obsidian

Command

Comandos da paleta de comandos do Obsidian.

Comando	Descrição
list	Listar todos os comandos disponíveis do Obsidian
execute	Executar um comando pelo seu ID

Server

Comandos de status e informações do servidor.

Comando	Descrição
status	Verificar se a API REST Local do Obsidian está em execução

Session

Comandos de estado da sessão.

Comando	Descrição
status	Mostrar estado atual da sessão

Exemplos

Listar e Ler Notas

# Listar todos os arquivos do vault
cli-anything-obsidian vault list

# Listar arquivos em um subdiretório
cli-anything-obsidian vault list "Daily Notes"

# Ler uma nota
cli-anything-obsidian vault read "Projects/my-project.md"

Criar e Atualizar Notas

# Criar uma nova nota
cli-anything-obsidian vault create "Projects/new-project.md" --content "# Novo Projeto"

# Atualizar (sobrescrever) uma nota
cli-anything-obsidian vault update "Projects/new-project.md" --content "# Conteúdo Atualizado"

# Adicionar ao final de uma nota
cli-anything-obsidian vault append "Projects/new-project.md" --content "\n## Nova Seção"

Pesquisar

# Pesquisa de texto simples (GET /search/simple/)
cli-anything-obsidian search simple "notas de reunião"

# Consulta DQL do Dataview — padrão --type dql, enviada como
# application/vnd.olrapi.dataview.dql+txt
cli-anything-obsidian search query 'TABLE file.link FROM "Projects"'

# Consulta JsonLogic — application/vnd.olrapi.jsonlogic+json
cli-anything-obsidian search query --type jsonlogic \
  '{"==":[{"var":"frontmatter.status"},"active"]}'

Comandos

# Listar comandos disponíveis
cli-anything-obsidian command list

# Executar um comando pelo ID
cli-anything-obsidian command execute "editor:toggle-bold"

Sessão REPL Interativa

Inicie uma sessão interativa para uso exploratório.

cli-anything-obsidian
# Digite comandos interativamente
# Use 'help' para ver comandos disponíveis

Configuração da Chave da API

# Via flag
cli-anything-obsidian --api-key SUA_CHAVE vault list

# Via variável de ambiente (recomendado para agentes)
export OBSIDIAN_API_KEY=SUA_CHAVE
cli-anything-obsidian vault list

Gerenciamento de Estado

O CLI mantém estado de sessão leve:

• Chave da API: Configurável via --api-key ou variável de ambiente OBSIDIAN_API_KEY
• URL do host: Padrão https://localhost:27124; configurável via --host

Formatos de Saída

Todos os comandos suportam dois modos de saída:

• Legível por humanos (padrão): Tabelas, cores, texto formatado
• Legível por máquina (flag --json): JSON estruturado para consumo por agentes

# Saída humana
cli-anything-obsidian vault list

# Saída JSON para agentes
cli-anything-obsidian --json vault list

Para Agentes de IA

Ao usar este CLI programaticamente:

1. Sempre use a flag --json para saída analisável
2. Verifique os códigos de retorno - 0 para sucesso, diferente de zero para erros
3. Analise o stderr para mensagens de erro em caso de falha
4. Defina a variável de ambiente OBSIDIAN_API_KEY para evitar passar --api-key em cada chamada
5. Verifique se o Obsidian está em execução com server status antes de outros comandos

Mais Informações

• Documentação completa: Consulte README.md no pacote
• Cobertura de testes: Consulte TEST.md no pacote
• Metodologia: Consulte HARNESS.md no cli-anything-plugin

Versão

1.1.0