CLI & REST API

Befehlszeilenschnittstelle (CLI)

Die Willet-CLI bietet dieselben Funktionen wie die MCP-Tools, skriptbar aus jeder Shell.

Installieren

Das CLI wird auf npm veröffentlicht und benötigt Node.js 20 oder neuer.

npm install -g @willet/cli

Die installierte Binärdatei ist willet. Es kommuniziert standardmäßig mit Willet Cloud: https://willet.bgenc.dev.

Anmelden (Willet Cloud)

Für die interaktive Nutzung melde dich über den Browser an. Dabei öffnet sich eine Gerät-Autorisierungsseite und ein kurzlebiger Token wird unter ~/.willet/ gespeichert.

willet login

Bestätige nach der Genehmigung die aktive Identität:

willet whoami

Gespeicherte Anmeldedaten löschen mit willet logout.

Einen API-Schlüssel verwenden (Skripte, CI, selbst gehostet)

Für die unbeaufsichtigte Nutzung überspringe den Browser-Login und gib einen Schlüssel an in WILLET_API_TOKEN.

export WILLET_API_TOKEN=... willet whoami
  • Der Scope ist entweder „user" (jedes Projekt, auf das du Zugriff hast) oder „project" (ein einzelnes Projekt).
  • Der Zugriffstyp ist entweder „read" (nur lesen) oder „read_write" (voller Zugriff).
  • `WILLET_API_TOKEN` hat Vorrang vor einem gespeicherten Login und wird nie auf die Festplatte geschrieben.

Einen selbst gehosteten Server als Ziel festlegen

Richte die CLI auf deinen eigenen Willet-Server aus – auf eine von drei Arten (höchste Priorität zuerst):

  • --api-url <url> ein globales Flag für jeden Befehl
  • WILLET_API_URL eine Umgebungsvariable
  • apiUrl ein `apiUrl`-Feld in ~/.willet/config.json

Selbst gehostete Server unterstützen keinen Willet-Login; authentifiziere dich mit `WILLET_API_TOKEN`, das auf ein Benutzergeheimnis aus der Konfigurationsdatei des Servers gesetzt ist.

Ausgabe & Scripting

  • --json Gibt unformatiertes JSON aus, keine lesbare Zusammenfassung; zur Weiterverarbeitung an ein Tool wie jq weiterleiten.
  • -p <projectId> Die meisten Aufgaben-Befehle benötigen eine Projekt-UUID.
  • Das Flag für Tags ist durch Leerzeichen getrennt, nicht durch Kommas: --tags backend perf
willet --json ticket create "Set up CI" -p $PROJECT --type chore --tags ci infra

Befehlsreferenz

Befehle sind nach Ressource gruppiert. Jede Gruppe hat eigene Unterbefehle:

GruppeUnterbefehle
willet ticketlist, search, get, create, update, delete, start, complete, cancel, reopen, comment, link, unlink, graph, tags
willet projectlist, create, delete, restore, set-key-prefix, stats, members
willet orglist, create, update, delete, members
willet githublist, link, unlink
willet renderboard, dependency-graph

Genaue Flags für jeden Befehl anzeigen mit willet <group> --help.

Exitcodes

Skripte können anhand des Exitcodes verzweigen:

0Erfolg
1Allgemeiner oder Netzwerkfehler
2Authentifizierung fehlgeschlagen (401)
3Verboten (403), z. B. ein schreibgeschütztes Secret für einen Schreibvorgang verwendet
4Nicht gefunden (404)

Weiter

Alles, was die CLI tut, läuft über die REST API. Nutz die API direkt, wenn du lieber keinen Subprozess starten willst.

REST-API-Referenz