ServiceNow SDK CLI

ServiceNow SDK コマンドラインインターフェイス (CLI) を使用して、ローカルアプリケーションとインスタンス上のアプリケーション間の変更を管理します。

システムのコマンドラインツールから、「 now-sdk 」と入力して CLI を起動し、使用可能なコマンドのリストを返すか、 now-sdk [command] を選択して SDK の使用 ServiceNow を開始します。

CLI には、次のコマンドとグローバル オプションが含まれています。

表 : 1. グローバルオプション

オプション	説明
--バージョン	CLI のバージョンを返します。
--help, -h	コマンド、サブコマンド、およびパラメーターに関する情報を戻します。

認証

インスタンスを使用して認証し、システム上のインスタンスにアクセスするためのユーザー資格情報を格納、更新、または表示します。

auth コマンドには、保管、消去、表示、およびデフォルト設定サブコマンドと、次の構造があります。

now-sdk auth [<subcommand>]

保存

システムのデバイス キーチェーンまたは認証情報マネージャーに認証情報を保存します。プロンプトで、インスタンスを認証するためのパスワードを入力します。

now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]

表 : 2. 必要なパラメーター

パラメーター	タイプ	説明	デフォルト値
エイリアス	文字列	ホストおよびユーザーの資格情報の一意の識別子。 エイリアスは、 作成、 変換、 フェッチ、および 展開 コマンドによる認証に使用できます。	—
--ホスト	文字列	アクセスするターゲットインスタンス、およびアプリケーションを展開およびフェッチするターゲットインスタンス。インスタンスはリリースである必要があります Washington DC 。	—
--名	文字列	インスタンスを認証するためのユーザー名。ユーザーには管理者アクセス権が必要です。	—

表 : 3. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
--default, -d	ブール	エイリアスをデフォルトの エイリアス として設定するオプション。	false

例：

now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default

クリア

システムのデバイスキーチェーンまたは資格情報マネージャーで資格情報を削除します。

now-sdk auth clear [<alias>]

表 : 4. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
エイリアス	文字列	ホストおよびユーザーの資格情報の一意の識別子。	すべて

例：

now-sdk auth clear devuser1

リスト

システムのデバイス キーチェーンまたは認証情報マネージャーに保存されている認証情報を表示します。パスワードは返されません。

now-sdk auth list [<alias>]

表 : 5. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
エイリアス	文字列	ホストおよびユーザーの資格情報の一意の識別子。	すべて

例：

now-sdk auth list devuser1

set-default

デフォルトでコマンドで使用される資格情報を設定します。

now-sdk auth set-default [<alias>]

表 : 6. 必要なパラメーター

パラメーター	タイプ	説明	デフォルト値
エイリアス	文字列	ホストおよびユーザーの資格情報の一意の識別子。	—

例：

now-sdk auth set-default devuser1

作成

カスタムスコープ対象のアプリケーションを作成し、指定されている場合はインスタンスに展開します。

create コマンドの構造は次のとおりです。

now-sdk create <projectName> <scopeName> [<directory>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--open-browser <flag>] [--interactive <flag>]

表 : 7. 必要なパラメーター

パラメーター	タイプ	説明	デフォルト値
projectName	文字列	アプリケーションの名前。 アプリケーション名は、NPM パッケージの名前付け規則に従う必要があります。	—
scopeName	文字列	アプリケーションのスコープ。 スコープ名はインスタンス上で一意で、x_<prefix> で始まり、18 文字未満である必要があります。詳細については、「Namespace identifier」を参照してください。	—

表 : 8. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
ディレクトリ	文字列	アプリケーションのディレクトリとファイルを作成するローカルディレクトリ。	現在の作業ディレクトリ
--説明	文字列	アプリケーションの簡単な説明。	—
--sampleTable	ブール	アプリケーションでサンプルテーブルを作成するためのオプション。 true の場合、サンプルテーブル (<scope>_to_do.xml) が .metadata ディレクトリに作成されます。	false
--offline, -o	ブール	インスタンスへのアプリケーションの展開をスキップするためのオプション。 true の場合、スコープ名は作成中に検証されないため、インスタンスに展開する前にスコープ名が有効であることを確認する必要があります。 注: auth パラメーターが設定されている場合、このパラメーターは無視されます。	false
--auth、-a	文字列	インスタンスへの認証に使用する資格情報のエイリアス。	設定されている場合は、デフォルトのエイリアス。
--open-browser, -b	ブール	アプリケーションを正常に展開した後に、デフォルトのブラウザーでアプリケーションレコード (sys_app) を開くオプション。 注: オフライン パラメーターが true に設定されている場合、このパラメーターは無視されます。	false
--インタラクティブ、-i	ブール	アプリケーションを作成するためのプロンプトのガイド付きセットに回答するオプション。	false

例：

now-sdk create example-app x_snc_example /path/to/app_folder --description example_app_description --sampleTable true --auth devuser1 --open-browser true

convert

インスタンスから既存のアプリケーションを変換して、SDK を使用してServiceNowインスタンスでのVisual Studio Codeローカルの変更およびインスタンスへのアプリケーション変更の展開をサポートします。

convert コマンドの構造は次のとおりです。

now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--scopeId <app_scope_id>]

表 : 9. 必要なパラメーター

パラメーター	タイプ	説明	デフォルト値
scopeName	文字列	既存のアプリケーションのスコープ。 グローバルアプリケーションの場合は、アプリケーション名を使用します。	—
パッケージ名	文字列	package.json ファイルで使用されるアプリケーション パッケージの名前。 パッケージ名は、NPM パッケージの命名規則に準拠している必要があります。	—

表 : 10. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
ディレクトリ	文字列	アプリケーションのディレクトリとファイルを作成するローカルディレクトリ。	現在の作業ディレクトリ
--auth、-a	文字列	インスタンスへの認証に使用する資格情報のエイリアス。	設定されている場合は、デフォルトのエイリアス。
--scopeId	文字列	既存のアプリケーションのsys_id。 注: このパラメーターは、グローバルアプリケーションを変換するために必要です。	—

例：

now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --scopeId example_app_scope_id

フェッチ

インスタンスからアプリケーションメタデータをダウンロードし、それに合わせてローカルアプリケーションのメタデータ XML ファイルを更新します。

fetch コマンドの構造は次のとおりです。

now-sdk fetch [--directory <package path>] [--mode <fetch mode>] [--auth <alias>]

表 : 11. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
--ディレクトリ	文字列	アプリケーションへのパス。	現在の作業ディレクトリ
--mode, -m	文字列	メタデータをフェッチするオプション。 complete:アプリケーションのすべてのメタデータをフェッチします。 増分:前回のフェッチ以降にアプリケーションメタデータに加えられた変更のみをフェッチします。	増分
--auth、-a	文字列	インスタンスへの認証に使用する資格情報のエイリアス。	設定されている場合は、デフォルトのエイリアス。

例：

now-sdk fetch --auth devuser1 --directory /path/to/package --mode incremental

構築

ソース ファイルをコンパイルし、配置可能なパッケージを生成します。サードパーティライブラリの依存関係は、アプリケーションとともにインストールできる XML ファイルに変換されます。

build コマンドの構造は次のとおりです。

now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]

表 : 12. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
ソース	文字列	アプリケーションの package.json ファイルへのパス。 package.jsonは、アプリケーションのベースディレクトリにある必要があります。	現在の作業ディレクトリ
--debug, -d	ブール	ビルドプロセス中に生成されたデバッグログを返すオプション。	false
--generate-deletes	ブール	ビルド間で削除されたファイルの削除レコードの更新を生成するオプション。	true
--糸くず	ブール	ビルド前にソースファイルをリントするオプション。	true
--optimize, -o	ブール	変更されていない依存関係 XML ファイルを再利用してパッケージ化を最適化するオプション。	true

例：

now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

deploy

アプリケーションをインスタンスに展開します。deploy コマンドを使用する前に、build コマンドを使用して配置可能パッケージを生成する必要があります。

deploy コマンドの構造は次のとおりです。

now-sdk deploy [--source <package path>] [--mode <deploy mode>] [--auth <alias>] [--open-browser <flag>]

表 : 13. オプションのパラメーター

パラメーター	タイプ	説明	デフォルト値
--ソース	文字列	アプリケーションの package.json ファイルへのパス。 package.jsonは、アプリケーションのベースディレクトリにある必要があります。	現在の作業ディレクトリ
--mode, -m	文字列	アプリケーションの展開方法のオプション。 complete: アプリケーション全体をデプロイします。 再インストール:インスタンスのアプリケーションをアンインストールしてから再インストールし、インスタンスのメタデータがデプロイパッケージのメタデータと一致することを確認します。 警告: インスタンスにはあるがローカルアプリケーションにはないメタデータは削除されます。 増分: 最後のデプロイ以降のアプリケーション メタデータへの変更のみをデプロイします。	増分
--auth、-a	文字列	インスタンスへの認証に使用する資格情報のエイリアス。	設定されている場合は、デフォルトのエイリアス。
--オープンブラウザ、b	ブール	アプリケーションを正常に展開した後に、デフォルトのブラウザーでアプリケーションレコード (sys_app) を開くオプション。	false
--info, -i	ブール	更新されたステータスやレコードなど、このアプリケーションの最新の展開に関する詳細を返すオプション。このパラメーターを使用すると、アプリケーションはデプロイされません。	false

例：

now-sdk deploy --auth devuser1 --source /path/to/package --mode incremental --open-browser true