Utilisation en ligne de commande¶

Une fois l’outil installé, il est appelable en ligne de commande : geotribu.

Fonctionnement général¶

Geotribu en ligne de commande pour rechercher dans les contenus et les images, consulter les derniers contenus sans quitter son terminal. Encore meilleur avec les terminaux gérant les hyperliens : Bash, PowerShell 5+, etc.

Commandes et options¶

Geotribu Toolbelt 0.34.3 - Une ligne de commande pour Geotribu qui offre des outils pour rechercher et consulter les contenus et images, et faciliter les tâches récurrentes des contributeur/ices.

geotribu [-v] [--no-logfile] [-h] [--version]
         {read-latest,récents,latest,rl,rss,search-content,contenus,sc,search-image,si,ouvrir,lire,open,or,read,upgrade,auto-update,maj,update,header-check,header,check,metadata,creer,new,nouveau,comments,commentaires,coms,images,img,social,rezosocio}
         ...

geotribu options¶

-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG. Réglable avec la variable d’environnement GEOTRIBU_LOGS_LEVEL. (default: 1)
--no-logfile - Désactiver les fichiers de journalisation (logs).
-h, --help - Affiche l'aide et s'arrête là.
--version - Affiche la version du CLI et s’arrête là.

read-latest (récents, latest, rl, rss)¶

Consulter les derniers contenus du site

read-latest [-h] [-v] [-r REMOTE_INDEX_FILE] [-l LOCAL_INDEX_FILE] [-n RESULTS_NUMBER]
            [-f {article,rdp}] [-x EXPIRATION_ROTATING_HOURS] [-o {table}] [--no-prompt]

read-latest options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-r REMOTE_INDEX_FILE, --remote-index-file REMOTE_INDEX_FILE - Emplacement du fichier distant. (default: https://geotribu.fr/feed_rss_created.xml)
-l LOCAL_INDEX_FILE, --local-index-file LOCAL_INDEX_FILE - Emplacement du fichier local. (default: /home/runner/.geotribu/rss/rss.xml)
-n RESULTS_NUMBER, --results-number RESULTS_NUMBER - Nombre de résultats à retourner. (default: 5)
-f FILTER_TYPE, --filter-type FILTER_TYPE - Filtrer sur un type de contenu en particulier. (default: None)
-x EXPIRATION_ROTATING_HOURS, --expiration-rotating-hours EXPIRATION_ROTATING_HOURS - Nombre d’heures à partir duquel considérer le fichier local comme périmé. (default: 24)
-o FORMAT_OUTPUT, --format-output FORMAT_OUTPUT - Format de sortie. (default: table)
--no-prompt - Désactive le prompt demandant le résultat à ouvrir à la fin de la commande.

search-content (contenus, sc)¶

Rechercher dans les contenus du site

search-content [-h] [-v] [-r REMOTE_INDEX_FILE] [-l LOCAL_INDEX_FILE]
               [-f GEOTRIBU_CONTENUS_DEFAULT_TYPE] [-ds GEOTRIBU_CONTENUS_DATE_START]
               [-de GEOTRIBU_CONTENUS_DATE_END] [-n GEOTRIBU_RESULTATS_NOMBRE]
               [-x GEOTRIBU_CONTENUS_INDEX_EXPIRATION_HOURS] [-o GEOTRIBU_RESULTATS_FORMAT]
               [-a] [--no-prompt]
               search-term

search-content positional arguments¶

search-term - Terme de recherche. Accepte les filtres sur les champs indexés : tags ou title. Exemple : 'ubuntu title:qgis' (default: None)

search-content options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-r REMOTE_INDEX_FILE, --remote-index-file REMOTE_INDEX_FILE - Emplacement du fichier distant. (default: https://geotribu.fr/search/search_index.json)
-l LOCAL_INDEX_FILE, --local-index-file LOCAL_INDEX_FILE - Emplacement du fichier local. (default: /home/runner/.geotribu/search/site_search_index.json)
-f GEOTRIBU_CONTENUS_DEFAULT_TYPE, -ft GEOTRIBU_CONTENUS_DEFAULT_TYPE, --filter-type GEOTRIBU_CONTENUS_DEFAULT_TYPE - Filtrer sur un type de contenu en particulier. (default: None)
-ds GEOTRIBU_CONTENUS_DATE_START, --depuis GEOTRIBU_CONTENUS_DATE_START, --date-start GEOTRIBU_CONTENUS_DATE_START - Date la plus ancienne sur laquelle filtrer les contenus (format: AAAA-MM-JJ). Valeur par défaut : 2020-01-01 (default: 2020-01-01)
-de GEOTRIBU_CONTENUS_DATE_END, --jusqua GEOTRIBU_CONTENUS_DATE_END, --date-end GEOTRIBU_CONTENUS_DATE_END - Date la plus récente sur laquelle filtrer les contenus (format: AAAA-MM-JJ). Valeur par défault : date du jour. (default: 2024-09-18)
-n GEOTRIBU_RESULTATS_NOMBRE, --results-number GEOTRIBU_RESULTATS_NOMBRE - Nombre de résultats à retourner. (default: 5)
-x GEOTRIBU_CONTENUS_INDEX_EXPIRATION_HOURS, --expiration-rotating-hours GEOTRIBU_CONTENUS_INDEX_EXPIRATION_HOURS - Nombre d’heures à partir duquel considérer le fichier local comme périmé. (default: 168)
-o GEOTRIBU_RESULTATS_FORMAT, --format-output GEOTRIBU_RESULTATS_FORMAT - Format de sortie. (default: table)
-a, --no-fusion-par-url - Désactive la fusion des contenus par URL. Les résultats contiendront donc potentiellement donc différentes sections d’un même article.
--no-prompt - Désactive le prompt demandant le résultat à ouvrir à la fin de la commande.

search-image (si)¶

Rechercher dans les images de Geotribu

search-image [-h] [-v] [-r REMOTE_INDEX_FILE] [-l LOCAL_INDEX_FILE]
             [-f GEOTRIBU_IMAGES_DEFAULT_TYPE] [-n GEOTRIBU_RESULTATS_NOMBRE]
             [-x GEOTRIBU_IMAGES_INDEX_EXPIRATION_HOURS] [-o GEOTRIBU_RESULTATS_FORMAT]
             [--no-prompt]
             search-term

search-image positional arguments¶

search-term - Terme de recherche. (default: None)

search-image options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-r REMOTE_INDEX_FILE, --remote-index-file REMOTE_INDEX_FILE - Emplacement du fichier distant. (default: https://cdn.geotribu.fr/img/search-index.json)
-l LOCAL_INDEX_FILE, --local-index-file LOCAL_INDEX_FILE - Emplacement du fichier local. (default: /home/runner/.geotribu/search/cdn_search_index.json)
-f GEOTRIBU_IMAGES_DEFAULT_TYPE, --filter-type GEOTRIBU_IMAGES_DEFAULT_TYPE - Filtrer sur un type d’images en particulier. (default: None)
-n GEOTRIBU_RESULTATS_NOMBRE, --results-number GEOTRIBU_RESULTATS_NOMBRE - Nombre de résultats à retourner. (default: 5)
-x GEOTRIBU_IMAGES_INDEX_EXPIRATION_HOURS, --expiration-rotating-hours GEOTRIBU_IMAGES_INDEX_EXPIRATION_HOURS - Nombre d’heures à partir duquel considérer le fichier local comme périmé. (default: 24)
-o GEOTRIBU_RESULTATS_FORMAT, --format-output GEOTRIBU_RESULTATS_FORMAT - Format de sortie. (default: table)
--no-prompt - Désactive le prompt demandant le résultat à ouvrir à la fin de la commande.

open_result (lire, open, or, read)¶

Ouvre un résultat d’une commande précédente dans le terminal ou l’application correspondant au type de contenu.

open_result [-h] [-v] [-w GEOTRIBU_OPEN_WITH] [result-index]

open_result positional arguments¶

result-index - Numéro du résultat précédent à ouvrir. Valeur par défault : 0. (default: 1)

open_result options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-w GEOTRIBU_OPEN_WITH, --with GEOTRIBU_OPEN_WITH - Avec quoi ouvrir le résultat : dans le terminal (shell) ou dans l'application correspondante au type de contenu (app). Valeur par défault : 'shell’. (default: shell)

upgrade (auto-update, maj, update)¶

Mettre à jour Geotribu CLI.

upgrade [-h] [-v] [-c] [-n] [-w LOCAL_DOWNLOAD_FOLDER]

upgrade options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-c, --check-only - Vérifie seulement la disponibilité d’une nouvelle version, sans télécharger.
-n, --dont-show-release-notes - Display release notes.
-w LOCAL_DOWNLOAD_FOLDER, --where LOCAL_DOWNLOAD_FOLDER - Dossier dans lequel télécharger la nouvelle version. (default: ./)

header-check (header, check, metadata)¶

Vérifier entête markdown

header-check [-h] [-v] [-af AUTHORS_FOLDER] [-maxw MAX_IMAGE_WIDTH] [-maxh MAX_IMAGE_HEIGHT]
             [-minr MIN_IMAGE_RATIO] [-maxr MAX_IMAGE_RATIO] [-r]
             content [content ...]

header-check positional arguments¶

content - Chemin du fichier markdown dont l’entête est à vérifier (default: None)

header-check options¶

-h, --help - show this help message and exit
-v, --verbose - Niveau de verbosité : None = WARNING, -v = INFO, -vv = DEBUG (default: 1)
-af AUTHORS_FOLDER, --authors-folder AUTHORS_FOLDER - Chemin qui contient les presentations markdown des auteurs/autrices (default: None)
-maxw MAX_IMAGE_WIDTH, --max-width MAX_IMAGE_WIDTH - Largeur maximum de l’image à vérifier (default: 800)
-maxh MAX_IMAGE_HEIGHT, --max-height MAX_IMAGE_HEIGHT - Hauteur maximum de l’image à vérifier (default: 800)
-minr MIN_IMAGE_RATIO, --min-ratio MIN_IMAGE_RATIO - Ratio largeur / hauteur minimum de l’image à vérifier (default: 1.45)
-maxr MAX_IMAGE_RATIO, --max-ratio MAX_IMAGE_RATIO - Ratio largeur / hauteur maximum de l’image à vérifier (default: 1.55)
-r, --raise - Lever des exceptions et donc arrêter le programme si des erreurs sont rencontrées

content_manager (new, nouveau)¶

Créer un nouveau contenu.

content_manager [-h] {article} ...

content_manager options¶

-h, --help - show this help message and exit

content_manager Gestion de contenu¶

cmd_content_manager (default: None)

comments (commentaires, coms)¶

Consulter et gérer les commentaires.

comments [-h] {open,lire,ouvrir,broadcast,diffuser,publier,latest,derniers,récents} ...

comments options¶

-h, --help - show this help message and exit

comments Commentaires¶

cmd_comments (default: None)

images (img)¶

Chercher, gérer et optimiser les images.

images [-h] {optimize,process,search,si} ...

images options¶

-h, --help - show this help message and exit

images Images¶

cmd_images (default: None)