xh - Aide-mémoire du Client HTTP Moderne

Installation

Plateforme	Commande
Ubuntu/Debian	`curl -sfL https://raw.githubusercontent.com/ducaale/xh/master/install.sh \
Arch Linux	`pacman -S xh`
Fedora/RHEL	`dnf install xh`
macOS (Homebrew)	`brew install xh`
macOS (MacPorts)	`sudo port install xh`
Windows (Scoop)	`scoop install xh`
Windows (Chocolatey)	`choco install xh`
Cargo (All platforms)	`cargo install xh`
Docker	`docker pull ducaale/xh`
Snap	`snap install xh`

Commandes de Base

Commande	Description
`xh httpbin.org/get`	Requête GET simple
`xh POST httpbin.org/post name=John`	Requête POST avec des données JSON
`xh PUT httpbin.org/put status=active`	Requête PUT avec des données
`xh PATCH httpbin.org/patch email=new@email.com`	Requête PATCH pour mettre à jour une ressource
`xh DELETE httpbin.org/delete`	Requête DELETE
`xh HEAD httpbin.org/get`	Requête HEAD (en-têtes uniquement)
`xh OPTIONS httpbin.org/get`	Requête OPTIONS
`xh httpbin.org/get search==rust`	GET avec paramètre de requête
`xh httpbin.org/get page==1 limit==10`	Plusieurs paramètres de requête
`xh -a user:pass httpbin.org/basic-auth/user/pass`	Authentification de base
`xh -A bearer -a token123 api.example.com`	Authentification par token porteur
`xh httpbin.org/get User-Agent:CustomAgent`	En-tête personnalisé
`xh -b httpbin.org/json`	Imprimer uniquement le corps de la réponse
`xh -h httpbin.org/json`	Imprimer uniquement les en-têtes de réponse
`xh -v httpbin.org/json`	Sortie verbeuse (en-têtes + corps)
`xh httpbin.org/json -o response.json`	Télécharger la réponse dans un fichier
`xh --follow=0 httpbin.org/redirect/3`	Ne pas suivre les redirections
`xh -f POST httpbin.org/post name=John`	POST avec données de formulaire
`xh POST httpbin.org/post < data.json`	POST avec contenu de fichier
`xh httpbin.org/get Authorization:"Bearer token"`	En-tête Authorization

Utilisation Avancée

Commande	Description
`xh POST httpbin.org/post age:=30 active:=true`	JSON avec coercition de type (nombre/booléen)
`xh POST httpbin.org/post tags:='["rust","cli"]'`	Envoyer un tableau JSON
`xh POST httpbin.org/post user[name]=John user[age]:=30`	Objets JSON imbriqués
`xh --session=mysession httpbin.org/cookies/set/token/abc`	Créer une session nommée (persistance des cookies)
`xh --session=mysession httpbin.org/cookies`	Réutiliser la session
`xh --session-read-only=mysession httpbin.org/get`	Utiliser la session sans la mettre à jour
`xh -f POST httpbin.org/post file@/path/to/file.txt`	Télécharger le fichier en tant que formulaire multipart
`xh POST httpbin.org/post @file.json`	Télécharger le fichier comme corps de requête
`xh --proxy=http:http://proxy.example.com:8080 httpbin.org/get`	Utiliser un proxy HTTP
`xh --proxy=all:socks5://localhost:1080 httpbin.org/get`	Utiliser un proxy SOCKS5
`xh --verify=no https://self-signed.badssl.com/`	Ignorer la vérification SSL (non sécurisé)
`xh --cert=/path/to/ca-cert.pem https://api.example.com`	Certificat CA personnalisé
`xh --cert=/path/to/client.crt --cert-key=/path/to/client.key https://api.example.com`	Authentification par certificat client
`xh --timeout=30 httpbin.org/delay/5`	Définir le délai d’expiration de la requête (secondes)
`xh --pretty=none httpbin.org/json`	Désactiver la sortie colorée/formatée
`xh --style=monokai httpbin.org/json`	Utiliser un schéma de couleurs spécifique
`xh --stream httpbin.org/stream/100`	Réponse de stream
`xh --download httpbin.org/image/png -o image.png`	Télécharger avec barre de progression
`xh --continue httpbin.org/stream/100 -o stream.txt`	Reprendre le téléchargement partiel
`xh --http-version=1.1 https://httpbin.org/get`	Forcer HTTP/1.1
`xh --method=CUSTOM httpbin.org/anything`	Méthode HTTP personnalisée
`xh --multipart POST httpbin.org/post name=John file@doc.pdf`	Formulaire multipart avec données mixtes
`xh httpbin.org/get Cookie:session=abc123`	Envoyer des cookies
`xh --auth-type=digest -a user:pass httpbin.org/digest-auth/auth/user/pass`	Authentification Digest

Types de Données JSON

Lors de l’envoi de données JSON, xh prend en charge la conversion de type avec une syntaxe spéciale :

Syntaxe	Type	Exemple
`key=value`	String	`name=John` → `{"name":"John"}`
`key:=number`	Numéro	`age:=30` → `{"age":30}`
`key:=true`	Booléen	`active:=true` → `{"active":true}`
`key:=null`	Null	`middle:=null` → `{"middle":null}`
`key:='[...]'`	Tableau	`tags:='["a","b"]'` → `{"tags":["a","b"]}`
`key:='{...}'`	Objet	`meta:='{"v":1}'` → `{"meta":{"v":1}}`
`key[sub]=value`	Imbriqué	`user[name]=John` → `{"user":{"name":"John"}}`

Configuration

Emplacements de Stockage de Session

# Linux/macOS
~/.config/xh/sessions/

# Windows
%APPDATA%\xh\sessions\

Variables d’Environnement

# Set default proxy
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080

# Disable proxy for specific hosts
export NO_PROXY=localhost,127.0.0.1,.example.com

# Default timeout
export XH_TIMEOUT=30

Alias Courants

# Add to ~/.bashrc or ~/.zshrc

# HTTPie compatibility
alias http='xh'
alias https='xh --default-scheme=https'

# Quick shortcuts
alias xhj='xh --pretty=all'  # Force JSON pretty-print
alias xhn='xh --pretty=none' # No formatting
alias xhv='xh -v'            # Verbose by default
alias xhd='xh --download'    # Download mode

Cas d’Utilisation Courants

Cas d’Utilisation : Tester une API REST avec Authentification

# Login and save session
xh --session=api POST https://api.example.com/login \
  username=admin password=secret

# Make authenticated requests using saved session
xh --session=api GET https://api.example.com/users

# Update resource
xh --session=api PUT https://api.example.com/users/123 \
  name="John Doe" email=john@example.com status=active

# Delete resource
xh --session=api DELETE https://api.example.com/users/123

Cas d’Utilisation : Téléchargement de Fichier avec Métadonnées

# Upload file with additional form fields
xh -f POST https://api.example.com/upload \
  file@/path/to/document.pdf \
  title="Important Document" \
  category=legal \
  tags:='["contract","2024"]'

# Multiple file upload
xh -f POST https://api.example.com/batch-upload \
  file1@image1.jpg \
  file2@image2.jpg \
  album="Vacation 2024"

Cas d’Utilisation : Test d’API avec Différents Environnements

# Development environment
xh --session=dev POST https://dev-api.example.com/test \
  Authorization:"Bearer dev-token-123" \
  data=test

# Staging environment
xh --session=staging POST https://staging-api.example.com/test \
  Authorization:"Bearer staging-token-456" \
  data=test

# Production environment (with SSL verification)
xh --session=prod POST https://api.example.com/test \
  Authorization:"Bearer prod-token-789" \
  data=test

Cas d’Utilisation : Débogage des Charges Utiles de Webhook

# Capture webhook payload to file
xh POST https://webhook.site/your-unique-url \
  event=user.created \
  user[id]:=12345 \
  user[email]=new@example.com \
  timestamp:=$(date +%s) \
  -v -o webhook-debug.txt

# Test webhook with retry logic (in script)
for i in {1..3}; do
  xh POST https://your-app.com/webhook \
    event=test \
    attempt:=$i && break || sleep 5
done

Cas d’Utilisation : Téléchargement et Traitement de Données d’API

# Download JSON data
xh GET https://api.github.com/users/octocat/repos \
  -o repos.json

# Download with authentication and save
xh -a token:ghp_your_token \
  GET https://api.github.com/user/repos \
  visibility==private \
  -o private-repos.json

# Stream large dataset
xh --stream GET https://api.example.com/export/data \
  format==json \
  | jq '.[] | select(.active == true)' \
  > active-records.json

Meilleures Pratiques

Utiliser des sessions pour les workflows authentifiés : Les sessions conservent les cookies et les en-têtes, éliminant la nécessité de se réauthentifier pour chaque requête. Utilisez --session=namepour les interactions API multi-étapes.
Exploiter la conversion de type pour JSON : Utilisez :=pour les nombres et les booléens (age:=30, active:=true) au lieu de valeurs de chaîne pour garantir les types JSON corrects dans les requêtes API.
Préférer xh à curl pour les tests d’API : La syntaxe intuitive (xh POST api.com name=value) est plus lisible que les drapeaux verbeux de curl, ce qui en fait un outil idéal pour la documentation et les tests rapides.
Utiliser le mode verbose pour le débogage : Ajoutez -vpour voir les en-têtes de requête et de réponse complets lors du dépannage de problèmes d’API ou d’authentification.
Stocker les jetons sensibles dans des variables d’environnement : Au lieu de

Note: Some placeholders (15-20) were left untranslated as they seem to be specific code/command references that would typically remain in English.xh -a token:secret_key, utilisezxh -a token:$API_TOKENpour éviter d’exposer les identifiants dans l’historique du shell.

Utilisez la redirection de sortie pour l’automatisation : Enregistrez les réponses avec-o file.jsonpour le traitement ou la comparaison dans les pipelines CI/CD et les scripts de tests automatisés.
Définissez des délais d’attente appropriés : Utilisez--timeout=30pour les API lentes afin d’éviter les requêtes bloquées. Définissez--timeout=0uniquement pour les opérations de streaming ou de longue durée.
Organisez les sessions par environnement : Créez des sessions séparées pour dev, staging et production (--session=prod-api) pour éviter d’utiliser accidentellement les mauvaises identifiants.

Dépannage

Problème	Solution
`SSL certificate verification failed`	Use `--verify=no` to skip verification (insecure) or `--cert=/path/to/ca.pem` to provide custom CA certificate
`Connection timeout`	Increase timeout with `--timeout=60` or check network connectivity and proxy settings
`401 Unauthorized`	Verify authentication method: use `-a user:pass` for basic auth, `-A bearer -a token` for bearer tokens, or check session validity
`JSON parsing error`	Ensure proper syntax: use `:=` for non-strings (`age:=30`), quote arrays (`tags:='["a","b"]'`), and check for unescaped special characters
`Command not found: xh`	Verify installation path is in `$PATH`, reinstall using preferred method, or use full path `/usr/local/bin/xh`
`Session not persisting`	Check session directory permissions (`~/.config/xh/sessions/`), ensure using same session name, verify not using `--session-read-only`
`Proxy connection failed`	Verify proxy URL format `--proxy=http:http://host:port`, check proxy authentication if required, ensure proxy allows target host
`File upload fails`	Use `-f` or `--multipart` flag for form uploads, verify file path is correct, check file permissions and size limits
`Response not formatted/colored`	Force formatting with `--pretty=all`, check terminal supports colors, or pipe through `jq` for JSON formatting