code-package create

Create a code package in the specified project or space.

Syntax

cpd-cli code-package create \
--name=<code-package-name> \
--profile=<cpd-profile-name> \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--description=<description>] \
[--file-reference=<file-reference>] \
[--jmes-query=<jmespath-query>] \
[--json-file-reference=<json-file-reference> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--project-id=<project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The code-package create command has no arguments.

Options

Table 1: Command options
Option Description
--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 IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.
--cpd-scope The IBM Software Hub 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 IBM Software Hub space, project, or catalog scope.
--description Specify a code package description.
Status
Optional.
Syntax
--description=<description>
Default value
No default.
Valid values
A valid code package description.
--file-reference Specify the reference to the file in the object storage.
Status
Optional.
Syntax
--file-reference=<file-reference>
Default value
No default.
Valid values
A valid reference to a file in the object storage.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--json-file-reference Provide the reference to the metadata (JSON file) in the object storage.
Status
Optional.
Syntax
--json-file-reference=<json-file-reference>
Default value
No default.
Valid values
A valid *.json file name.
--name Specify the code
 package name.
Status
Required.
Syntax
--name=<code-package-name>
Default value
No default.
Valid values
A valid code package name.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--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-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify an IBM Software Hub project instance.
Status
Optional.
Syntax
--project-id=<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 are not surrounded by quotation marks in
 JSON output mode.
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.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

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 installation variables script. For more information, see Setting up installation environment variables.
Specify the environment variables in a script file.
CODE_PACKAGE_NAME=<The name of the code package in the deployment space>
CODE_PACKAGE_DESCRIPTION=<A description of the code package in the deployment space>
FILE_NAME=<The *.zip file name in the storage that is associated with the deployment space>
PROFILE=<The Cloud Pak for Data configuration profile name>
SPACE_ID=<The deployment space ID>
Create a code package in the deployment space.
cpd-cli asset file upload \
--description ${CODE_PACKAGE_DESCRIPTION} \
--file-reference code_package/${FILE_NAME} \
--profile ${PROFILE} \
--name ${CODE_PACKAGE_NAME} \
--space-id ${SPACE_ID}
The specified *.zip file is added as a code package asset on the Assets page in your deployment space.