asset script create

Important: IBM Cloud Pak® for Data Version 4.7 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.7 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Create a script asset from a local file.

Syntax

cpd-cli asset script create \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--description=<description>] \
--file=<upload-file-path> \
[--jmes-query=<jmespath-query>] \
[--language=<script-language>] \
[--mime=<mime-type>] \
[--origin-country=<script-asset-country>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--software-specification-id=<software-specification-uuid-v4>] \
[--space-id=<space-identifier>] \
[--tags=<tag1,tag2,...>] \
[--verbose]

Arguments

The asset script create command has no arguments.

Options

Option Description
--catalog-id Specify either a catalog ID,
project ID, or space ID (specify only one).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project or space ID.
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--description Specify a script asset description.
Status
Optional.
Syntax
--description=<description>
Default value
No default.
Valid values
A valid script asset description.
--file Specify the path and name of the file to upload.
Status
Optional.
Syntax
--file=<upload-file-path>
Default value
No default.
Valid values
A valid path and file name.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid Lucene query.
--language Specify a scripting language.
Status
Optional.
Syntax
--language=<script-language>
Default value
python3
Valid values
python3
python3 is set as the scripting language.
r
r is set as the scripting language.
--mime Specify the file content mime
 type.
Status
Optional.
Syntax
--mime=<mime-type>
Default value
Determined by the file content.
Valid values
A valid file content mime type.
--origin-country Specify the script asset
 ISO 3166 origin country code.
Status
Optional.
Syntax
--origin-country=<script-asset-country>
Default value
us
Valid values
A valid ISO 3166 origin country code.
--output Specify an output format. Valid formats include json, yaml, or text (the default format).
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
json|yaml|text
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
A valid project identifier.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values in
 JSON output mode are not surrounded by quotes.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--software-specification-id Specify the UUID v4 that identifies the
 software specification.
Status
Required.
Syntax
--software-specification-id=<software-specification-uuid-v4>
Default value
No default.
Valid values
A valid UUID v4.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--tags Specify the script asset
 tags. Multiple tags can be specified.
Status
Optional.
Syntax
--tags=<tag1,tag2,...>
Default value
No default.
Valid values
A valid list of comma-separated script asset tags.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Table 1: Command options

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the install variables script. For more information, see Best practice: Setting up install variables.
Define the environment variables.
export FILE_PATH=<upload-file-path-and-name>
export PROFILE=<cpd-configuration-profile-name>
export PROJECT_CPD_INST_OPERANDS=os.getenv('PROJECT_ID')
Create a script asset.
cpd-cli asset script create \
--file=${FILE_PATH} \
--profile=${PROFILE} \
--project-id=${PROJECT_CPD_INST_OPERANDS}