SPIP-Cli

SPIP-Cli est une interface en ligne de commande pour SPIP.

SPIP-Cli sert à interagir avec SPIP depuis la ligne de commande, à la fois avant d’avoir un SPIP sous la main (installation, configuration…), puis ensuite pour administrer ou modifier un SPIP existant depuis un terminal.

L’outil fournit une liste de commandes utiles et génériques en rapport avec la distribution officielle de SPIP. Elles seront complétées au fur et à mesure. Les plugins peuvent ensuite fournir de nouvelles commandes supplémentaires propres à leurs besoins.

Installation

Pré-requis : Composer doit être installé sur la machine.

Les explications suivantes sont orientées autour d’une installation sous Linux, mais fonctionnent aussi sur Mac OS. Nous conseillons d’installer SPIP-Cli de manière globale sur tout le système. Pour cela, nous utilisons la commande sudo, qui lance les programmes avec les droits d’administration du système.

Récupérer Spip-Cli et l’installer :

sudo git clone https://git.spip.net/spip-contrib-outils/spip-cli.git /opt/spip-cli
cd /opt/spip-cli
sudo composer install

Lier les commandes spip pour un accès facile :

cd /opt/spip-cli/bin
# Commande 'spip' 
sudo ln -s $(pwd)/spip /usr/local/bin/
# Commande 'spipmu' pour site mutualisé
sudo ln -s $(pwd)/spipmu /usr/local/bin/
# Autocompletion (Linux)
sudo ln -s $(pwd)/spip_console_autocomplete /etc/bash_completion.d/spip
# Autocompletion (MacOs)
sudo ln -s $(pwd)/spip_console_autocomplete /usr/local/etc/bash_completion.d/spip

Mise à jour

cd /opt/spip-cli
sudo git pull
composer update

Utilisation

Vous avez maintenant accès à la commande spip dans votre terminal. En lançant cette commande sans rien d’autre, cela affichera une liste des commandes disponibles ainsi que des options génériques.

Vous pouvez demander une aide plus précise sur une commande spécifique. Cela vous listera alors les arguments et options possibles :
spip help {commande}

Certaines commandes courantes ont des noms raccourcis supplémentaires assignés, afin de les appeler plus rapidement. Par exemple la commande spip core:telecharger peut s’appeler avec spip dl.

Commandes de base

Voici une liste rapide des commandes principales fournies :

Raccourcis
dl Télécharger SPIP dans un dossier (par défaut, la dernière version stable)
extraire_balise Extrait la première balise du type fourni avec l’option -b. Exemple `spip extraire_balise -b title` pour extraire le titre de la page
extraire_balises Extrait les balises du type fourni avec l’option -b. Exemple `spip extraire_balises -b p` pour extraire les paragraphes
help Displays help for a command
install Installer la base de données et le premier utilisateur.
installer Installer la base de données et le premier utilisateur.
list Lists commands
textebrut Convertit un texte HTML en texte brut.
up Mettre à jour la branche de SPIP qui est installée.
update Mettre à jour la branche de SPIP qui est installée.
versions Liste les versions de SPIP
auteurs
auteurs:changer:statut Changer le statut d’un auteur
auteurs:creer Créer ou modifier un auteur (identifié selon id, sinon login, sinon email)
auteurs:lister Liste les auteurs d’un site
auteurs:superadmin Ajoute / supprime un webmestre observateur (id_auteur = -1).
cache
cache:desactiver Désactive le cache de spip pendant 24h.
cache:reactiver Réactive le cache de spip.
cache:vider Vider le cache.
core
core:installer Installer la base de données et le premier utilisateur.
core:listerversions Liste les versions de SPIP
core:maj:bdd Mettre à jour la base de données et configurations de SPIP.
core:mettreajour Mettre à jour la branche de SPIP qui est installée.
core:preparer Préparer les fichiers pour installer SPIP correctement.
core:telecharger Télécharger SPIP dans un dossier (par défaut, la dernière version stable)
filtres
filtres:extraire_balise Extrait la première balise du type fourni avec l’option -b. Exemple `spip extraire_balise -b title` pour extraire le titre de la page
filtres:extraire_balises Extrait les balises du type fourni avec l’option -b. Exemple `spip extraire_balises -b p` pour extraire les paragraphes
filtres:textebrut Convertit un texte HTML en texte brut.
images
images:verifier:extensions Vérifier les extensions d’images du répertoire IMG
integraal
integraal:generer Génèrer un nouveau projet à partir de l‘échafaudage Intégraal.
php
php:eval Évaluer du code PHP dans un contexte SPIPien.
plugins
plugins:activer Active un ou plusieurs plugins.
plugins:desactiver Désactive un ou plusieurs plugins
plugins:lister Liste les plugins du site.
plugins:listerheader Export la liste des plugins du site telle stockée en base (peut-être tronquée si trop de plugins).
plugins:maj:bdd Mettre à jour la base de données et configurations des plugins.
plugins:svp:depoter Ajouter un depot
plugins:svp:telecharger Telecharger un plugin depuis les dépôts.
root
root:me Ajoute / supprime un webmestre observateur (id_auteur = -1).
server
server:locate Localiser les SPIP installés sur ce serveur
sql
sql:convert:tomysql Convertit un site vers mysql (utile pour un site en sqlite)
sql:dump:create Crée un dump SPIP.
sql:dump:restore Restaure un dump SPIP.
sql:optimize Optimize les tables SQL
sql:repair Crée les tables et champs manquants et tente de réparer chaque table de la base de données.
sql:show:base Liste les tables de la BDD.
sql:show:diff Liste les tables et champs présents mais non déclarés à SPIP, ou inversement.
sql:show:table Décrit une table dans la base de données.
synchro
synchro:bdd Synchroniser la BDD du SPIP depuis celle d’un autre site (avec maj des metas pour conserver les paramètres spécifiques du SPIP, cf config générée via synchro:init)
synchro:fichiers Synchroniser les dossiers du SPIP depuis un autre site option (IMG ou/et autre dossiers configurés via synchro:init)
synchro:init Initialiser le json de configuration pour la synchro
test
test:spip Vérifie notre connexion au site SPIP.
test:style Affiche les différents styles d’écriture.
texte
texte:propre Convertit du texte au format SPIP vers du HTML via la fonction “propre”
texte:typo Convertit une phrase vers du HTML via la fonction “typo”

Technique

SPIP-Cli est développé en utilisant le composant Console de Symfony, dans sa version 2.8 pour l’instant. Nous recommandons donc la lecture de sa documentation afin de comprendre le fonctionnement.

Une application spip s’occupe déjà de découvrir si l’on se trouve ou non dans une installation de SPIP, de charger SPIP le cas échéant (inc_version.php), puis de charger toutes les commandes disponibles (fournies par d’éventuels plugins actifs sur le site).

Étendre les fonctionnalités

Il y a donc deux moyens d’ajouter une commande :
-  soit c’est une commande sympa qui ne concerne que le noyau (ou des choses en shell, genre appel de mysql, svn ou autre). Dans ce cas, cette commande peut aller dans le dossier src/Command/ du projet ;
-  soit on a une commande qui concerne un plugin précis (de la zone ou d’un projet perso) et il faut ajouter le fichier PHP dans un dossier spip-cli/ du plugin activé (il faut que ce soit un plugin activé pour que la commande apparaisse).

La règle est d’avoir :
-  une commande par classe, la plus circonscrite possible
-  une seule classe de commande par fichier PHP
-  au maximum possible un verbe à l’infinitif pour le dernier élément du nom, celui qui concerne l’action à faire

En revanche, on peut regrouper les commandes ensemble selon une hiérarchie, en séparant les noms avec les deux points “:”. Par exemple plugins:activer et plugins:desactiver. La hiérarchie n’est pas limitée, mais il est conseillé de s’en tenir à deux éléments dans la majorité des cas. Parfois trois, mais il serait bien de ne pas dépasser ce nombre. On pourra par exemple imaginer regrouper toutes les fonctionnalités plus évoluées proposées par SVP sur les plugins avec plugins:svp:{commande}.

Quelques exemples de plugins qui l’utilisent

Des idées de commandes possibles

  • Gestion des auteurs
  • Gestion des médias
  • Gestion de la configuration
  • Gestion de synchronisation entre deux sites par SSH (IMG, données, etc)
  • et sûrement des millions d’autres idées que vous aurez !

Historique et Migration

Version 0.4

  • Les exécutables ont été déplacés dans le répertoire bin/ . Vous devez adapter vos liens symboliques en conséquence.
  • Les commandes sont déplacées src/Command
  • Les commandes core:maj:bdd et plugins:maj:bdd sont ajoutées
  • Les commandes plugins:lister, plugins:activer et plugins:desactiver sont revues et complétés par des options intéressantes
  • Tolère les sites SPIP mutualisés
  • L’exécutable spipmu permet d’appliquer une commande à plusieurs sites SPIP mutualisés.

Installations spécifiques Mamp et Windows

Spécificité d’installation MacOs/Mamp Mysql

Avec MacOs + MAMP, vous devrez peut-être effectuer les commandes suivantes en cas d’erreur de connexion à la base de donnée avec mysqli.

# Disposer de /var/mysql/mysql.sock
sudo mkdir /var/mysql
sudo chmod 755 /var/mysql
sudo ln -s /Applications/MAMP/tmp/mysql/mysql.sock /var/mysql/mysql.sock
# Disposer de /tmp/mysql.sock
sudo ln -s /Applications/MAMP/tmp/mysql/mysql.sock /tmp/mysql.sock

Source : StackOverFlow : mysql connect

Spécificités d’installation sous Windows:

  • la machine doit disposer d’un serveur web complet avec PHP et MySQL/MariaDB. Pour une installation fonctionnelle de AMP (Apache / PHP / MySQL|MariaDB) vous pouvez utiliser par exemple Laragon ou XAMPP
  • il faut que les executables de PHP et MySQL/Mariadb soient dans le PATH de la machine (local ou global peu importe). Pour cela éditer les variables d’environnement de la machine:
    Panneau de configuration > Système > Paramètres systèmes avancés > Variables d’environnement... : dans la variable Path de votre utilisateur (= install locale, pour vous seul) ou dans celle du système (install globale, tous les utilisateurs), ajouter les chemins de php.exe et mysql.exe (précédés d’un ;), par exemple C:\laragon\bin\php\php-7.1.25-Win32-VC14-x64 et C:\laragon\bin\mysql\mariadb-10.3.10-winx64\bin
  • de la même manière il faut mettre dans le PATH le sous-dossier bin de spip-cli: par exemple C:\laragon\bin\spip-cli\bin (si on suppose que vous avez installé spip-cli dans le dossier bin/ de votre Laragon pour cet exemple)
  • pour éviter un blocage bizarre au lancement des commandes de spip-cli, (fonction PHP date_default_timezone_set() qui bloque et nécessite de re-valider par Entrée le lancement ???), il est indispensable que le paramètre date.timezone soit défini dans le php.ini de votre serveur web. Par ex date.timezone = Europe/Paris : à vérifier en ouvrant la page de l’espace privé ...ecrire/?exec=info et en recherchant dans le phpinfo qui s’affiche que dans le bloc date vous avez bien une directive date.timezone configurée. Sinon, éditez votre php.ini pour ajouter la directive.
  • il est vivement conseillé de ne pas utiliser l’invite de commande de Windows (cmd.exe) pour travailler avec spip-cli mais plutôt un terminal “Unix-like” qui permet d’utiliser toutes les commandes bash/sh standard, par exemple Gitbash fourni par l’installation de Git de https://gitforwindows.org/
  •  

Discussion

11 discussions

Add a comment

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite / PostgreSQL
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparait.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom