ビューローワークス API コマンド ライン

ビューローワークスCLIは、コマンドラインから直接ビューローワークスAPI呼び出しにアクセスするために使用できるNodeJSライブラリです。

プロジェクトの作成、承認、キャンセル、およびその他の多くのユーティリティを作成できます。

要件

BWX CLI を使用するには、まず、ビューロー ワークス アカウントと API キーが必要です。アカウントを取得するにはhttps://www.bureauworks.comをご覧ください。

登録後、[マイアカウント] に移動します。

 

「マイビューローワークスAPIトークンを表示」をクリックして、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 +x cli.js

構成を 1 回実行する - ~/.bwx/ ディレクトリに config.json ファイルが作成 されます。 

$ ./cli.js 構成

ファイル作成を確認するメッセージが表示され、CLI で API をテストするようになりました。

$ ./cli.js サービス

$ ./cli.js 言語

npm リンクを使用 して、パッケージフォルダをローカルにシンボリックリンクすることができます。この場合 、bwx 短縮形でシステム内の任意の場所で CLI を呼び出すことができます。

$ bwxタイムゾーン

$ bwx言語

ヘルプについては、次の情報を参照してください。

$ bwx --ヘルプ

または、プロジェクト作成コマンドなど、特定のコマンドの場合は、次のコマンドを実行します。

$ bwx 作成 --help

 

更新：

API コマンド ラインが既にインストールされている場合は、いつでも最新バージョンに更新できます。

リポジトリ内に 入ったら 、次のコマンドを実行します。 

$ git プル https://github.com/bureauworks/cli.git

$ npm リンク 

これにより、CLI は最新バージョンをリモート リポジトリから取得します。

 

コマンド：

• config - コマンドラインから設定パラメータを読み込み、~/.bw/config.json に保存します。
• 言語 - 利用可能な言語の ISO コードを一覧表示します。
• タイムゾーン - ビューローワークスで利用可能なタイムゾーンを一覧表示します
• サービス - ビューローワークスのプロジェクトを依頼するために利用可能なすべてのサービスとID

 

[オプションを作成] - ビューローワークスで新しいプロジェクトを作成し、ID と関連情報を含む JSON 文字列を返します。

オプション：

• -r,--参照 <参照> 

ておいてくださいプロジェクト参照、このプロジェクトを識別するために使用できる文字列値

 

• -o、 <オリジナル> 

  プロジェクターソース言語

 

• -l, -- <言語言語>

  うことによって区切られたプロジェクトターゲット言語、ISOコード

 

• -s,-- <サービスサービス>    

  ストリーミングサービスIDを使用する場合、例えば、翻訳用に1つ、転写用に3つ。コンマで区切る

• -n、--note <> 

  くのことを説明するメモ

 

• -d, --配信 <長い価値>   

  娩希望日

 

例: $ bwx は -r '参照コード' -o en_us -l pt_br,es,ru_ru,de_de,fr_fr,it_it -s 1 -n 'プロジェクトノート、特別な指示など' -d 1535661374000

 

アップロード [オプション] - ビューローワークスで生産と引用のために準備されているプロジェクトにファイルをアップロードし、プロジェクトとジョブID情報を含むJSONを返します。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  クワッド・プロジェクトID

 

• -s,--service_item <シド>   

  ストリーミングサービスID

 

• -f,-- <ファイルファイル>

  カレント・ファイル・システム内のファイル

 

例: $ bwx アップロード -p 17530 -s 23207 -f ./ファイル/ファイル名.docx

連続する [オプション] - ファイルを継続的インテグレーション プロジェクトにアップロードします。この方法では、プロファイルにデフォルトのターゲット言語が設定されていることを前提としています。連続は、事前に確立されたスケジュールの後に承認されます。

オプション：

• -t,-- <タグタグ>

  ニスト、例えば、このプロジェクトを識別するためのタグ、アンドロイドなど

 

• -r,--参照 <参照>  

  ておいてください あなたのレコードのためのニーモニックまたはコード化された参照

 

• -f,-- <ファイルファイル>

  カレント・ファイル・システム内のファイル

• -l, --言語 [言語] 

  うことによって、プロジェクトのターゲット言語、ISO コードをカンマで区切って指定 - 設定すると、クライアント定義のプリセット言語が上書きされます。

 

  例: $ bwx 連続 -r 'いくつかの参照' -t アンドロイド -f ./ファイル/文字列.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

 

プロジェクト [オプション] - ビューローワークスからプロジェクトメタデータを読み込む

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

  例: $ bwx プロジェクト -p 17532

 

リスト [オプション] - ステータスをパラメータとして使用して、ビューローワークスからプロジェクトのリストをロードします。

オプション：

• -s、-- <ステータス>  

  共同創設者プロジェクト状況 - 準備、保留、承認、キャンセル、または請求

 

  例: $ bwx リスト -s 保留中

 

コスト [オプション] - 特定のプロジェクトに関連付けられているコスト構造を読み込みます。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

  例: $ bwx コスト -p 17532

 

項目 [オプション] - 指定されたプロジェクトに関連付けられている項目を読み込みます。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

  例: $ bwx アイテム -p 17532

ジョブの承認 [オプション] - 特定のジョブを承認します。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

• -j, -- <ジョブジョブId>

  クワッド・ジョブID

 

  例: $ bwx 承認ジョブ -p 17532 -j 87432

 

ジョブを拒否する [オプション] - 特定のジョブを拒否します。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

• -j, -- <ジョブジョブId>

  クワッド・ジョブID

 

  例: $ bwx 拒否ジョブ -p 17532 -j 87432

 

ダウンロード [オプション] - ジョブ ID を指定したファイルをダウンロードします。

オプション：

• -p, -- <プロジェクトプロジェクトID>  

  パルト生プロジェクトID

 

• -j, -- <ジョブジョブId>

  パルト生ID

• -d,--宛先 [ディレクトリ]

  別名を指定すると、関数に渡された場合、指定したディレクトリにファイルが保存されます。

例: $ bwx ダウンロード -p 17532 -j 87432 -d /ファイル/レポ/

 

ダウンロード連続 [オプション] - 継続的インテグレーションプロジェクトのタグ ID を指定してファイルをダウンロードします。

オプション：

• -t,-- <タグタグ>

  サイダープロジェクトのプール内のプロジェクトを識別するタグ

• -f, --ファイル <名 ファイル名>

  申告ファイル名

• -s、-- <ステータス>

  捗状況は、最終ファイルに対して[配信]を使用するか、翻訳メモリと機械翻訳文字列の両方を持つ部分的に完了したファイルに対して承認済み

• -d,--宛先 [ディレクトリ]

  別名を指定すると、関数に渡された場合、指定したディレクトリにファイルが保存されます。

  例: $ bwx ダウンロード連続 -t アンドロイド -f 文字列.xml -s 承認済み

 

ファイル名でダウンロードする [オプション] - 代替ダウンロード方法では、プロジェクト ID、サービスアイテム ID、およびファイル名を使用します。この方法は、配信ファイルが複数のファイルに分割されている場合や、配信されたファイルの形式が入力ファイルと異なる場合などに、配信が奇数の場合に便利です。

オプション：

• -p, -- <プロジェクトプロジェクトID>

  パルト生プロジェクトID

 

• -s,--service_item <シド>

  パルト入ID

 

• -f, --ファイル <名 ファイル名>

  先行するパスコンポーネントを含むファイル名(/pt_br/filename.docx など)

 

• -d,--宛先 [ディレクトリ]

  別名を指定すると、関数に渡された場合、指定したディレクトリにファイルが保存されます。

 

例: $ bwx ファイル名によるダウンロード -p 17532 -s 87432 -f pt_br/file.json -d /ファイル/レポ/