SPIP-Contrib

SPIP-Contrib

عربي | Deutsch | English | Español | français | italiano | Nederlands

286 Plugins, 197 contribs sur SPIP-Zone, 287 visiteurs en ce moment

Accueil > Documentation > SPIP en ligne de commande > SPIP-Cli

SPIP-Cli

20 décembre 2015 – par RastaPopoulos – commentaires

19 votes

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

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.

On récupère l’outil spip-cli dans un répertoire partagé :
sudo svn checkout svn://zone.spip.org/spip-zone/_outils_/spip-cli/trunk /opt/spip-cli

Sur Linux, pour pouvoir utiliser la commande spip dans un shell :
sudo ln -s /opt/spip-cli/spip.php /usr/local/bin/spip

Toujours sur Linux, il est possible d’avoir l’autocomplétion de toutes les options. Pour cela il faut copier le fichier `spip_completion.sh` dans le dossier dédié du système :
sudo ln -s /opt/spip-cli/spip_completion.sh /etc/bash_completion.d/spip

Spip-cli fonctionne aussi en local avec un Mac + MAMP. Un réglage spécifique peut cependant s’avérer nécessaire. [1]

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.

Voici une liste rapide des commandes fournies actuellement :

  • 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: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)
  • plugins
    • plugins:activer Active un ou plusieurs plugins.
    • plugins:desactiver Désactive des plugins.
    • plugins:lister Lister les plugins activés.
  • texte
    • texte:propre Convertit du texte au format SPIP vers du HTML via la fonction « propre »
    • texte:typo

Technique

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

Une application spip.php 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 spip-cli ou par les plugins).

É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 spip-cli/ 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 !

Notes

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

cd /var
sudo mkdir mysql
sudo chmod 755 mysql
cd mysql
sudo ln -s /Applications/MAMP/tmp/mysql/mysql.sock mysql.sock

Puis

cd /tmp
sudo ln -s /Applications/MAMP/tmp/mysql/mysql.sock mysql.sock

Voir : http://stackoverflow.com/questions/4219970/warning-mysql-connect-2002-no-such-file-or-directory-trying-to-connect-vi

Dernière modification de cette page le 24 janvier 2016

Retour en haut de la page

Vos commentaires

  • Le 17 novembre 2016 à 11:39, par ManuC En réponse à : SPIP-Cli

    Bonjour,

    Tout d’abord, merci pour ce plugin vraiment très pratique.

    Un petit message rapide pour indiquer que si vous utilisez recuperer_fond dans un script spip-cli et que vous avez défini la variable de personnalisation $puce, il faut ajouter $puce à la liste des global de la fonction spip_charger()
    Sans cela, vos superbes puces perso ne seront pas prises en compte.

    Répondre à ce message

  • Le 9 septembre 2016 à 22:20, par Laurent Vergerolle En réponse à : SPIP-Cli

    Bonjour,
    Je trouve cette initiative super surtout quand, comme moi, on aime énormément la ligne de commande.

    J’ai toutefois un soucis, je suis en PHP7.0 et dès que je lance la commande

    $ spip install -ds « mysql » -dh « localhost » -db « test » -dp « test » -dd « spip_cli » -ap « password »

    j’ai le message d’erreur suivant que je ne comprend pas

                   
     [RuntimeException]              
     The "-d" option does not exist.

    J’ai regardé vite fait le fichier CoreInstaller.php mais je ne vois rien de louche. Quelqu’un aurait une idée ?

    • Le 10 septembre 2016 à 08:16, par RastaPopoulos En réponse à : SPIP-Cli

      SPIP-Cli embarque une vieille version du module Console de Symfony, donc c’est possible que ça ne soit pas compatible PHP7, oui.

      Il faudrait mettre à jour la librairie car elle marche sur la branche 5 (>= 5.5) et 7 à la fois, normalement. Mais il faut vérifier que tout fonctionne et il y a sûrement du code à revoir.

    • Le 11 septembre 2016 à 15:15, par Laurent Vergerolle En réponse à : SPIP-Cli

      Merci pour cette réponse rapide. Je m’en doutais un peu mais je préférais avoir une confirmation avant de passer en PHP5 pour utiliser les commandes. Dans mon cas ça ne me dérange pas.
      Merci beaucoup.

    Répondre à ce message

  • Le 24 mars 2016 à 15:12, par joz En réponse à : SPIP-Cli

    Bonjour,
    est-ce qu’il y a moyen de télécharger le paquet sans SVN ?
    Merci d’avance

    Répondre à ce message

Répondre à cet article

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici Les choses à faire avant de poser une question (Prolégomènes aux rapports de bugs. )
Ajouter un document

Retour en haut de la page

Ça discute par ici

  • Agenda 2.0

    3 novembre 2008 – 1069 commentaires

    Voici la version pour SPIP 2.0 du Plugin Agenda pour SPIP 1.9.2, avec une interface remaniée pour encore plus de plaisir. Pour une documentation concernant l’utilisation d’Agenda 3 pour SPIP 3, veuillez pour l’instant vous référer à SPIP 3, Agenda (...)

  • Indexer : Installation et Configuration

    6 octobre 2014 – 39 commentaires

    Introduction Pour comprendre l’intérêt du plugin, nous invitons à lire l’article suivant Indexer : Introduction. Le fonctionnement de la boucle SPHINX est expliqué dans cet article : Indexer : La boucle SPHINX. La suite de l’article aborde (...)

  • GIS 4

    11 août 2012 – 1313 commentaires

    Présentation et nouveautés La version 4 de GIS abandonne la libraire Mapstraction au profit de Leaflet. Cette librairie permet de s’affranchir des librairies propriétaires tout en gardant les mêmes fonctionnalités, elle propose même de nouvelles (...)

  • Formidable, le générateur de formulaires

    23 janvier 2012 – 2058 commentaires

    Un générateur de formulaires facilement configurable pour les non-informaticiens et facilement extensible pour les développeurs. Introduction L’objectif était de créer un plugin permettant de générer des formulaires. Historiquement, 2 plugins (...)

  • Indexer : La boucle SPHINX

    29 juin 2015 – 15 commentaires

    Avant de commencer Pour comprendre l’intérêt du plugin, nous invitions à lire l’article suivant Indexer : Introduction. La configuration et l’installation du plugin sont expliquées dans l’article suivant : Indexer : Installation et Configuration (...)