`notebook`

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.

Manage Cloud Pak for Data notebooks.

Extended description

You can use the notebook, environment, and job commands to automate the flow.

Create notebooks.
Run notebook jobs.
Move notebooks between projects in Cloud Pak for Data.
Add custom libraries to notebook runtime environments.
Promote notebooks to deployment spaces.

Prerequisites

cpd-cli: Before you run any cpd-cli commands, ensure that you downloaded the cpd-cli 13.0.4 command-line utility for your operating system and Cloud Pak for Data edition. For more information, see Installing the Cloud Pak for Data command-line interface (cpd-cli).
Common core services: The notebook commands are relevant only when common core services are installed.

Required permissions

The notebook command requires cluster administrator or similar roles.

Commands

Table 1. `notebook` commands
Command	Description
`notebook create`	Create a notebook by referencing the notebook content with the required attributes (file-reference, name, project or space, and runtime or compute).
`notebook delete`	Delete a notebook, including the notebook asset.
`notebook revert`	Revert the notebook to a previous version.
`notebook update`	Update a specific notebook.
`notebook version create`	Create a version for a specific notebook.
`notebook version delete`	Delete a specific notebook version.
`notebook version get`	Retrieve a specific notebook version.
`notebook version list`	List all notebook versions.
`notebook version update`	Update a notebook version.