@surak/cli

Le client en ligne de commande de Surak — lecture du « Livre sacré », le dépôt Git où une équipe range ses specs et ses plans.

Trois commandes, en parité avec l'interface web : elles appellent les mêmes routes et le même code de rendu, si bien qu'un extrait de recherche affiché ici est celui que le navigateur affiche.

surak ls        # l'arborescence d'un dépôt indexé
surak read      # un document, son front matter et son corps
surak search    # la recherche plein texte sur l'espace

Prérequis

Bun 1.3.14 ou plus récent. Le paquet est distribué en TypeScript et son exécutable est lancé par Bun : il ne fonctionne pas sous Node.

Installation

bun add -g @surak/cli

Authentification

La clé se lit uniquement dans la variable d'environnement SURAK_API_KEY. Elle n'est jamais acceptée en argument de ligne de commande : un secret passé en argument est visible dans la table des processus et finit dans l'historique du shell.

export SURAK_API_KEY=…        # une clé d'agent de votre espace
export SURAK_WORKSPACE=…      # ou --workspace <identifiant>

Créez une clé d'agent depuis l'écran « Clés d'API » de votre espace.

Options

| Option | Effet | Variable | |---|---|---| | --workspace | l'identifiant de l'espace | SURAK_WORKSPACE | | --repository | limite à un dépôt | SURAK_REPOSITORY | | --url | une autre instance | SURAK_URL | | --json | la réponse brute | — |

--url exige HTTPS hors de la boucle locale, et les redirections ne sont jamais suivies : sans cela, un serveur complaisant répondrait 302 et recevrait votre clé, que fetch retransmet à l'origine suivante pour tout en-tête autre qu'Authorization.

Licence

Propriétaire — Unlocker.