CaptureKit

CLI

Instale o SDK CLI da CaptureKit e faça sua primeira chamada à API.

A interface de linha de comando oficial da CaptureKit, com um comando por endpoint.

Requisitos

  • Node.js 20+

Instalação

npm install --global @capturekitdev/cli
capturekit --help
npx @capturekitdev/cli --help

Obtenha sua chave de API

Copie sua chave de API no painel da CaptureKit e coloque-a na variável de ambiente CAPTUREKIT_API_KEY, que o SDK lê por padrão. Não a inclua no controle de versão.

export CAPTUREKIT_API_KEY="YOUR_API_KEY"
$env:CAPTUREKIT_API_KEY = "YOUR_API_KEY"

Uso

capturekit content --url https://example.com
capturekit content --help     # parameters of one command
capturekit endpoints                # every command and its HTTP path
capturekit endpoints search         # filter the list
capturekit capture --url https://example.com --format png -o screenshot.png
echo '{"url": "https://example.com"}' | capturekit content --params -
capturekit content --params params.json --compact
capturekit request get /v1/usage
capturekit request post /v1/some/new/endpoint --params body.json
capturekit content --url https://example.com | jq .

Códigos de saída

  • 0: sucesso
  • 1: falha da API ou da rede
  • 2: uso incorreto, como um comando desconhecido, uma chave de API ou um parâmetro ausente

Nesta página