CLIコマンドリファレンス ​

SDK gemをインストールした後にCLIで使用できるコマンドについて詳しく学びます。

workato ​

Workato gemのルートコマンド。 workato helpと同義です。

利用状況 ​

$ workato

出力 ​

Workato gemで使用可能なコマンドの説明。

workato edit ​

暗号化ファイルを作成または編集します。

利用状況 ​

$ workato edit <PATH>

入力 ​

オプション ​

結果 ​

暗号化ファイルが作成または更新されます。 ファイルが以前に存在せず、オプションが指定されていない場合はmaster.keyが作成されます。

例 ​

Windowsの場合：
  $ set EDITOR=notepad
  $ workato edit settings.yaml.enc
Macの場合：
  $ EDITOR="nano" workato edit settings.yaml.enc

workato exec ​

テストのために、コネクタ内の特定のlambda関数を実行します。

利用状況 ​

$ workato exec <PATH> <OPTIONS>

入力 ​

オプション ​

結果 ​

lambda関数の出力。

例 ​

$ workato exec methods.sample_method --args='input/sample_method_input.json'

workato exec connection.authorization.acquire --connector='zoominfo.rb' --settings='settings.yaml' --connection='My Valid Connection' --verbose

workato exec test --connector='zoominfo.rb' --settings='settings.yaml' --connection='My Valid Connection' --verbose

$ workato exec actions.search_customers.execute --input='input/search_customer_input.json' --verbose

$ workato exec triggers.new_updated_customers.poll --input='input/new_updated_customers_input.json' --verbose

$ workato exec triggers.new_updated_customers.poll_page --input='input/new_updated_customers_input.json' --verbose

workato generate ​

指定されたJSONまたはCSVに基づいてWorkatoスキーマを生成するか、指定されたコネクタに基づいてテストを生成します

利用状況 ​

$ workato generate <SUBCOMMAND>

入力 ​

workato generate schema ​

指定されたJSONまたはCSVファイルを取得し、コネクタで使用するWorkato Schemaに変換します

利用状況 ​

$ workato generate schema --api-token <API-TOKEN> <OPTIONS>

オプション ​

例 ​

$ workato generate schema --api-token --json='fixtures/actions/search_customers/input.json'

$ workato generate schema --api-token --csv='fixtures/actions/report/input.csv' --col-sep=pipe

workato generate test ​

指定されたコネクタを取得し、指定された機能のRSpecテストを生成します。

利用状況 ​

$ workato generate test <OPTIONS>

オプション ​

例 ​

$ workato generate test

$ workato generate test action=get_customers

workato help ​

指定されたSDK gemコマンドのヘルプを表示します。

利用状況 ​

$ workato help <COMMAND>

入力 ​

出力 ​

指定されたSDK gemコマンドの詳細なヘルプ。

例 ​

$ workato help edit
Usage:
  workato edit PATH

Options:
  -k, [--key=KEY]                  # Path to file with encrypt/decrypt key. NOTE: key from WORKATO_CONNECTOR_MASTER_KEY has higher priority
      [--verbose], [--no-verbose]

Edit encrypted file, e.g. settings.yaml.enc

workato new ​

選択したディレクトリに新しいコネクタプロジェクトを作成します。

新しいコネクタプロジェクトを作成すると、HTTP mocking動作としてsecureまたはsimpleのどちらを選択するかを尋ねられます。

Please select default HTTP mocking behavior suitable for your project?

1 - secure. 不明なリクエストに対してエラーを発生させ、すべてのリクエスト記録を暗号化します。
            新しいcassetteを記録するには、VCR_RECORD_MODE Environment変数を設定する必要があります

            Example: VCR_RECORD_MODE=once bundle exec rspec spec/actions/test_action_spec.rb

2 - simple. 新しいリクエストの場合は新しいinteractionを記録します。リクエストはプレーンテキストとして保存され、secret tokensが公開されます。

利用状況 ​

$ workato new <PATH>

入力 ​

結果 ​

新しいコネクタプロジェクトを生成します。

例 ​

$ workato new ~/Desktop/my-new-connector

workato oauth2 ​

該当するコネクタにOAuth2 Authorization code grant flowを実装するために使用します。 該当するコネクタは、connection hashに`type: 'oauth2`があるものです。 詳細については、この便利なOkta記事を確認してください。

利用状況 ​

$ workato oauth2 <OPTIONS>

オプション ​

結果 ​

WorkatoでOAuth2 Authorization Code Grant Flowをエミュレートします。 該当するコネクタは、connection hashに`type: 'oauth2`があるものです。 詳細については、この便利なOkta記事を確認してください。

例 ​

$ workato oauth2

workato push ​

選択したWorkatoフォルダに新しいコネクタプロジェクトを作成します。

利用状況 ​

$ workato push --api-token <API-TOKEN> <OPTIONS>

オプション ​

例 ​

workato push --api-token