Bureau Works CLI — это библиотека NodeJS, которая может быть использована для доступа к вызовам API Bureau Works непосредственно из командной строки.
Можно создавать проекты, утверждать, отменять и многие другие утилиты.
Требования
Для того, чтобы вы могли использовать BWX CLI, вам сначала нужна учетная запись Bureau Works и API KEY. Пожалуйста, посетите https://www.bureauworks.com, чтобы получить свой аккаунт!
После регистрации перейдите на мой счет:
Нажмите на кнопку "Покажите, что мое бюро работает API Token", чтобы создать и получить доступ к нашему API:
Вам также понадобится NodeJS и git, установленные в вашей среде.
Для справки API, пожалуйста, https://dev.bureau.works, что вы сможете увидеть основные звонки.
Установки
Клонировать наш репозиторий GitHub в https://github.com/bureauworks/bwx
$ git клон https://github.com/bureauworks/cli.git
Установка зависимостей
$ npm i
Подтмите cli друзей с вашей оболочки окружающей среды:
$ chmod х cli.js
Вы запустите конфигурацию один раз - это создаст файл config.json в вашем каталоге.
$ ./cli.js config
Вы должны увидеть сообщение, подтверждающее создание файла теперь проверить API с CLI!
Услуги ./cli.js
Языки ./cli.js
Вы можете использовать ссылку npm, чтобы позволить нам локально "связать папку пакета". Если вы сделаете это, вы можете позвонить в CLI в любом месте вашей системы с сокращением bwx:
$ bwx тайм-зоны
$ bwx Языки
Для получения помощи используйте:
$ bwx --помощь
Или для конкретных команд, например, команды создания проекта:
$ bwx создать --помощь
Обновление:
Если у вас уже установлена командная линия API, вы всегда можете обновить ее до последней версии.
Как только вы находитесь внутри репозитория, запустите следующие команды:
$ git тянуть https://github.com/bureauworks/cli.git
$ npm ссылка
Делая это, CLI будет тянуть последнюю версию из нашего удаленного репозитория.
Команды:
- конфигурация - Читает параметры конфигурации из командной строки и сохраняет в q/.bw/config.json
- языки - Списки кодов ISO доступных языков
- timezones - Списки тайм-зон, доступных в Бюро работ
- услуги - Все услуги и ID, доступные для запроса проектов в Бюро работ
создать «варианты» - Создает новый проект в Бюро работ, возвращает строку JSON с ID-данными и соответствующей информацией.
ПАРАМЕТРЫ:
- -r, --справочная <ссылка>
↳ Project, значение строки, которое можно использовать для идентификации этого проекта
- -o, --оригинальный <оригинал>
↳ язык источника проекта
- -l, <--Языки>
↳ целевых языков проекта, кодов ИСО, разделенных запятыми
- -s, <--услуги>
↳Долго» с ID-адресами Службы, .например, 1 для перевода, 3 для транскрипции; отдельно с запятыми
- -n, <--примечание>
↳ Описательная записка
- -d, --доставка <longValue>
↳ Дата доставки
Пример: $ bwx создать -r 'справочный код' -o en_us -l pt_br,es,ru_ru,de_de,fr_fr,it_it -s 1 -n 'Проект отмечает, специальные инструкции и т.д.' -d 1535661374000
Загрузить «опции» - Загрузить файл в проект, готовясь к производству и цитируя в Бюро работ, возвращает JSON с проектом и информацией Job ID.
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳ идентификатор проекта
- -s, --service_item <сид>
↳ Идентификатор элемента обслуживания
- -f, <--файл>
↳ Файл в текущей файловой системе
Пример: $ bwx загрузить -p 17530 -s 23207 -f ./files/filename.docx
непрерывные «варианты» - Загружает файл в проект непрерывной интеграции. Этот метод предполагает, что в профиле установлены целевые языки по умолчанию. Непрерывные утверждаются после заранее установленного графика.
ПАРАМЕТРЫ:
- -t, <--тег>
↳ тег для идентификации этого проекта, например, ios, андроид и т.д.
- -r, --справочная <ссылка>
↳мнемоническая или закодированная ссылка для вашей записи
- -f, <--файл>
↳ Файл в текущей файловой системе
- -l, --Языки (языки)
↳Определимые, целевые языки проекта, коды ISO, разделенные запятыми - если они установлены, будут переопределять заданные клиентом заданные языки
Пример: $ bwx непрерывный -r 'Некоторые ссылки' -t андроид -f ./files/strings.xml
Принуждение целевых языков: $ bwx непрерывной -r 'Некоторые ссылки' -t андроид -f ./files/strings.xml -l pt_br,es_es,fr_fr,de_de
готовые «варианты» - Флаги проекта как READY, что означает, что вы закончили загружать файлы, и теперь система будет цитировать проект. Возвращает JSON с разбивкой расходов.
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx готов -p 17532
утвердить «варианты» - Утверждает проект в Бюро работ.
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx утвердить -p 17532
отменить «варианты» - Отменяет проект в Бюро работ
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx отменить -p 17532
Проект «варианты» - Метаданные проекта нагрузок от Bureau Works
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx проекта -p 17532
список «вариантов» - Загружает список проектов из Бюро работ, используя статус в качестве параметра
ПАРАМЕТРЫ:
- -s, --статус <статус>
↳Везий проекта - PREPARING, PENDING, APPROVED, CANCELLED или INVOICED
Пример: $ bwx список -s PENDING
затраты (варианты) - Загружает структуру затрат, связанную с данным проектом
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx расходы -p 17532
элементы (варианты) - Загружает элементы, связанные с данным проектом
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
Пример: $ bwx пунктов -p 17532
утвердить-работу (варианты) - Утверждает данное задание
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
- -j, <--работаId>
↳ идентификатор работы
Пример: $ bwx утвердить работу -p 17532 -j 87432
отклонить-работа (варианты) - Отклоняет данное задание
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
- -j, <--работаId>
↳ идентификатор работы
Пример: $ bwx отклонить работу -p 17532 -j 87432
скачать «опции» - Загружает файл с идентификатором работы
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
- -j, <--работаId>
↳ Идентификатор работы
- -d, --направление (каталог)
↳Optional, если перешел на функцию сохранит файл в данном каталоге
Пример: $ bwx скачать -p 17532 -j 87432 -d /files/repo/
загрузка-непрерывные «варианты» - Загрузка файла с учетом идентификации тегов для проектов непрерывной интеграции
ПАРАМЕТРЫ:
- -t, <--тег>
↳ Тег, который определит проект в пуле проектов CI
- -f, --файловое имя <файла>
↳Имя файла
- -s, --статус <статус>
↳ Статус работы, используйте DELIVERED для окончательных файлов или APPROVED для частично завершенных файлов как с переводом памяти, так и со строками машинного перевода
- -d, --направление (каталог)
↳Optional, если перешел на функцию сохранит файл в данном каталоге
Пример: $ bwx скачать-непрерывный -t андроид -f strings.xml-s APPROVED
download-by-filename (опции) - Альтернативный метод загрузки, использует идентификатор проекта, идентификатор элемента обслуживания и имя файла. Этот метод полезен для нечетных поставок, например, если файл доставки разделен на несколько файлов или если доставленный файл имеет другой формат, чем входной
ПАРАМЕТРЫ:
- -p, --проект <проектаId>
↳Проект ID
- -s, --service_item <сид>
↳ Идентификатор элемента обслуживания
- -f, --файловое имя <файла>
↳Они, включая любые предыдущие компоненты пути, например, /pt_br/filename.docx
- -d, --направление (каталог)
↳Optional, если перешел на функцию сохранит файл в данном каталоге
Пример: $ bwx скачать по файлу -p 17532 -s 87432 -f pt_br/file.json -d /files/repo/
Комментарии
0 комментариев
Войдите в службу, чтобы оставить комментарий.