CLI-Referenz · Befehle

Übersicht

Alle Befehle der CLI auf einen Blick, gruppiert wie in workban --help. Aufruf, Argumente und Optionen auf diesen Seiten kommen direkt aus der CLI und stimmen deshalb immer mit der ausgelieferten Version überein.

Globale Optionen

Sie gelten für jeden Befehl und dürfen vor oder nach ihm stehen. Jede hat eine Umgebungsvariable mit demselben Zweck, die Option geht vor.

Globale Optionen

-V, --versionSchalter
output the version number
--jsonSchalter
genau ein JSON-Objekt auf stdout, keine Prompts
--api-url <url>Wert
API-Basis, sonst WORKBAN_API_URL oder Config
--token <token>Wert
persönlicher Token, sonst WORKBAN_TOKEN oder Config
--project <slug>Wert
Projekt, sonst WORKBAN_PROJECT oder .workban.toml
--workspace <slug>Wert
Workspace, sonst WORKBAN_WORKSPACE oder .workban.toml; ohne nimmt die CLI den Standard-Token der Instanz

workban --json task current              # genau ein JSON-Objekt auf stdout
workban task list --workspace kunde      # in einem anderen Workspace, mit dessen Token
workban --api-url http://localhost:3000/api/v1 auth status

Alle Befehle

auth

workban auth loginToken speichern (Benutzermenü → Tokens im Web-UI): workban auth login --token wb_p_…
workban auth statusWer bin ich, welcher Workspace, welche API
workban auth headerAuthorization-Header mit dem Token dieser Instanz für andere Programme, z. B. headersHelper von Claude Code. Gibt den Token im Klartext aus
workban auth logoutToken dieser Instanz und dieses Workspaces aus der Config entfernen (--api-url und --workspace wählen)
workban meAlias für auth status

init

workban initRepo mit einem Workban-Projekt verbinden: .workban.toml, Regel und Skill für Claude Code, Hooks

task

workban task createTask anlegen (mit --start: Branch und Ref aus Git, idempotent je Branch)
workban task listTasks auflisten
workban task currentMein laufender Task in diesem Projekt: auf dem aktuellen Branch, sonst der einzige offene
workban task showTask mit Beschreibung, Kommentaren und Anhängen; ohne Nummer der laufende
workban task claimTask übernehmen (Assignee = ich), Status bleibt
workban task moveStatus setzen: backlog | in_progress | testing | on_hold | done; ohne Nummer der laufende Task
workban task deleteTask endgültig löschen, inklusive Anhänge (nur Owner und Admins)
workban task startÜbernehmen und auf in_progress setzen; ohne Nummer der laufende Task (zurück aus Testing oder On Hold)
workban task doneAuf done setzen (Kurzform für move done); ohne Nummer der laufende Task
workban task commentKommentar (Markdown) anlegen, optional mit Dateien; ohne Nummer am laufenden Task
workban task attachDateien an den Task hängen; ohne Nummer der laufende Task
workban task editTitel, Beschreibung, Branch, Agent, Zuweisung oder Projekt ändern; ohne Nummer der laufende Task

project und board

workban project listProjekte des Workspaces auflisten
workban project createProjekt anlegen (ab Rolle Maintainer)
workban boardKompakte Boardansicht

hook

workban hook gatePreToolUse: Datei-Änderungen im Repo (Edit, Write, Bash, PowerShell) nur mit laufendem Task erlauben
workban hook sessionSessionStart: laufende und offene Tasks des Projekts als Kontext ausgeben

update, doctor, completion

workban updateCLI auf die Version des Workban-Servers aktualisieren
workban completionShell-Completion ausgeben: eval "$(workban completion zsh)" in ~/.zshrc, analog bash
workban doctorUmgebung prüfen: Installation, CLI-Version, Anmeldung, Repo-Konfiguration, Agenten-Dateien, Completion

Hilfe in der CLI

workban --help listet die Befehle, workban <befehl> --help die Optionen eines Befehls, etwa workban task create --help. workban --version zeigt die installierte Version.