Early AccessNur auf Einladung, und die SDKs sind noch nicht veröffentlicht.Einladung anfragen
Zum Inhalt springen
Docs

Referenz

Die globalen Flags, Umgebungsvariablen, Einstellungsdatei, Shell-Vervollständigung und Version des Kommandozeilen-Tools.

Globale Flags

Jeder Befehl nimmt diese an.

FlagWas
-p, --projectDas Projekt: seine ID, sein Slug oder sein Name. Standard: das mit lyrelog use gewählte.
--urlDie Adresse des Dashboards. Standard https://app.lyrelog.com oder LYRELOG_URL.
--jsonJSON schreiben, auch im Terminal
--humanTabellen und Farben schreiben, auch in eine Pipe
--no-colorKeine Farben (auch NO_COLOR=1)
-h, --helpHilfe zum Befehl, mit Beispielen

Umgebungsvariablen

VariableWas
LYRELOG_TOKENEin Access Token (lyr_tok_..., aus lyrelog tokens create oder von deiner Kontoseite) oder ein Token einer CLI-Session. Er hat Vorrang vor der gespeicherten Anmeldung. Siehe Skripte und CI.
LYRELOG_URLDie Adresse des Dashboards. --url hat Vorrang davor.
LYRELOG_CONFIG_DIRDer Ordner für die Einstellungsdatei
LYRELOG_THEMEdark oder light, wenn der Hintergrund des Terminals falsch erkannt wird
LYRELOG_AGENTBeliebiger Wert: JSON schreiben, wie für einen Coding-Agenten
NO_COLORBeliebiger Wert: keine Farben
BROWSERDer Browser, den lyrelog login und lyrelog open verwenden; none für keinen Browser

Das Tool liest außerdem die Variablen, die Coding-Agenten und CI setzen, um zwischen JSON und Tabellen zu entscheiden. Siehe JSON oder Tabellen.

Einstellungsdatei

Das Tool speichert seine Einstellungen in einer einzigen JSON-Datei, config.json, in:

Ordner
macOS und Linux~/.config/lyrelog oder $XDG_CONFIG_HOME/lyrelog, wenn das gesetzt ist
Windows%AppData%\lyrelog
ÜberallLYRELOG_CONFIG_DIR, wenn gesetzt

Nur du kannst die Datei lesen (Modus 0600, in einem Ordner mit 0700), und sie wird in einem Schritt geschrieben, bleibt also nie halb geschrieben zurück. Sie enthält:

FeldWas
urlDer Server, der verwendet wird, wenn weder --url noch LYRELOG_URL etwas anderes sagen: der, bei dem du dich zuletzt angemeldet hast
hostsEin Eintrag pro Server, mit seiner Adresse als Schlüssel
hosts.*.tokenDie Session. Das Tool gibt sie nie aus.
hosts.*.expires_atWann die Session spätestens endet (Unix-Sekunden)
hosts.*.user_email, hosts.*.user_nameWem sie gehört
hosts.*.project, hosts.*.project_nameDie ID des Standardprojekts und sein Name für Meldungen
{
  "url": "https://app.lyrelog.com",
  "hosts": {
    "https://app.lyrelog.com": {
      "token": "…",
      "expires_at": 1797714620,
      "user_email": "alex@example.com",
      "user_name": "Alex Rivera",
      "project": "e8bc11c6e22f",
      "project_name": "Tilefall"
    }
  }
}

Der Token ist eine Session wie das Cookie eines Browsers: Wer ihn kopiert, handelt als du, bis er endet. lyrelog logout beendet ihn auf dem Server und entfernt ihn aus der Datei.

Exit-Codes

0 heißt fertig; alles andere benennt, was schiefgelaufen ist (2 ein falsches Flag, 3 nicht angemeldet, 4 kürzliche Anmeldung nötig, 6 nicht gefunden...). Die vollständige Tabelle steht unter Für Agenten und Skripte.

Shell-Vervollständigung

lyrelog completion gibt ein Vervollständigungsskript für bash, zsh, fish oder powershell aus. Die Hilfe (--help) zu jeder Shell sagt, wohin das Skript gehört. Für zsh:

source <(lyrelog completion zsh)                                            # this shell only
lyrelog completion zsh > "$(brew --prefix)/share/zsh/site-functions/_lyrelog"   # macOS, every shell
lyrelog completion zsh > "${fpath[1]}/_lyrelog"                             # Linux, every shell

Die Vervollständigung braucht autoload -U compinit; compinit in deiner ~/.zshrc. Starte danach eine neue Shell.

Version

lyrelog version
lyrelog v0.1.0 (4678ef1, built 2026-11-19, go1.27.4, darwin/arm64)

Es zeigt die Version (aus dem Release oder die, die go install geholt hat), den Commit und das Build-Datum, wenn der Build sie kennt, sowie die Go-Version und das System, für das gebaut wurde. Ein Build ohne Version zeigt dev. In JSON: {"version","commit","date","go","os","arch"}.