O Bureau Works CLI é uma biblioteca NodeJS que pode ser usada para acessar as chamadas da API do Bureau Works diretamente da linha de comando.
É possível criar projetos, aprovar, cancelar e muitos outros utilitários.
Requisitos
Para que você possa usar o BWX CLI, primeiro você precisa de uma conta do Bureau Works e key da API. Visite https://www.bureauworks.com para obter sua conta!
Após o cadastro, acesse Minha Conta:
Clique em "Mostrar o Token de API do Meu Bureau Works" para gerar e obter suas credenciais para acessar nossa API:
Você também precisará de NodeJS e git instalados em seu ambiente.
Para referência à API, visite https://dev.bureau.works que você poderá ver as principais chamadas.
Instalação
Clone nosso repositório GitHub em https://github.com/bureauworks/bwx
$ git clone https://github.com/bureauworks/cli.git
Instalar dependências
$ npm i
Faça o CLI amigo do seu ambiente de conchas:
$ chmod +x cli.js
Execute a configuração uma vez - isso criará um arquivo config.json em seu diretório ~/.bwx.
$ ./cli.js config
Você deve ver uma mensagem confirmando a criação do arquivo agora teste a API com o CLI!
$ ./serviços cli.js
Línguas de $ ./cli.js
Você pode usar o link npm para nos permitir "symlink localmente uma pasta de pacote". Se você fizer isso, você pode chamar o CLI em qualquer lugar do seu sistema com a taquigrafia bwx:
$ bwx fusos horários
Línguas de $ bwx
Para a ajuda, use:
$ bwx --ajuda
Ou para comandos específicos, por exemplo, o comando de criação de projetos:
$ bwx criar --ajuda
Atualização:
Se você já tiver nossa linha de comando API instalada, você sempre pode atualizá-la para a versão mais recente.
Uma vez dentro do repositório, execute os seguintes comandos:
$ git puxar https://github.com/bureauworks/cli.git
Link de $npm
Fazendo isso, o CLI puxará a versão mais recente do nosso repositório remoto.
Comandos:
- config - Lê parâmetros de configuração da linha de comando e salva em ~/.bw/config.json
- idiomas - Lista os códigos ISO dos idiomas disponíveis
- fusos horários - Lista os fusos horários disponíveis no Bureau Works
- serviços - Todos os Serviços e IDs disponíveis para solicitação de projetos em Bureau Works
criar [opções] - Criar um novo Projeto em Obras de Bureau, retornar uma string JSON com IDs e informações relevantes.
OPÇÕES:
- -r, <-referência>
↳ referência ao Projeto, um valor de string que você pode usar para identificar este projeto
- -o, <--original original>
↳ linguagem de origem do Projeto
- -l, <línguas línguas>
↳ idiomas-alvo do Projeto, códigos ISO separados por círgulas
- -s, <-serviços>
↳Long[] com os IDs de serviço, .por exemplo, 1 para tradução, 3 para transcrição; separados com írgulas
- -n, <-nota>
↳ Uma nota descritiva
- -d, --entrega <longValue>
↳Desejável data de entrega
Exemplo: $ bwx criar -r 'Um código de referência' -o en_us -l pt_br,es,es,ru_ru,de_de,fr_fr,it_it -s 1 -n 'Notas do projeto, instruções especiais, etc.' -d 1535661374000
upload [opções] - Envia um arquivo para um projeto que está sendo preparado para produção e citando em Bureau Works, retorna um JSON com as informações do Project and Job ID.
OPÇÕES:
- -p, <--project projectId>
↳ O ID do Projeto
- -s, --service_item <sid>
ID do item ↳Service
- -f, arquivo -arquivo <>
↳ O arquivo no sistema de arquivos atual
Exemplo: $ bwx upload -p 17530 -s 23207 -f ./files/filename.docx
contínuas [opções] - Carrega um arquivo para um projeto de integração contínua. Este método pressupõe que você tenha a configuração de idiomas de destino padrão em seu perfil. Os contínuos são aprovados após um cronograma pré-estabelecido.
OPÇÕES:
- -t, tag <-tag>
↳ Uma tag para identificar este projeto, por exemplo, ios, android, etc.
- -r, <-referência>
↳Uma referência mnemônica ou codificada para o seu registro
- -f, arquivo -arquivo <>
↳O arquivo no sistema de arquivos atual
- -l, --línguas [línguas]
↳Pational, idiomas de destino do projeto, códigos ISO separados por círgulas - se definidos, substituirão idiomas predefinidos definidos pelo cliente
Exemplo: $ bwx contínuo -r 'Alguma referência' -t android -f ./files/strings.xml
Forçando idiomas de destino: $ bwx contínuo -r 'Alguma referência' -t android -f ./files/strings.xml -l pt_br,es_es,fr_fr,de_de
pronto [opções] - Sinaliza um projeto como READY, o que significa que você terminou arquivos de upload e o sistema agora citará o projeto. Retorna um JSON com a divisão de custos.
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx pronto -p 17532
aprovar [opções] - Aprova um Projeto em Obras de Bureau.
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx aprovar -p 17532
cancelar [opções] - Cancela um Projeto em Bureau Works
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx cancelar -p 17532
projeto [opções] - Carrega metadados do Projeto da Bureau Works
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx projeto -p 17532
lista [opções] - Carrega uma lista de projetos da Bureau Works usando status como parâmetro
OPÇÕES:
- -s, <status>
↳A Situação do Projeto - PREPARAÇÃO, PENDÊNCIA, APROVADA, CANCELADA ou FATURADA
Exemplo: $ bwx lista -s PENDENTE
custos [opções] - Carrega a estrutura de custos associada a um determinado Projeto
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx custa -p 17532
itens [opções] - Carrega os itens associados a um determinado Projeto
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
Exemplo: $ bwx itens -p 17532
aprovar-emprego [opções] - Aprova um determinado Trabalho
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
- -j, <-jobti>
↳ a Carteira de Trabalho
Exemplo: $ bwx aprovação-job -p 17532 -j 87432
rejeitar-emprego [opções] - Rejeita um determinado Trabalho
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
- -j, <-jobti>
↳ a Carteira de Trabalho
Exemplo: $ bwx rejeitar-job -p 17532 -j 87432
baixar [opções] - Baixa um arquivo dado um Job ID
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
- -j, <-jobti>
↳A Carteira de Trabalho
- -d, --destino [diretório]
↳Optional, se passado para a função salvará o arquivo no diretório dado
Exemplo: $ bwx download -p 17532 -j 87432 -d /files/repo/
download-contínuo [opções] - Baixa um arquivo dado uma identificação de tag para projetos de Integração Contínua
OPÇÕES:
- -t, tag <-tag>
↳A tag que identificará o projeto na piscina de projetos de CI
- -f, -nome de arquivo <nome de arquivo>
↳O nome do arquivo
- -s, <status>
↳O status de trabalho, use DELIVERED para arquivos finais ou APROVADO para arquivos parcialmente concluídos com sequências de memória de tradução e tradução automática
- -d, --destino [diretório]
↳Optional, se passado para a função salvará o arquivo no diretório dado
Exemplo: $ bwx download-contínuo -t android -f strings.xml -s APROVADO
download por arquivo [opções] - Método de download alternativo, usa ID do Projeto, ID do item de serviço e um nome de arquivo. Este método é útil para entregas ímpares, por exemplo, se um arquivo de entrega for dividido em vários arquivos ou se o arquivo entregue tiver um formato diferente do da entrada
OPÇÕES:
- -p, <--project projectId>
↳O ID do Projeto
- -s, --service_item <sid>
↳A ID do item de serviço
- -f, -nome de arquivo <nome de arquivo>
↳O nome do arquivo, incluindo quaisquer componentes de caminho anteriores, por exemplo, /pt_br/filename.docx
- -d, --destino [diretório]
↳Optional, se passado para a função salvará o arquivo no diretório dado
Exemplo: $ bwx download por arquivo nome -p 17532 -s 87432 -f pt_br/file.json -d /files/repo/
Comentários
0 comentário
Por favor, entre para comentar.