Browse Source

Mise à jour du readme

pull/42/head
Matthieu Marcillaud 12 months ago
parent
commit
5e9af5299d
  1. 99
      README.md

99
README.md

@ -6,54 +6,58 @@ spip-cli est un outil pour commander SPIP depuis la ligne de commandes.
https://contrib.spip.net/SPIP-Cli
## Installation
Cet utilitaire nécessite PHP >= 7.2 ; il requiert [Composer](https://getcomposer.org/).
Récupérer un archive ou télécharger le dépot, et lancer l’installation Composer
```sh
git clone https://git.spip.net/spip-contrib-outils/spip-cli.git
cd spip-cli
composer install
```
La commande `spip` se trouve dans le répertoire `bin`. Il sera plus simple de rendre la commande utilisable partout en la liant par exemple dans `/usr/local/bin`
```sh
ln -s bin/spip /usr/local/bin
```
## Utiliser spip-cli
Pour connaître les commandes disponibles, lancer `spip` dans un shell
```
```text
$ spip
Ligne de commande pour SPIP version 0.2.3
Ligne de commande pour SPIP version 1.0.0
Usage:
[options] command [arguments]
Options:
--help -h Display this help message.
--quiet -q Do not output any message.
--verbose -v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
--version -V Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
--no-interaction -n Do not ask any interactive question.
Available commands:
dl Télécharger SPIP dans un dossier (par défaut, la dernière version stable)
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
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:telecharger Télécharger SPIP dans un dossier (par défaut, la dernière version stable)
core:preparer Préparer les fichiers pour installer SPIP correctement.
core:installer Installer la base de données et le premier utilisateur.
(etc.)
command [options] [arguments]
[...]
auteurs
auteurs:changer:mdp Changer le mot de passe d'un auteur
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:envoyer:lien:oubli Envoyer un mail d'oubli de mot de passe à l'auteur, avec un lien pour le réinitialiser.
auteurs:lister Liste les auteurs d'un site
auteurs:superadmin [root:me] 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.
config
config:ecrire Ecrire une option de configuration dans spip_meta
config:lire Lire une option de configuration depuis spip_meta
[...]
```
Dans la version 0.2.3, `spip-cli` permet :
* de télécharger SPIP dans un dossier,
* d'installer la base de données de SPIP et le premier utilisateur,
* vider et activer/désactiver le cache.
* utiliser les fonctions propre() et typo()
## Installer SPIP avec SPIP-cli
Les 3 étapes obligatoires sont : core:telecharger, core:preparer, core:installer.
Les 3 étapes obligatoires sont : `core:telecharger`, `core:preparer`, `core:installer`.
Voici un exemple (pour le détail des arguments, voir la doc) :
@ -64,38 +68,43 @@ spip install --db-server mysql --db-host localhost --db-login mysqluser --db-dat
```
## synchro SPIP
> Synchroniser un spip distant sur un spip local, bdd / fichiers / modif des metas
>
> ATTENTION, pour l'instant ne fonctionne que sur une bdd en mysql
3 actions possibles :
* `spip synchro:init` creation d'un fichier json : synchroSPIP.json à la racine du SPIP, il restera un peu de configuration à faire.
* `spip synchro:bdd` pour lancer la synchro de la bdd et la modif des metas
* `spip synchro:fichiers` pour lancer la synchro des fichiers via rsync
`spip synchro:bdd` : Il y a 3 args facultatifs
* -v : verbeux
* -b ou --backup: forcer le backup local de la bdd
* -r ou --rsync: lancer à la fin les commandes rsync du script synchro:fichiers
`spip synchro:fichiers`: Il y a 1 arg facultatif
`spip synchro:fichiers` : Il y a 1 arg facultatif
* -v : verbeux
Fichier de configuration synchroSPIP.json
* Il y a 2 façons pour ouvrir une connexion ssh :
* via : user / hostName / port ex : `ssh toto@spip.net -p 1234`, si chemin_cle est defini, on pourra choisir une cle ssh dans un dossier autre que .ssh
* via: host (il faut l'avoir défini dans .ssh/config) ex: `ssh mon_host_spip` dans ce cas, pas besoin de renseigner les autres champs dans config_ssh
* Il faut avoir une cle ssh
* via : user / hostName / port ex : `ssh toto@spip.net -p 1234`, si chemin_cle est defini, on pourra choisir une cle ssh dans un dossier autre que .ssh
* via: host (il faut l'avoir défini dans .ssh/config) ex: `ssh mon_host_spip` dans ce cas, pas besoin de renseigner les autres champs dans config_ssh
* Il faut avoir une cle ssh
* Configuration pour le rsync : Chaque ligne représente : chemin local => chemin distant:
* le chemin local peut-être en relatif
* le chemin distant doit etre en absolue et se terminer par '/'
* le chemin local peut-être en relatif
* le chemin distant doit etre en absolue et se terminer par '/'
* Configuration pwd mysql distant: si dans le fichier de configuration, on indique pas le pwd mysql, il sera demandé en console
exemple :
```json
"rsync": {
"IMG": "chemin abs vers IMG/",
"plugins": "chemin abs vers plugins/"
"IMG": "chemin abs vers IMG/",
"plugins": "chemin abs vers plugins/"
}
```

Loading…
Cancel
Save