CLI Client

Installation de cipi-cli

cipi-cli est un binaire Go autonome qui communique avec le Cipi REST API de votre machine. Aucun SSH requis : gérez les applications, les bases de données, les certificats SSL et les déploiements à partir de n'importe quel borne. Les binaires sont disponibles pour Linux et macOS (amd64 et arm64).

Télécharger le binaire

Téléchargez la dernière version pour votre plateforme à partir du Page des versions, alors :

chmod +x cipi-cli-*
sudo mv cipi-cli-* /usr/local/bin/cipi-cli

Construire à partir des sources

git clone https://github.com/cipi-sh/cli.git
cd cli
make build
sudo make install

Vérifier l'installation

$ cipi-cli version
cipi-cli v1.2.5 (linux/amd64)

CLI Client

Configuration

A profilest une connexion nommée à un Cipi serveur (API point de terminaison + jeton). Utiliser comme de nombreux profils car vous avez des serveurs - par exemple prod, staging, ou client-a. Vous avez besoin de l'URL du point de terminaison API et d'un jeton Sanctum créé avec cipi api token create sur chaque serveur.

Les informations d'identification sont stockées par profil dans ~/.cipi/config.json avec autorisations 0600. Transmettez toujours un nom de profil — si vous l'omettez, le CLI vous en demande un au lieu de écrivant silencieusement à default.

Configuration interactive

Recommandé : stockez le jeton avec api token add. Les aides équivalentes sont configure --profile et profiles add:

$ cipi-cli api token add prod
Cipi API point de terminaison : https://api.example.com
API jeton : 1|votre jeton...
Profil de serveur "prod" enregistré → ~/.cipi/config.json

$ cipi-cli api token add staging
Cipi API point de terminaison : https://staging-api.example.com
API jeton : 1|jeton de mise en scène...
Profil de serveur "staging" enregistré → ~/.cipi/config.json

# Same flow via configure / profiles add
$ cipi-cli configure --profile prod
$ cipi-cli profiles add staging

Configuration non interactive

$ cipi-cli api token add prod \
    --endpoint https://api.example.com --token "1|yourtoken..."

$ cipi-cli profiles add staging \
    --endpoint https://staging.example.com --token "1|yourtoken..."

Afficher la configuration

$ cipi-cli profiles show prod
Profil : prod
Point de terminaison : https://api.example.com
Jeton : 1|a8Kz...4f2a

$ cipi-cli profiles show
# Shows all configured server profiles

CLI Client

profiles

Gérez plusieurs connexions de serveur à partir d'un seul cipi-cli installation. Un profil équivaut à un serveur. Préfixez n'importe quelle commande avec un nom de profil pour cibler ce serveur, ou définissez un nom par défaut avec profiles use pour omettre le préfixe. Les pseudonymes servers / server fonctionne de la même manière que profiles.

Cibler un serveur

$ cipi-cli prod apps list
$ cipi-cli staging apps show myapp
$ cipi-cli prod deploy myapp
$ cipi-cli prod ssl install myapp

Avec un serveur par défaut défini, vous pouvez exécuter des commandes sans le préfixe :

$ cipi-cli profiles use prod
Profil par défaut défini sur "prod"

$ cipi-cli apps list
# Uses the prod profile

$ cipi-cli staging apps list
# Explicit prefix still targets staging

api token add, profiles add, et configure accepte la même chose drapeaux : --endpoint et --token (plus --profile quand le nom n’est pas positionnel).

CLI Client

apps

Gérez les applications sur votre serveur Cipi.

Créer des drapeaux

Modifier les drapeaux

Indicateurs de journaux

Exemples

# List all apps
$ cipi-cli apps list

# Create a Laravel app
$ cipi-cli apps create --user=myapp --domain=myapp.com \
    --php=8.5 --repository=git@github.com:acme/myapp.git --branch=main

# Create a custom (non-Laravel) app
$ cipi-cli apps create --user=landing --domain=landing.acme.com \
    --custom --docroot=dist

# Edit an existing app
$ cipi-cli apps edit myapp --php=8.4

# Suspend staging for maintenance
$ cipi-cli apps suspend staging

# Read recent deploy logs (page 1 = newest lines)
$ cipi-cli apps logs myapp --type=deploy

# Paginate older nginx lines
$ cipi-cli apps logs myapp --type=nginx --page=2 --per-page=100

# Delete an app (skip confirmation)
$ cipi-cli apps delete myapp -y

CLI Client

domains

Répertoriez chaque domaine principal et alias de toutes les applications du serveur dans une seule table : la table distante. contrepartie de cipi domains sur le serveur. Utile pour auditer la couverture DNS ou repérer les domaines manquants SSL avant le renouvellement d'un certificat.

$ cipi-cli domains
  TYPE D'APPLICATION DE DOMAINE PHP SSL
api.myapp.com alias myapp Laravel 8.5 ✓
  myapp.com myapp primaire Laravel 8.5 ✓
  www.myapp.com alias monapp Laravel 8.5 ✓

3 domaines · 1 application · 3 certificats

CLI Client

deploy

Déclenchez des déploiements, revenez à la version précédente ou débloquez un déploiement bloqué.

$ cipi-cli deploy myapp
Déploiement de monapplication...
Travail de sondage n°42... terminé
Déployé vers la version #14. Zéro temps d'arrêt.

$ cipi-cli deploy rollback myapp
Retour à la version n°13.

CLI Client

ssl

Installez Let's Encrypt certificats pour vos applications.

$ cipi-cli ssl install myapp
Certificat fourni pour myapp.com

CLI Client

aliases

Gérer les alias de domaine pour une application.

$ cipi-cli aliases add myapp www.myapp.com
Alias www.myapp.com ajouté à myapp.

$ cipi-cli aliases list myapp
  www.monapp.com
  api.myapp.com

# Re-run ssl install to include new aliases in the certificate
$ cipi-cli ssl install myapp

CLI Client

db

Gérez MariaDB bases de données.

$ cipi-cli db list
  TAILLE DU NOM
  monapplication 24,5 Mo
  blog 8,2 Mo

$ cipi-cli db backup myapp
Sauvegarde créée : myapp_20260402_143022.sql.gz

$ cipi-cli db restore myapp -y
Base de données restaurée avec succès.

CLI Client

status

Lisez le même instantané d'hôte que cipi status sur le serveur - via GET /api/status. Nu status affiche un aperçu global (une ligne par serveur configuré). Transmettez un nom de profil (ou utilisez un préfixe de profil) pour obtenir tous les détails.

Colonnes globales : NAME, IP, CPU, RAM, HDD, APPS, SVC, CIPI. Le profil par défaut est marqué avec *.

$ cipi-cli status
  NOM IP CPU RAM HDD APPLICATIONS SVC CIPI
  prod* 203.0.113.10 12 % 48 % (3840M) 42G/80G 53 % 3 8/8 ok 4.6.3
mise en scène 203.0.113.20 4% 31% (2048M) 18G/40G 45% 1 8/8 ok 4.6.3

  * profil par défaut
  Détail : cipi-cli statut <nom>

$ cipi-cli status prod
État du serveur – prod
  Point de terminaison https://api.example.com
  Nom d'hôte prod-01
  IP203.0.113.10
  Système d'exploitation Ubuntu 24.04
  Disponibilité 12 jours
  Cipi 4.6.3
  Processeur 12 %
  RAM 3840/8192 Mo (48%)
  Disque dur 42G/80G (53%)
  Applications 3

CLI Client

jobs

Les opérations d'écriture (créer, éditer, supprimer, déployer, SSL, etc.) sont asynchrones sur le Cipi API. Le CLI interroge automatiquement l'achèvement du travail et affiche une double flèche en attendant. Si vous préférez gérer interrogation manuelle, utilisez le jobs commandes.

$ cipi-cli jobs show 42
Tâche n°42 : déployer myapp – terminé

$ cipi-cli jobs wait 43
En attente du travail n°43... terminé

CLI Client

update

Mise à jour cipi-cli à la dernière version de GitHub. La commande sélectionne le semver le plus élevé parmi les versions publiées (pas le drapeau « dernière » de GitHub, qui peut pointez sur une balise plus ancienne), télécharge le binaire correspondant à votre plate-forme, vérifie son SHA-256 somme de contrôle et remplace le binaire en cours d'exécution en place. Alias : self-update, upgrade.

$ cipi-cli update
Téléchargement de cipi-cli v1.2.5...
Somme de contrôle vérifiée. Mis à jour vers la v1.2.5.

# Aliases work the same
$ cipi-cli self-update
$ cipi-cli upgrade

# If installed in a system path, use sudo
$ sudo cipi-cli update

CLI Client

completion

Installer la saisie semi-automatique du shell pour cipi-cli. Le chemin recommandé est completion install, qui détecte votre shell, écrit le script d'achèvement et hooke dans votre fichier rc (idempotent).

$ cipi-cli completion install
Installation de l'achèvement de zsh...
Achèvement installé → ~/.cipi/completions/cipi-cli.zsh
Connecté à ~/.zshrc

# Or pin a shell explicitly
$ cipi-cli completion install --shell bash

Pour zsh et bash, le script est écrit sous ~/.cipi/completions/ et une ligne source est ajouté à votre fichier shell rc. Pour le poisson, le script va à~/.config/fish/completions/(chargé automatiquement). Rechargez ensuite le shell, puis essayez cipi-cli <TAB>.

CLI Client

Drapeaux mondiaux

Ces drapeaux sont disponibles sur toutes les commandes.

# JSON output for scripting
$ cipi-cli apps list --json
[{"name": "monapplication", "domaine": "monapplication.com", "php": "8.5"}, ...]

# Pipe to jq for filtering
$ cipi-cli apps list --json | jq '.[].name'
"monapplication"
"blog"

# Help for a specific command
$ cipi-cli apps create --help

Sorties

Les releases sont automatisées via GitHub Actions. Binaires pré-construits pour Linux (amd64/arm64) et macOS (amd64/arm64) sont publiés avec des sommes de contrôle SHA-256 sur leGitHub Page des versions.

Code source

cipi-cli est open source, sous licence MIT et écrit en Go. Les contributions sont les bienvenues sur GitHub.

CLI Client

Exigences

Le serveur Cipi doit avoir le Forfait API installé et configuré avant d'utiliser cipi-cli:

$ cipi api <domain>
$ cipi api ssl
$ cipi api token create

Les nouvelles versions de l'application PHP doivent être 8.3, 8.4, ou 8.5 (Cipi 4.5.4+). Certaines fonctionnalités CLI dépendent du serveur spécifique et des versions API :