CLI

Visão geral

O CLI do Web2MD permite converter qualquer URL em Markdown limpo direto do seu terminal. Envie a saída via pipe para LLMs, processe listas de URLs em lote, ou importe conteúdo para o seu vault do Obsidian — tudo sem abrir um navegador.

npx web2md-cli https://example.com/article

O CLI requer Node.js 18+. Execute node -v para verificar sua versão.

Instalação

Não é necessário instalar — basta executar com npx:

npx web2md-cli <url> [options]

Ou instale globalmente para uma inicialização mais rápida:

npm install -g web2md-cli
web2md <url> [options]

Modos

O CLI do Web2MD opera em três modos, dependendo da sua configuração:

Local

Modo padrão. Não requer chave de API. Busca páginas e converte localmente. Funciona para a maioria dos sites públicos.

Servidor

Com chave de API. Defina WEB2MD_API_KEY para desbloquear Reddit, Fandom/Wikia e outros sites restritos que exigem processamento no servidor.

Bridge

Com a flag --bridge. Usa sua extensão do Chrome para buscar páginas renderizadas por JS ou protegidas por login que a busca estática não consegue acessar.

Flags

Flag	Descrição
`--no-images`	Remove referências de imagens da saída
`--no-links`	Remove hyperlinks da saída
`--meta`	Adiciona frontmatter YAML (title, source, wordCount, tokenCount, readingTime, date)
`--json`	Gera saída como JSON `{ markdown, metadata }`
`-o, --output <file>`	Grava a saída em um arquivo
`--output-dir <dir>`	Grava cada URL em um arquivo `.md` separado
`--batch <file>`	Lê URLs de um arquivo (uma por linha, `#` = comentário)
`--vault <dir>`	Modo vault do Obsidian: salva em `<dir>/raw/` e atualiza `<dir>/INDEX.md`
`--concurrency <n>`	Máximo de buscas paralelas (padrão: 3, máximo: 20)
`--bridge`	Usa a extensão do Chrome para sites renderizados por JS ou protegidos por login
`-q, --quiet`	Suprime mensagens de progresso

Comandos

Além de converter URLs, o CLI tem dois subcomandos para autenticação e sincronização da Library:

Comando	Descrição
`web2md login`	Autentica uma vez e salva sua chave de API em `~/.web2md/config.json`
`web2md sync [dir]`	Sincroniza sua Library do Web2MD com um diretório local como arquivos Markdown

npx web2md-cli login

Inicia um fluxo de autorização por dispositivo no navegador: o CLI abre https://web2md.org e mostra um código para aprovar. Depois de aprovado, sua chave de API é salva em ~/.web2md/config.json — sem precisar exportar WEB2MD_API_KEY em cada shell. O servidor MCP lê do mesmo arquivo, então fazer login aqui uma vez também autentica as chamadas de ferramentas MCP. Prefere colar uma chave diretamente em vez do fluxo pelo navegador?

npx web2md-cli login --key

Isso solicita uma chave (w2m_...) via stdin e a salva da mesma forma. Obtenha uma chave no painel.

sync

npx web2md-cli sync [dir] [--tag <t>] [--full]

Sincroniza sua Library — cada página que você salvou pela extensão, painel ou API — com um diretório local como arquivos Markdown com frontmatter, organizados por tag. Requer estar logado (ou WEB2MD_API_KEY definida).

Flag	Descrição
`dir`	Diretório de destino (padrão: `./web2md-vault`)
`--tag <t>`	Sincroniza apenas itens com essa tag
`--full`	Ignora o cursor incremental e reescaneia todo o histórico

A sincronização é incremental por padrão: rastreia um cursor em <dir>/.web2md-sync.json e só busca itens novos nas execuções seguintes. Aponte o Obsidian (ou qualquer ferramenta de leitura de Markdown) para o diretório de destino para navegar pela sua Library como notas.

npx web2md-cli login
npx web2md-cli sync ~/Documents/Web2MD-Library

Variáveis de ambiente

Variável	Descrição
`WEB2MD_API_KEY`	Chave de API (`w2m_xxx`) para Reddit, sites restritos e `sync` — tem prioridade sobre `~/.web2md/config.json`
`WEB2MD_API_URL`	Sobrescreve a URL base da API
`WEB2MD_EXTENSION_ID`	Sobrescreve o ID da extensão do Chrome para o modo `--bridge`

Adicione essas variáveis ao seu perfil de shell (~/.zshrc ou ~/.bashrc) para que persistam entre sessões:

export WEB2MD_API_KEY="w2m_your_key_here"

Exemplos de uso

Conversão básica

npx web2md-cli https://example.com/article

Imprime o Markdown no stdout.

Enviar via pipe para um LLM

npx web2md-cli https://react.dev/learn/thinking-in-react | llm "Summarize this page"

npx web2md-cli https://docs.python.org/3/tutorial/classes.html | claude "Explain the key concepts"

Salvar em arquivo

npx web2md-cli https://example.com/article -o article.md

npx web2md-cli https://example.com/article --meta -o article.md

A flag --meta adiciona frontmatter YAML com título, URL de origem, contagem de palavras, contagem de tokens, tempo de leitura e data.

Lote a partir de arquivo

Crie um arquivo urls.txt:

# Research papers
https://arxiv.org/abs/2301.00001
https://arxiv.org/abs/2301.00002

# Blog posts
https://example.com/blog/post-1
https://example.com/blog/post-2

Depois execute:

npx web2md-cli --batch urls.txt --output-dir ./research --concurrency 5

Cada URL é salva como um arquivo .md separado no diretório ./research.

Importação para o vault do Obsidian

npx web2md-cli --batch urls.txt --vault ~/Documents/MyVault

Isso salva cada página em ~/Documents/MyVault/raw/ e atualiza ~/Documents/MyVault/INDEX.md com links para todas as páginas convertidas.

Reddit com chave de API

export WEB2MD_API_KEY="w2m_your_key_here"
npx web2md-cli https://www.reddit.com/r/LocalLLaMA/comments/example

Reddit exige uma chave de API válida. Sem uma, URLs do Reddit falharão devido às restrições de bots do Reddit.

Modo bridge

Use a extensão do Chrome para lidar com páginas renderizadas por JS ou protegidas por login:

npx web2md-cli --bridge https://app.example.com/dashboard

O modo bridge requer que a extensão do Chrome do Web2MD esteja instalada e o Chrome esteja em execução. O CLI se comunica com a extensão via o protocolo de native messaging do Chrome.

Saída em JSON

npx web2md-cli --json https://example.com/article

Retorna uma saída estruturada:

{
  "markdown": "# Article Title\n\nContent here...",
  "metadata": {
    "title": "Article Title",
    "source": "https://example.com/article",
    "wordCount": 1250,
    "tokenCount": 1680,
    "readingTime": 5,
    "date": "2026-04-11T10:30:00.000Z"
  }
}

Útil para consumo programático ou para enviar via pipe para jq:

npx web2md-cli --json https://example.com/article | jq '.metadata.tokenCount'

Sites otimizados

O Web2MD inclui adaptadores nativos para estes sites, produzindo uma saída mais limpa do que a conversão genérica:

Sites com suporte otimizado

Wikipedia — extração limpa de artigos, tratamento de infobox
arXiv — resumos de artigos e metadados
Hacker News — threads com comentários
GitHub — Issues e Pull Requests
Stack Overflow — perguntas e respostas
dev.to — posts de blog
Medium — artigos (contorna a prévia do paywall)
Substack — posts de newsletter
OpenAI Docs — páginas de documentação
Sites baseados em Mintlify — sites de documentação construídos sobre o Mintlify
Reddit — posts e comentários (requer chave de API)

Fluxos de trabalho comuns

Alimentar documentação para um agente de IA

npx web2md-cli --batch docs-urls.txt --output-dir ./context --quiet

Aponte o diretório de contexto do seu agente de IA para ./context para respostas fundamentadas.

Construir um corpus de pesquisa

npx web2md-cli --batch papers.txt --vault ~/Obsidian/Research --meta --concurrency 10

Cria um vault de pesquisa indexado e pesquisável no Obsidian.

Remover formatação para entrada em LLM

npx web2md-cli --no-images --no-links https://example.com/article | llm "Analyze this"

Remove imagens e links para reduzir o uso de tokens ao enviar via pipe para LLMs.

Primeiros passos

Recursos principais

Avançado

Planos

Visão geral

Instalação

Modos

Local

Servidor

Bridge

Flags

Comandos

sync

Variáveis de ambiente

Exemplos de uso

Conversão básica

Enviar via pipe para um LLM

Salvar em arquivo

Lote a partir de arquivo

Importação para o vault do Obsidian

Reddit com chave de API

Modo bridge

Saída em JSON

Sites otimizados

Fluxos de trabalho comuns

​Visão geral

​Instalação

​Modos

Local

Servidor

Bridge

​Flags

​Comandos

​login

​sync

​Variáveis de ambiente

​Exemplos de uso

​Conversão básica

​Enviar via pipe para um LLM

​Salvar em arquivo

​Lote a partir de arquivo

​Importação para o vault do Obsidian

​Reddit com chave de API

​Modo bridge

​Saída em JSON

​Sites otimizados

​Fluxos de trabalho comuns

Visão geral

Instalação

Modos

Flags

Comandos

login

sync

Variáveis de ambiente

Exemplos de uso

Conversão básica

Enviar via pipe para um LLM

Salvar em arquivo

Lote a partir de arquivo

Importação para o vault do Obsidian

Reddit com chave de API

Modo bridge

Saída em JSON

Sites otimizados

Fluxos de trabalho comuns