Outils CLI

Une commande. Une URL. Votre capture.
En local, dans un pipeline CI/CD ou dans vos scripts d'automatisation.

$ shotbot capture --url=https://www.shotbot.fr
✓ captured in 2s
✓ saved www.shotbot.fr-ab1c2d3e.jpg (412 KB)
$ _

Mêmes options. Mêmes codes de sortie. Même structure de config.
Passez de PHP à Python ou Node.js sans réécrire vos scripts.

Le CLI lui-même est en anglais, sur tous les systèmes. Chaque client stocke sa clé API et ses défauts dans son propre ~/.shotbot-<langue>-cli/config.json | les trois peuvent cohabiter sans conflit.

Installation

pip install shotbot

npm install -g shotbot

curl -fsSL https://api.shotbot.net/cli/php/shotbot -o shotbot \
  && chmod +x shotbot \
  && sudo mv shotbot /usr/local/bin/

curl -fsSL https://api.shotbot.net/cli/python/shotbot -o shotbot \
  && chmod +x shotbot \
  && sudo mv shotbot /usr/local/bin/

curl -fsSL https://api.shotbot.net/cli/node/shotbot -o shotbot \
  && chmod +x shotbot \
  && sudo mv shotbot /usr/local/bin/

Pour rendre la commande globale : sudo mv shotbot /usr/local/bin/. Au premier appel, le CLI vous demande votre clé API et l'enregistre sous ~/.shotbot-<langue>-cli/config.json (un dossier de config par client, chmod 600), les trois peuvent donc cohabiter.

Clients disponibles

Première capture

shotbot capture --url=https://www.shotbot.fr/

shotbot capture --url=https://www.shotbot.fr/ --output=screenshot.jpg

shotbot capture --url=https://www.shotbot.fr/ --full-page --format=pdf

shotbot capture --url=https://www.shotbot.fr/ --json | jq .token

Privé par défaut

Le privé par défaut est pratique pour les pages sensibles (intranet, dashboards, données client). Voir la FAQ pour le détail technique.

Options de capture

Compte Gratuit

Shotbot Pro

Le CLI ne filtre rien côté client : c'est l'API qui contrôle l'éligibilité. Sans Shotbot Pro, ces options renvoient 403 pro_required et le CLI sort en code 4.

PDF (uniquement avec --format=pdf)

Options CLI

Défauts persistants

Configurez une fois, capturez ensuite sans réécrire vos options. Les options passées sur la ligne de commande gardent toujours la priorité sur les défauts.

shotbot set viewport 1440         # toujours 1440 px
shotbot set full-page             # toujours page entière
shotbot set output ./shots/       # toujours enregistrer dans ./shots/
shotbot set cdn true              # toujours publier sur le CDN public
shotbot set format webp           # toujours WebP

shotbot defaults                  # voir ce qui est stocké
shotbot defaults --keys           # liste des clés modifiables
shotbot unset full-page           # oublier ce défaut

Les défauts vivent dans le même ~/.shotbot-<langue>-cli/config.json que la clé API.

Utilisation en CI/CD | GitHub Actions, GitLab CI, Makefile

Passez SHOTBOT_API_KEY en variable d'environnement pour éviter l'invite interactive, NO_COLOR=1 pour une sortie sans ANSI, et testez le code de sortie - le code 5 (quota/file d'attente) n'est pas un échec dur.

export SHOTBOT_API_KEY="$SHOTBOT_KEY"   # évite l'invite interactive
export NO_COLOR=1                       # désactive l'ANSI

shotbot capture \
  --url=https://staging.example.com \
  --viewport=1440 --full-page \
  --output=artifacts/staging.jpg \
  --timeout=120

case $? in
  0) echo "OK" ;;
  5) echo "Quota épuisé"; exit 0 ;;        # waitlist, pas un échec dur
  *) echo "Capture échouée (code $?)"; exit 1 ;;
esac

Variables d'environnement

Codes de sortie

Autres commandes

Ressources