Installation et authentification

Installez la CLI sur votre machine, puis fournissez-lui une clé qu'elle peut conserver.

La CLI est un paquet Node. Une installation globale et un aller-retour dans le navigateur suffisent.

Prérequis

Node.js 20 ou version ultérieure. Le paquet déclare engines.node: ">=20.0.0" et wajub doctor le vérifie explicitement. Un ancien runtime échoue donc avec un message clair plutôt qu'une trace de pile.

Vérifier avant l'installation

node --version

Installation

npm install -g @wajub/cli

Confirmez l'installation et notez le runtime indiqué. Le support vous demandera cette ligne.

wajub version

$ wajub version
@wajub/cli/1.4.0 darwin-arm64 node-v22.11.0

Sans rien installer

npx @wajub/cli listen --forward-to localhost:3000/webhooks exécute la version actuelle sans rien laisser derrière. Cette méthode est utile sur une machine qui ne vous appartient pas ou dans un conteneur temporaire.

Pour effectuer une mise à jour, relancez l'installation. La CLI vous avertit aussi lorsqu'une nouvelle version est publiée.

Authentification

wajub login ouvre votre navigateur. Vous donnez votre accord dans le Dashboard et la CLI reçoit une clé qu'elle conserve localement. Vous ne saisissez rien dans le terminal, donc aucune clé n'apparaît dans l'historique du shell.

Le parcours normal

wajub login
wajub login --environment live

La sandbox est utilisée par défaut. Connectez-vous deux fois, une fois par environnement, pour obtenir deux profils entre lesquels basculer.

Option	Utilisation
`--environment`	`sandbox` ou `live`, choisit le type de clé créé
`--manual`	Colle une clé existante dans une invite masquée, sans navigateur
`--no-browser`	Affiche l'URL au lieu de l'ouvrir, pour un shell distant
`--no-skills`	Ignore la proposition des Skills pour agents
`--profile`	Nomme le profil créé
`--dashboard-url`	Utilise un autre hôte pour le Dashboard

Les identifiants sont enregistrés dans ~/.config/wajub/config.json, accessible uniquement par vous. Vous pouvez le sauvegarder, mais traitez-le exactement comme un fichier de clés.

Dans la CI, utilisez l'environnement

Un pipeline ne possède aucun navigateur. Définissez WAJUB_API_KEY pour que toutes les commandes l'utilisent sans qu'aucun profil n'existe.

Une étape de pipeline

# From your CI secret store, never from the job definition
export WAJUB_API_KEY=sk.kZ3qP8mWvL2xR7tB5nY4hC6dF9jS1aG0eU3i…

wajub doctor --json
wajub payments list --limit 5 --json

Ne transmettez jamais une clé avec `--api-key`

Cette option existe encore et fonctionne toujours. Elle est donc marquée comme obsolète et masquée dans --help. Une clé passée dans la ligne de commande est écrite dans l'historique du shell et visible dans la liste des processus par tous les utilisateurs de la machine. Utilisez wajub login en local et WAJUB_API_KEY dans la CI.

Profils

Un profil est un ensemble d'identifiants nommé. La CLI utilise ce concept parce que les clés de la sandbox et du mode live ne doivent jamais être séparées par une simple faute de frappe.

Créer, examiner et changer de profil

# What do I have, and which one is default?
wajub config

# Register a key under a name, without calling the API to validate it
wajub config set staging --secret-key sk.kZ3qP8mWvL2xR7tB5nY4hC6dF9jS1aG0eU3i…

# Make it the default
wajub config use staging

# Or override for a single command
wajub payments list --profile sandbox

wajub config affiche les clés masquées. --show-secrets les affiche entièrement, ce qui est presque toujours déconseillé sur un écran partagé.

`config set` ne vérifie pas la clé

La commande enregistre le profil tel quel. Une faute de frappe n'est découverte que plus tard, lorsqu'une commande échoue avec 401. Exécutez wajub doctor après avoir créé manuellement un profil.

Vérifier toute la chaîne

wajub doctor

$ wajub doctor

Wajub CLI diagnostics

  ✓  Config  2 profile(s), default: sandbox
  ✓  Credentials  key=pk_test.mT9xW…  env=sandbox  base=https://api.wajub.com  source=profile
  ✓  API reachability  https://api.wajub.com (HTTP 200)
  ✓  Auth  API key accepted, Boutique Akwa (sandbox)
  ✓  Node.js  v22.11.0 (≥ 20 required)
  ✓  Environment  wajub-cli v1.4.0  node v22.11.0  darwin/arm64
  ✓  Support  last request id: fbe6773e9ce64f158af89e5740fc5817

Everything looks good.

Le champ source de la ligne des identifiants est souvent ignoré. Il indique si la clé provient d'un profil, de WAJUB_API_KEY ou d'une option. Lorsqu'une commande semble appartenir à un autre compte, ce champ vous donne la réponse.

Déconnexion

wajub logout révoque la clé créée par wajub login, puis supprime le profil local. La révocation est importante. La simple suppression du fichier laisserait une clé live active chez Wajub.

Se déconnecter proprement

wajub logout                    # the current profile
wajub logout --profile sandbox  # a named one
wajub logout --all              # every profile
wajub logout --keep-key         # forget it locally, leave the key active

Utilisez --keep-key uniquement lorsque la clé sert également ailleurs, par exemple sur un serveur configuré avec une copie provenant du Dashboard.

Pages associées