Le Bureau Works CLI est une bibliothèque NodeJS qui peut être utilisée pour accéder aux appels API Bureau Works directement à partir de la ligne de commande.
Il est possible de créer des projets, d’approuver, d’annuler et de nombreux autres utilitaires.
Exigences
Pour que vous soyez en mesure d’utiliser le CLI BWX, vous avez d’abord besoin d’un compte Bureau Works et d’UNE CLÉ d’API. S’il vous plaît visitez https://www.bureauworks.com pour obtenir votre compte!
Après vous être inscrit, accédez à Mon compte :
Cliquez sur « Afficher le jeton API mon bureau fonctionne » pour générer et obtenir vos informations d’identification pour accéder à notre API :
Vous aurez également besoin de NodeJS et git installés dans votre environnement.
Pour obtenir une référence api, veuillez visiter https://dev.bureau.works que vous pourrez voir les principaux appels.
Installation
Cloner notre référentiel GitHub à https://github.com/bureauworks/bwx
$ git clone https://github.com/bureauworks/cli.git
Installer des dépendances
$ npm i
Faites les amis CLI avec votre environnement shell :
$ chmod +x cli.js
Exécutez la configuration une fois - cela créera un fichier config.json dans votre répertoire ~/.bwx/.
$ ./cli.js config
Vous devriez voir un message confirmant la création de fichier maintenant tester l’API avec le CLI!
$ ./cli.js services
$ langues ./cli.js
Vous pouvez utiliser le lien npm pour nous permettre de 'symlink un dossier de package' local. Si vous le faites, vous pouvez appeler le CLI n’importe où dans votre système avec le raccourci bwx:
Fuseaux horaires bwx $
$ bwx langues
Pour obtenir de l’aide, utilisez :
$ bwx --aide
Ou pour des commandes spécifiques, par exemple, la commande création de projet :
$ bwx créer --aide
Actualisation:
Si votre ligne de commande API est déjà installée, vous pouvez toujours la mettre à jour vers la dernière version.
Une fois que vous êtes à l’intérieur du référentiel, exécutez les commandes suivantes :
$ git tirer https://github.com/bureauworks/cli.git
Lien npm $
Ce faisant, le CLI retirera la dernière version de notre référentiel distant.
Commandes:
- config - Lit les paramètres de configuration de la ligne de commande et enregistre dans ~/.bw/config.json
- langues - Répertorie les codes ISO des langues disponibles
- fuseaux horaires - Répertorie les fuseaux horaires disponibles dans Bureau Works
- services - Tous les services et ids disponibles pour demander des projets dans Bureau Works
créer [options] - Crée un nouveau projet dans Bureau Works, renvoie une chaîne JSON avec des ids et des informations pertinentes.
OPTIONS:
- -r, <--référence>
↳ référence Project, une valeur de chaîne que vous pouvez utiliser pour identifier ce projet
- -o, <--original>
↳ langue de source du projet
- -l, <--langues langues>
↳ les langues cibles du projet, les codes ISO séparés par des virgules
- -s, <--services services>
↳Long[] avec les ID de service, par exemple, 1 pour la traduction, 3 pour la transcription; séparer avec des virgules
- -n, <--note note>
↳ Une note descriptive
- -d, --livraison <longValue>
↳Date de livraison de la date de livraison
Exemple: $ bwx create -r 'A reference code' -o en_us -l pt_br,es,ru_ru,de_de,fr_fr,it_it -s 1 -n 'Notes de projet, instructions spéciales, etc.' -d 1535661374000
télécharger [options] - Télécharge un fichier sur un projet en cours de préparation pour la production et de cotation dans Bureau Works, renvoie un JSON avec les informations project et job id.
OPTIONS:
- -p, --project <projectId>
↳ l’ID du projet
- -s, --service_item <sid>
ID d’élément ↳Service
- -f, <--fichier>
↳ Le fichier dans le système de fichiers actuel
Exemple : $ bwx upload -p 17530 -s 23207 -f ./files/filename.docx
[options] continues - Télécharge un fichier vers un projet d’intégration continue. Cette méthode suppose que vous avez configuré les langues cibles par défaut dans votre profil. Les demandes continues sont approuvées après un calendrier préétabli.
OPTIONS:
- -t, <--tag tag>
↳ une balise pour identifier ce projet, par exemple, ios, android, etc.
- -r, <--référence>
↳Une référence mnémonique ou codée pour votre dossier
- -f, <--fichier>
↳Le fichier dans le système de fichiers actuel
- -l, --langues [langues]
↳Optional, Project target languages, ISO codes separated by commas - if set, will override client-defined languages
Exemple : $ bwx continu -r 'Some reference' -t android -f ./files/strings.xml
Forcer les langues cibles : $bwx continu -r 'Some reference' -t android -f ./files/strings.xml -l pt_br,es_es,fr_fr,de_de
ready [options] - Signale un projet comme READY, ce qui signifie que vous avez terminé le téléchargement de fichiers et que le système va maintenant citer le projet. Renvoie un JSON avec la ventilation des coûts.
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple: $ bwx prêt -p 17532
approuver [options] - Approuve un projet dans Bureau Works.
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple: $ bwx approuver -p 17532
annuler [options] - Annule un projet dans Bureau Works
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple: $ bwx annuler -p 17532
project [options] - Charge les métadonnées du projet de Bureau Works
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple : projet bwx $p 17532
liste [options] - Charge une liste de projets de Bureau Works à l’aide de l’état comme paramètre
OPTIONS:
- -s, statut <--statut>
↳L’ÉTAT DU PROJET - PRÉPARATION, ATTENTE, APPROUVÉ, ANNULÉ OU FACTURÉ
Exemple : $ bwx list -s PENDING
coûts [options] - Charge la structure de coûts associée à un projet donné
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple: $ bwx coûts -p 17532
éléments [options] - Charge les éléments associés à un projet donné
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
Exemple: $ bwx articles -p 17532
approuver l’emploi [options] - Approuve un emploi donné
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
- -j, <--jobId>
↳ L’ID d’emploi
Exemple: $ bwx approve-job -p 17532 -j 87432
rejeter-emploi [options] - Rejette un emploi donné
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
- -j, <--jobId>
↳ L’ID d’emploi
Exemple: $ bwx reject-job -p 17532 -j 87432
télécharger [options] - Télécharge un fichier donné un ID de travail
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
- -j, <--jobId>
↳L’ID d’emploi
- -d, --destination [répertoire]
↳Optional, s’il est transmis à la fonction enregistrera le fichier dans le répertoire donné
Exemple: $ bwx télécharger -p 17532 -j 87432 -d /files/repo/
téléchargement continu [options] - Télécharge un fichier avec une identification de balise pour les projets d’intégration continue
OPTIONS:
- -t, <--tag tag>
↳ Une balise qui identifiera le projet dans le pool de projets CI
- -f, --nom de <fichier>
↳Le nom du fichier
- -s, statut <--statut>
↳L’état du travail, utiliser DELIVERED pour les fichiers finaux ou APPROUVÉ pour les fichiers partiellement terminés avec des chaînes mémoire de traduction et de traduction automatique
- -d, --destination [répertoire]
↳Optional, s’il est transmis à la fonction enregistrera le fichier dans le répertoire donné
Exemple: $ bwx download-continu -t android -f strings.xml -s APPROVED
download-by-filename [options] - Méthode de téléchargement alternatif, utilise Project ID, Service Item ID et un nom de fichier. Cette méthode est utile pour les livraisons impaires, par exemple, si un fichier de livraison est divisé en plusieurs fichiers ou si le fichier livré a un format différent de celui de l’entrée
OPTIONS:
- -p, --project <projectId>
↳L’ID du projet
- -s, --service_item <sid>
↳L’ID de l’élément de service
- -f, --nom de <fichier>
↳Le nom de fichier, y compris les composants de chemin d’accès précédents, par exemple, /pt_br/filename.docx
- -d, --destination [répertoire]
↳Optional, s’il est transmis à la fonction enregistrera le fichier dans le répertoire donné
Exemple: $ bwx download-by-filename -p 17532 -s 87432 -f pt_br/file.json -d /files/repo/
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.