Helper local

Le helper local est la commande terminal v8s. Il vous permet d’ouvrir un lien court connu directement depuis votre terminal au lieu de passer d’abord au navigateur, taper le domaine court et attendre la redirection. Pour le travail quotidien, cela rend les liens répétés plus rapides à atteindre.

Le helper est volontairement en lecture seule. Il lit un registre généré comme build/v8s.json ou ~/.v8s.json, ouvre les slugs exacts qui existent déjà et refuse les cibles qui ne sont pas des URL web. Il ne crée pas, ne modifie pas, ne commit pas et ne pousse pas de liens. Il ouvre seulement les liens permanent et ephemeral avec des cibles http:// ou https:// après validation du slug.

Le helper est séparé de la CLI. Utilisez ./scripts/lnk lorsque vous voulez modifier l’instance : la CLI lnk modifie les fichiers source dans custom/, commit et pousse. Utilisez v8s lorsque vous voulez un raccourci local rapide vers une redirection existante.

Prérequis

• Un dépôt vanityURLs configuré disponible localement
• Node.js 20 ou plus récent
• npm
• Git
• jq
• Un shell compatible POSIX capable de sourcer scripts/v8s.sh, comme sh, Bash ou Zsh

Les shells avec des modèles de script différents, comme Fish ou PowerShell, peuvent quand même lancer les commandes du projet, mais ils ne peuvent pas sourcer scripts/v8s.sh directement sans couche de compatibilité.

Installer le helper

Lancez la commande de setup poste depuis votre dépôt vanityURLs :

npm run local-install

La commande vérifie jq, installe le helper compatible POSIX depuis scripts/v8s.sh lorsque demandé, copie scripts/lnk vers le chemin local bin configuré, et enregistre les chemins dans custom/v8s-local-config.json.

Configurer le registre

npm run local-install écrit les réglages du helper propres au poste dans custom/v8s-local-config.json. Ce fichier stocke le chemin d’installation du helper, le fichier rc du shell, le chemin du registre local, le chemin du dépôt et le chemin d’installation de lnk. Il est séparé de custom/v8s-site-config.json, qui stocke les réglages publics de l’instance utilisés par le site web et le Worker.

Le helper lit le chemin du registre local configuré, généralement ~/.v8s.json. npm run build écrit build/v8s.json et le copie vers le registre local configuré seulement lorsque la configuration locale active le helper.

Si vous gardez le registre ailleurs, définissez V8S_REGISTRY avant de sourcer ou d’utiliser le helper :

export V8S_REGISTRY=/path/to/YOUR-SHORT-DOMAIN/build/v8s.json
source /path/to/YOUR-SHORT-DOMAIN/scripts/v8s.sh

Utiliser le helper