CaptureKit

CLI

Installieren Sie das CLI-SDK von CaptureKit und starten Sie Ihren ersten API-Aufruf.

Die offizielle Befehlszeilenschnittstelle von CaptureKit mit einem Befehl pro Endpunkt.

Voraussetzungen

  • Node.js 20+

Installation

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

API-Schlüssel erhalten

Kopieren Sie Ihren API-Schlüssel aus dem CaptureKit-Dashboard und legen Sie ihn in der Umgebungsvariable CAPTUREKIT_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

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

Verwendung

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 .

Exit-Codes

  • 0: Erfolg
  • 1: API- oder Netzwerkfehler
  • 2: falsche Verwendung, etwa ein unbekannter Befehl, ein fehlender API-Schlüssel oder ein fehlender Parameter

Auf dieser Seite