6 Commandes

Ce chapitre présente les différentes commandes VenC qu'il est possible d'utiliser dans un terminal.

6.1 Afficher la version de VenC

Le numéro de version s'obtient avec :

venc -v

Ou :

venc --version

Cette commande affiche également la version de Python utilisée avec VenC, ainsi que la version de chacun des modules installés.

6.2 Créer un nouveau blog

Vous ne pouvez pas créer un blog sans en spécifier le nom entre guillemets :

venc -nb "<nom du blog>"

Ou :

venc --new-blog "<nom du blog>"

VenC crée le répertoire contenant les sources du blog à l'endroit où vous tapez la commande :

jeanrochefort@anonymous ~ $ venc --new-blog "MonSuperBlog"
VenC: Votre blog a été créé !

En listant le contenu du dossier, vous devriez avoir quelque chose du genre :

jeanrochefort@anonymous ~ $ ls MonSuperBlog/
blog blog_configuration.yaml entries extra includes templates theme

Une fois que vous avez créé votre blog, la première chose à faire est en général d'éditer le fichier blog_configuration.yaml.

6.3 Ajouter une nouvelle publication

Pour créer une nouvelle publication, vous devez être dans le répertoire de votre blog et spécifier le titre de celle-ci entre guillemets :

venc -ne "<nom de la publication>" [nom du template de publication]

Ou :

venc --new-entry "<nom de la publication>" [nom du template de publication]

Attention à ne pas confondre la notion de template graphique avec celle de template de publication.

Si vous ne spécifiez pas de nom de template de publication, VenC produira une publication totalement vierge. Le nom de template de publication est en fait le nom de fichier du template désiré, se trouvant soit dans le répertoire templates de votre projet, soit dans le répertoire des templates par défaut :

~/.local/share/VenC/themes_templates/

À l'issue de cette commande, VenC essaiera d'ouvrir la nouvelle publication avec l'éditeur de texte spécifié dans le fichier de configuration principal blog_configuration.yaml.

6.4 Exporter le blog

Pour exporter votre blog, vous devez être dans le répertoire de votre blog, puis lancer la commande suivante :

venc -xb [thème]

Ou :

venc --export-blog [thème]

Dans le répertoire de votre blog se trouvera alors un répertoire sobrement intitulé blog : c'est dans celui-ci que sera exporté votre site. Si le dossier existe déjà du fait d'une précédente génération, son contenu sera d'abord effacé intégralement, puis la nouvelle génération sera lancée.

Une fois l'exportation terminée, vous pouvez copier le contenu de ce répertoire vers votre serveur ou faire en sorte que le docroot, c'est-à-dire le dossier racine de votre serveur Web, pointe sur ce répertoire. Ce répertoire peut également être un lien symbolique vers le docroot par défaut.

Vous pouvez spécifier un thème, le blog sera alors compilé avec. Il peut être nécessaire d'installer un thème pour le rendre disponible pour votre blog. Si aucun thème n'est précisé, VenC compilera le blog avec le thème local, c'est-à-dire celui qui se trouvera dans le dossier theme du répertoire de votre blog.

6.5 Générer le blog et le transférer sur un serveur FTP

Pour exporter le blog et le téléverser dans la foulée vers un serveur FTP, vous pouvez utiliser :

venc -xftp [thème]

Ou :

venc --export-via-ftp [thème]

Cette commande est identique à :

venc -xb [thème]

Ou encore à :

venc --export-blog [thème]

Cependant, VenC utilise les informations du fichier de configuration principale pour transférer votre projet exporté sur un serveur distant prédéfini à l'emplacement désiré.

Vous pouvez également paramétrer les choses suivantes dans le fichier de configuration principale :

6.6 Copier le blog vers un serveur FTP

venc -rc

Ou :

venc --remote-copy

Cette commande permet de copier le blog courant sur votre serveur FTP à l'emplacement que vous aurez défini dans votre fichier de configuration principal, sans le re-générer. Une invite d'authentification FTP apparaîtra dans le terminal pour lancer la procédure.

Vous pouvez également paramétrer les choses suivantes dans le fichier de configuration principale :

6.7 Éditer un fichier et exporter le blog

venc -ex <fichier>

Ou :

venc --edit-and-export <fichier>

Cette commande ouvre le fichier passé en paramètre avec l'éditeur de texte de votre choix, défini dans blog_configuration.yaml. Puis une fois l'édition terminée, VenC génère l'ensemble du blog.

6.8 Afficher l'aide-mémoire

Vous avez oublié comment faire telle ou telle chose ? Cette commande affiche dans le terminal les commandes disponibles !

venc -h

Ou :

venc --help

6.9 Installer un thème

venc -it <Nom du thème>

Ou :

venc --install-theme <Nom du thème>

Cette commande déplace et sauvegarde l'ancien thème dans un dossier horodaté à la racine de votre blog. Le nouveau thème, passé en paramètre, est alors installé.

6.10 Afficher les thèmes disponibles

venc -pt

Ou :

venc --print-themes

Affiche la liste des thèmes qui sont installés dans :

~/.local/share/VenC/themes

6.11 Démarrer un serveur local

venc -s [port]

Ou :

venc --serv [port]

Pour prévisualiser votre contenu, vous pouvez lancer un serveur local en spécifiant explicitement le port. Si le numéro de port n'est pas fourni, VenC utilisera celui défini dans le fichier de configuration principal.

À noter que si vous modifiez votre projet, VenC rafraîchira votre contenu en régénérant le site automatiquement. Pour ce faire, VenC a besoin de connaître le thème par défaut à utiliser, s'il n'y en a pas déjà un d'installé.

6.12 Afficher les arguments d'un template de publication

L'utilisation d'un template de publication peut nécessiter l'utilisation d'arguments supplémentaires pour celui-ci. Encore faut-il les connaître et savoir comment ils sont utilisés !

Ces commandes permettent d'afficher le template spécifié et de mettre en valeur ses arguments :

venc -ta <nom du template>

Ou :

venc --template-arguments <nom du template>

Le nom du template correspond ici au nom du fichier du template et non pas son chemin complet. En effet, VenC va chercher le template dans :