ServiceNow SDK CLI

ServiceNow SDK 명령줄 인터페이스(CLI)를 사용하여 로컬 애플리케이션과 인스턴스의 애플리케이션 간 변경 사항을 관리합니다.

시스템의 명령줄 도구에서 now-sdk 를 입력하여 CLI를 시작하고 사용 가능한 명령 목록을 반환하거나 now-sdk [command] 를 입력하여 SDK 사용을 ServiceNow 시작합니다.

CLI에는 다음 명령과 전역 옵션이 포함되어 있습니다.

표 1. 전역 옵션

옵션	설명
--버전	CLI의 버전을 반환합니다.
--도움, -h	명령, 하위 명령 및 매개변수에 대한 정보를 반환합니다.

인증

인스턴스를 인증하고 시스템의 인스턴스에 액세스하기 위한 사용자 자격 증명을 저장, 업데이트 또는 확인합니다.

auth 명령에는 save, clear, view 및 set-default 하위 명령과 다음 구조가 있습니다.

now-sdk auth [<subcommand>]

저장

시스템의 장치 키체인 또는 자격 증명 관리자에 자격 증명을 저장합니다. 프롬프트에서 인스턴스를 인증하기 위한 암호를 입력합니다.

save 부속 명령의 구조는 다음과 같습니다.

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

표 2. 필수 매개변수

매개변수	유형	설명	기본값
별칭	문자열	호스트 및 사용자 자격 증명에 대한 고유 식별자입니다. 별명은 create, convert, fetch 및 deploy 명령을 사용한 인증에 사용할 수 있습니다.	—
--호스트	문자열	액세스할 대상 인스턴스이며 애플리케이션을 배포하고 가져올 대상 인스턴스입니다. 인스턴스는 릴리스에 Washington DC 있어야 합니다.	—
--사용자	문자열	인스턴스에 인증할 사용자 이름입니다. 사용자에게 관리자 액세스 권한이 있어야 합니다.	—

표 3. 선택적 매개변수

매개변수	유형	설명	기본값
--기본값, -d	부울	별칭을 기본 별칭으로 설정하는 옵션입니다.	false

예:

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

지우기

시스템의 장치 키체인 또는 자격 증명 관리자에서 자격 증명을 제거합니다.

clear 부속 명령의 구조는 다음과 같습니다.

now-sdk auth clear [<alias>]

표 4. 선택적 매개변수

매개변수	유형	설명	기본값
별칭	문자열	호스트 및 사용자 자격 증명에 대한 고유 식별자입니다.	모두

예:

now-sdk auth clear devuser1

list

시스템의 장치 키체인 또는 자격 증명 관리자에 저장된 자격 증명을 봅니다. 암호는 반환되지 않습니다.

list 부속 명령의 구조는 다음과 같습니다.

now-sdk auth list [<alias>]

표 5. 선택적 매개변수

매개변수	유형	설명	기본값
별칭	문자열	호스트 및 사용자 자격 증명에 대한 고유 식별자입니다.	모두

예:

now-sdk auth list devuser1

set-default (기본값 설정)

기본적으로 명령에서 사용할 자격 증명을 설정합니다.

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 패키지 명명 규칙을 준수해야 합니다.	—
범위 이름	문자열	애플리케이션의 범위입니다. 범위 이름은 인스턴스에서 고유해야 하고, x_<prefix>로 시작해야 하며 18자 미만이어야 합니다. 자세한 내용은 네임스페이스 식별자 문서를 참조하십시오.	—

표 8. 선택적 매개변수

매개변수	유형	설명	기본값
디렉터리	문자열	애플리케이션 디렉터리와 파일을 만들 로컬 디렉터리입니다.	현재 작업 디렉터리
--설명	문자열	애플리케이션에 대한 간단한 설명입니다.	—
--샘플 테이블	부울	애플리케이션에서 샘플 테이블을 생성하는 옵션입니다. true이면 샘플 테이블(<scope>_to_do.xml)이 .metadata 디렉터리에 만들어집니다.	false
--오프라인, -o	부울	인스턴스에 애플리케이션 배포를 건너뛰는 옵션입니다. true인 경우 생성 중에 범위 이름의 유효성이 검사되지 않으므로 인스턴스에 배포하기 전에 범위 이름이 유효한지 확인해야 합니다. 주: 이 매개변수는 auth 매개변수가 설정되면 무시됩니다.	false
--인증, -a	문자열	인스턴스를 인증하는 데 사용할 자격 증명의 별칭입니다.	설정된 경우 기본 별칭입니다.
--오픈 브라우저, -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

변환

인스턴스에서 기존 애플리케이션을 변환하여 로컬에서 시각적 스튜디오 코드 수정하고 SDK를 사용하여 인스턴스에 애플리케이션 변경 내용을 배포할 수 있도록 ServiceNow 지원합니다.

응용 프로그램을 변환하면 응용 프로그램의 메타데이터 XML 파일이 다운로드되고 SDK를 로컬로 사용하는 데 필요한 파일 및 디렉터리가 추가됩니다. 인스턴스에서 애플리케이션이 변경되지 않았습니다. 자세한 내용은 SDK 항목의 애플리케이션 구조ServiceNow 섹션을 참조하세요.

convert 명령의 구조는 다음과 같습니다.

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

표 9. 필수 매개변수

매개변수	유형	설명	기본값
범위 이름	문자열	기존 애플리케이션의 범위입니다. 전역 애플리케이션의 경우 애플리케이션 이름을 사용합니다.	—
패키지 이름	문자열	package.json 파일에 사용되는 애플리케이션 패키지의 이름입니다. 패키지 이름은 NPM 패키지 명명 규칙을 준수해야 합니다.	—

표 10. 선택적 매개변수

매개변수	유형	설명	기본값
디렉터리	문자열	애플리케이션 디렉터리와 파일을 만들 로컬 디렉터리입니다.	현재 작업 디렉터리
--인증, -a	문자열	인스턴스를 인증하는 데 사용할 자격 증명의 별칭입니다.	설정된 경우 기본 별칭입니다.
--범위 ID	문자열	기존 애플리케이션의 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. 선택적 매개변수

매개변수	유형	설명	기본값
--디렉터리	문자열	애플리케이션의 경로입니다.	현재 작업 디렉터리
--모드, -m	문자열	가져올 메타데이터에 대한 옵션입니다. complete: 애플리케이션의 모든 메타데이터를 가져옵니다. incremental: 마지막 가져오기 이후 애플리케이션 메타데이터에 대한 변경 내용만 가져옵니다.	증분
--인증, -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. 선택적 매개변수

매개변수	유형	설명	기본값
source	문자열	응용 프로그램의 package.json 파일 경로입니다. package.json은 응용 프로그램의 기본 디렉터리에 있어야 합니다.	현재 작업 디렉터리
--디버그, -d	부울	빌드 프로세스 중에 생성된 디버그 로그를 반환하는 옵션입니다.	false
--생성 삭제	부울	빌드 간에 제거된 파일에 대한 삭제 기록 업데이트를 생성하는 옵션입니다.	true
--보풀	부울	빌드하기 전에 소스 파일을 린트하는 옵션입니다.	true
--최적화, -o	부울	변경되지 않은 종속성 XML 파일을 다시 사용하여 패키징을 최적화하는 옵션입니다.	true

예:

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

배포

인스턴스에 응용 프로그램을 배포합니다. deploy 명령을 사용하기 전에 build 명령을 사용하여 배포 가능한 패키지를 생성해야 합니다.

deploy 명령의 구조는 다음과 같습니다.

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

표 13. 선택적 매개변수

매개변수	유형	설명	기본값
--소스	문자열	응용 프로그램의 package.json 파일 경로입니다. package.json은 응용 프로그램의 기본 디렉터리에 있어야 합니다.	현재 작업 디렉터리
--모드, -m	문자열	응용 프로그램을 배포하는 방법에 대한 옵션입니다. 완료: 전체 애플리케이션을 배포합니다. reinstall: 인스턴스에서 애플리케이션을 제거한 후 다시 설치하여 인스턴스의 메타데이터가 배포 패키지의 메타데이터와 일치하는지 확인합니다. 경고: 인스턴스에 있지만 로컬 애플리케이션에 없는 메타데이터는 제거됩니다. incremental: 마지막 배포 이후 응용 프로그램 메타데이터에 대한 변경 내용만 배포합니다.	증분
--인증, -a	문자열	인스턴스를 인증하는 데 사용할 자격 증명의 별칭입니다.	설정된 경우 기본 별칭입니다.
--오픈 브라우저, b	부울	애플리케이션을 성공적으로 배포한 후 기본 브라우저에서 애플리케이션 기록(sys_app)을 여는 옵션입니다.	false
--정보, -i	부울	업데이트된 상태 및 기록과 같은 이 애플리케이션의 최근 배포에 대한 상세 정보를 반환하는 옵션입니다. 이 매개 변수를 사용하면 응용 프로그램이 배포되지 않습니다.	false

예:

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