Obsidian CLI

Comande seu cofre.

Tudo o que você pode fazer no Obsidian também pode fazer pela linha de comando.

terminal
# Abrir a nota diária de hoje
obsidian daily

# Pesquisar no seu cofre
obsidian search query="notas da reunião"

# Adicionar uma tarefa à sua nota diária
obsidian daily:append content="- [ ] Comprar mantimentos"

Casos de uso

Obsidian CLI é um playground programável para texto sem formatação.

Desenvolva.
Crie plugins e temas mais rápido. Edite código, recarregue, teste e depure sem sair do terminal.
Colabore.
Implante documentação, sincronize cofres compartilhados com servidores e integre o Obsidian à cadeia de ferramentas da sua equipe.
Automatize.
Orquestre seu fluxo de trabalho com tarefas cron, scripts de shell e integrações personalizadas. Se você consegue criar um script, consegue fazer.
Experimente.
Leia, pesquise e escreva no seu cofre de forma programática. Dê a ferramentas agentic a capacidade de interagir com seu cofre.

Comece agora

Instale o Obsidian CLI

01

Atualize o Obsidian

Baixe o instalador mais recente do Obsidian. Baixar →

02

Ative a CLI

Ative Interface de linha de comando em ConfiguraçõesGeral.

03

Registre a CLI

Siga as instruções na tela para adicionar a CLI ao PATH do seu sistema. Reinicie o terminal para que as alterações entrem em vigor.

O registro adiciona o binário do Obsidian ao seu PATH via ~/.zprofile. Se você usa bash ou fish, adicione o caminho à configuração do seu shell manualmente.

~/.zprofile
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"

O instalador adiciona um redirecionador de terminal Obsidian.com ao lado de Obsidian.exe. Isso é necessário porque o Obsidian é executado como um aplicativo de interface gráfica.

AppImage: Um link simbólico é criado em /usr/local/bin/obsidian (requer sudo). Se o sudo falhar, usa ~/.local/bin como alternativa.

Flatpak: Um link simbólico é criado automaticamente. Se falhar, crie um manualmente apontando para a exportação do Flatpak.

Execute seu primeiro comando

Depois de instalado, está tudo pronto. Observe que o aplicativo Obsidian precisa estar aberto.

Execute um comando

terminal
# Mostrar ajuda
obsidian help

Use o modo TUI

terminal
# Abrir TUI (com autocompletar)
obsidian

Exemplos

Veja em ação

Confira exemplos práticos, desde anotações do dia a dia até automações para desenvolvedores.

terminal
# Abrir a nota diária de hoje
obsidian daily

# Adicionar uma tarefa à sua nota diária
obsidian daily:append content="- [ ] Comprar mantimentos"

# Pesquisar no seu cofre
obsidian search query="notas da reunião"

# Ler o arquivo atual
obsidian read

# Listar todas as tarefas da nota diária
obsidian tasks daily

# Criar uma nova nota a partir de um modelo
obsidian create name="Viagem para Paris" template=Viagem

# Ver todas as etiquetas com frequência
obsidian tags counts

# Comparar duas versões de um arquivo
obsidian diff file=README from=1 to=3
terminal
# Abrir DevTools
obsidian devtools

# Recarregar plugin em desenvolvimento
obsidian plugin:reload my-plugin

# Capturar captura de tela do aplicativo
obsidian dev:screenshot file=shot.png

# Executar JavaScript
obsidian eval "app.vault.getFiles().length"

# Revisar erros de JS
obsidian dev:errors

# Inspecionar propriedades CSS
obsidian dev:css selector=".workspace"

# Consultar elementos do DOM
obsidian dev:dom selector=".nav"
terminal
#!/bin/bash
# Automação da rotina da manhã

# Abrir a nota diária de hoje
obsidian daily

# Adicionar tarefas de rotina
obsidian daily:append content="- [ ] Revisar caixa de entrada"
obsidian daily:append content="- [ ] Verificar calendário"

# Copiar arquivos recentes para a área de transferência
obsidian files sort=modified limit=5 --copy

# Verificar links não resolvidos
obsidian unresolved

# Pesquisar em um cofre específico e exportar como JSON
obsidian search query="status::active" vault="Notas" format=json

Atalhos de teclado

Atalhos de teclado

Atalhos práticos e autocompletar integrados à TUI.

Navegação

Mover para a esquerda / Ctrl+B
Mover para a direita / Ctrl+F
Início da linha Ctrl+A
Fim da linha Ctrl+E
Palavra anterior Alt+B
Próxima palavra Alt+F

Edição

Excluir até o início da linha Ctrl+U
Excluir até o fim da linha Ctrl+K
Excluir palavra anterior Ctrl+W / Alt+⌫
Aceitar sugestão Tab
Dispensar sugestões Shift+Tab
Aceitar primeira sugestão

Geral

Comando anterior / Ctrl+P
Próximo comando / Ctrl+N
Pesquisar histórico Ctrl+R
Cancelar Escape
Limpar tela Ctrl+L
Sair Ctrl+C / Ctrl+D

Sync

Headless Sync

Execute Obsidian Sync sem interface gráfica. Toda a velocidade, privacidade e criptografia de ponta a ponta do Obsidian Sync, em qualquer servidor ou ambiente automatizado.

  • Automatize backups remotos.
  • Automatize a publicação de um site.
  • Dê a ferramentas agentic acesso a um cofre sem dar acesso ao seu computador inteiro.
  • Sincronize um cofre compartilhado da equipe com um servidor que alimenta outras ferramentas.
  • Execute automações agendadas — agregue notas diárias em resumos semanais, adicione etiquetas automaticamente e mais.

Comece agora

Aprenda a instalar e usar o Obsidian CLI.