Accès anticipéSur invitation, et les SDK ne sont pas encore publiés.Demander une invitation
Aller au contenu
Docs

Référence

Les options globales de l'outil en ligne de commande, ses variables d'environnement, son fichier de réglages, la complétion du shell et la version.

Options globales

Toutes les commandes les acceptent.

OptionRôle
-p, --projectLe projet : son identifiant, son slug ou son nom. Par défaut : celui choisi avec lyrelog use.
--urlL'adresse du tableau de bord. Par défaut https://app.lyrelog.com, ou LYRELOG_URL.
--jsonÉcrire du JSON, même dans un terminal
--humanÉcrire des tableaux et des couleurs, même dans un pipe
--no-colorPas de couleurs (aussi NO_COLOR=1)
-h, --helpL'aide de la commande, avec des exemples

Variables d'environnement

VariableRôle
LYRELOG_TOKENUn jeton d'accès (lyr_tok_..., de lyrelog tokens create ou de votre page de compte) ou un jeton de session CLI. Il l'emporte sur la connexion enregistrée. Voir Scripts et CI.
LYRELOG_URLL'adresse du tableau de bord. --url l'emporte sur elle.
LYRELOG_CONFIG_DIRLe dossier du fichier de réglages
LYRELOG_THEMEdark ou light, quand le fond du terminal est mal deviné
LYRELOG_AGENTN'importe quelle valeur : écrire du JSON, comme pour un agent de code
NO_COLORN'importe quelle valeur : pas de couleurs
BROWSERLe navigateur qu'utilisent lyrelog login et lyrelog open ; none pour aucun navigateur

L'outil lit aussi les variables que définissent les agents de code et la CI, pour choisir entre JSON et tableaux. Voir JSON ou tableaux.

Fichier de réglages

L'outil garde ses réglages dans un seul fichier JSON, config.json, dans :

Dossier
macOS et Linux~/.config/lyrelog, ou $XDG_CONFIG_HOME/lyrelog quand elle est définie
Windows%AppData%\lyrelog
PartoutLYRELOG_CONFIG_DIR, quand elle est définie

Le fichier n'est lisible que par vous (mode 0600, dans un dossier 0700), et il est écrit en une seule étape, si bien qu'il n'est jamais laissé à moitié écrit. Il contient :

ChampRôle
urlLe serveur utilisé quand ni --url ni LYRELOG_URL n'en indiquent un autre : le dernier auquel vous vous êtes connecté
hostsUne entrée par serveur, indexée par son adresse
hosts.*.tokenLa session. L'outil ne l'affiche jamais.
hosts.*.expires_atQuand la session se termine au plus tard (secondes Unix)
hosts.*.user_email, hosts.*.user_nameÀ qui elle appartient
hosts.*.project, hosts.*.project_nameL'identifiant du projet par défaut, et son nom pour les messages
{
  "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"
    }
  }
}

Le jeton est une session, comme le cookie d'un navigateur : quiconque le copie agit en votre nom jusqu'à ce qu'elle se termine. lyrelog logout la termine sur le serveur et la retire du fichier.

Codes de sortie

0 signifie terminé ; tout autre code nomme ce qui n'a pas marché (2 une option incorrecte, 3 non connecté, 4 connexion récente nécessaire, 6 introuvable...). Le tableau complet se trouve dans Pour les agents et les scripts.

Complétion du shell

lyrelog completion affiche un script de complétion pour bash, zsh, fish ou powershell. Le --help de chacun indique où le placer. Pour 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

La complétion a besoin de autoload -U compinit; compinit dans votre ~/.zshrc. Ouvrez ensuite un nouveau shell.

Version

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

La commande affiche la version (celle de la release, ou celle qu'a récupérée go install), le commit et la date de build quand le build les connaît, ainsi que la version de Go et le système pour lequel il a été compilé. Un build sans version indique dev. En JSON : {"version","commit","date","go","os","arch"}.