CaptureKit

CLI

Installez le SDK CLI de CaptureKit et faites votre premier appel d'API.

L'interface en ligne de commande officielle de CaptureKit, avec une commande par endpoint.

Prérequis

  • Node.js 20+

Installation

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

Obtenir votre clé API

Copiez votre clé API depuis le tableau de bord CaptureKit et placez-la dans la variable d'environnement CAPTUREKIT_API_KEY, que le SDK lit par défaut. Ne la versionnez pas.

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

Utilisation

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 .

Codes de sortie

  • 0: succès
  • 1: échec de l'API ou du réseau
  • 2: usage incorrect, par exemple une commande inconnue, une clé API ou un paramètre manquant

Liens

Sur cette page