Interface de ligne de commande¶
Une interface de ligne de commande (CLI) est disponible pour gérer la base de données, les jetons OAuth2, les utilisateurs et le chargement des archives de séances.
$ ftcli
Usage: ftcli [OPTIONS] COMMAND [ARGS]...
FitTrackee Command Line Interface
Options:
--help Show this message and exit.
Commands:
db Manage database.
oauth2 Manage OAuth2 tokens.
users Manage users.
workouts Manage workouts.
Base de données¶
ftcli db drop¶
Ajouté dans la version 0.6.5.
Vider la base de données et supprimer les fichiers téléchargés, uniquement pour les environnements de développement.
ftcli db upgrade¶
Ajouté dans la version 0.6.5.
Appliquer les migrations.
OAuth2¶
ftcli oauth2 clean¶
Ajouté dans la version 0.7.0.
Supprimer les jetons expirés depuis plus d'un certain nombre de jours
Options |
Description |
|---|---|
|
Nombre de jours. |
Utilisateurs¶
ftcli users clean_archives¶
Ajouté dans la version 0.7.13.
Supprimer les demandes d'export et les archives associées créées depuis plus d'un certain nombre de jours.
Options |
Description |
|---|---|
|
Nombre de jours. |
ftcli users clean_tokens¶
Ajouté dans la version 0.7.0.
Supprimer les jetons de la liste noire expirés depuis plus d'un certain nombre de jours.
Options |
Description |
|---|---|
|
Nombre de jours. |
ftcli users create¶
Ajouté dans la version 0.7.15.
Modifié dans la version 0.8.4: La préférence de l'utilisateur pour la langue de l'interface est ajoutée.
Modifié dans la version 0.9.0: Ajout d'une option pour le rôle de l'utilisateur.
Modifié dans la version 0.9.4: La préférence pour le fuseau horaire est ajoutée.
Créer un compte utilisateur.
Note
le compte nouvellement créé est déjà actif.
la CLI permet de créer des utilisateurs lorsque l'enregistrement est désactivé.
Arguments/options |
Description |
|---|---|
|
Nom de l'utilisateur. |
|
Adresse électronique de l'utilisateur (obligatoire). |
|
Mot de passe de l'utilisateur (s'il n'est pas fourni, un mot de passe aléatoire est généré). |
|
Préférence de l'utilisateur pour la langue de l'interface (code à deux lettres, ISO 639-1). Si elle n'est pas fournie ou prise en charge, la valeur par défaut est l'anglais ("en"). |
|
Préférence pour le fuseau horaire. Si non fournie ou non prise en charge, la valeur par défaut est 'Europe/Paris'. |
|
Rôle de l'utilisateur (valeur par défaut: 'user') |
ftcli users export_archive¶
Ajouté dans la version 0.10.0.
Traiter un export de données utilisateur en attente
Peut être utilisé si redis n'est pas activé (pas de workers dramatiq en cours d'exécution).
Options |
Description |
|---|---|
|
Identifiant de la tâche à traiter |
ftcli users export_archives¶
Ajouté dans la version 0.7.13.
Traiter les requêtes d'export des données utilisateurs en attente.
Peut être utilisé si redis n'est pas activé (pas de workers dramatiq en cours d'exécution).
Options |
Description |
|---|---|
|
Nombre maximal de demandes d'export à traiter. |
ftcli users update¶
Ajouté dans la version 0.6.5.
Modifié dans la version 0.9.0: Add --set-role option. --set-admin is now deprecated.
Modifier le compte d'un utilisateur (rôle, statut actif, email et mot de passe).
Arguments/options |
Description |
|---|---|
|
Nom de l'utilisateur. |
|
[DÉPRÉCIÉ] Ajouter/supprimer des droits d'administration (lors de l'ajout de droits d'administration, le compte de l'utilisateur est également activé s'il ne l'est pas). |
|
Configurer le rôle (lors de la configuration des rôles 'moderator', 'admin' et 'owner', le compte de l'utilisateur est également activé s'il ne l'est pas. |
|
Activer le compte d'un utilisateur. |
|
Réinitialiser le mot de passe de l'utilisateur (un nouveau mot de passe sera affiché). |
|
Nouvelle adresse électronique de l'utilisateur |
Séances¶
ftcli workouts archive_upload¶
Ajouté dans la version 0.10.0.
Traiter un chargement d'archive de séances en attente donné
Peut être utilisé si redis n'est pas activé (pas de workers dramatiq en cours d'exécution).
Options |
Description |
|---|---|
|
Identifiant de la tâche à traiter |
ftcli workouts archive_uploads¶
Ajouté dans la version 0.10.0.
Traite les tâches de chargement des archives de séances si des tâches en attente existent (progression = 0 et tâches non interrompues on en erreur).
Peut être utilisé si redis n'est pas activé (pas de workers dramatiq en cours d'exécution).
Options |
Description |
|---|---|
|
Nombre maximal de chargement d'archives de séances à traiter. |
ftcli workouts refresh¶
Ajouté dans la version 0.12.0.
Actualiser les séances en recalculant les données de la séance et en récupérant les données météo si un fournisseur est configuré et que la séance n'a pas de données météo
Avant d'exécuter la commande, il est recommandé de sauvegarder toutes les données (base de données et répertoire des fichiers téléversé) dans le cas où un grand nombre d'entraînements serait mis à jour.
Avertissement
Si un fournisseur de données météo est défini et que l'option --with-weather est fournie, la limite d'accès peut être atteinte, résultant en des erreurs de limite dépassée quand un nombre important de séances est actualisé.
Options |
Description |
|---|---|
|
identifiant du sport |
|
date de début (format : |
|
date de fin (format : |
|
nombre de séances par page (par défaut : 10) |
|
page pour la pagination (par défaut : 1) |
|
ordre de tri des séances : 'asc' ou 'desc' (par défaut : 'asc') |
|
nom de l'utilisateur des séances à mettre à jour |
|
extension du fichier de la séance (valeurs possibles: tcx, kmz, gpx, kml, fit) |
|
active la récupération des données météo si un fournisseur de données est configuré et que la séance n'a pas données météo. ATTENTION: selon la souscription, la limite d'accès peut être atteinte, résultant en des erreurs et empêchant les données météo d'être récupérées pour les prochains chargements de fichiers, le temps que la limite soit réinitialisée (défaut: désactivé) |
|
Active les logs verbeux (défaut: désactivé) |