Notebook Commands

Manage notebooks using the CLI

Notebook Commands

Manage notebooks for executing Python code and automation tasks.

Usage

weikio notebooks [NotebookId] [command] [options]

Arguments:

NameRequiredDescription
NotebookIdNoID of the notebook (required for some operations)

Subcommands

ls

List all notebooks.

Usage:

weikio notebooks ls

Example:

weikio notebooks ls

run

Run a notebook.

Usage:

weikio notebooks run <NotebookId>

Arguments:

NameRequiredDescription
NotebookIdYesID of the notebook to run

Example:

weikio notebooks run my-notebook

schedule

Manage notebook schedules.

Usage:

weikio notebooks <NotebookId> schedule [command]

schedule add

Add a schedule to a notebook.

Usage:

weikio notebooks <NotebookId> schedule add <CronExpression>

Arguments:

NameRequiredDescription
NotebookIdYesID of the notebook
CronExpressionYesCron expression for the schedule

Example:

weikio notebooks my-notebook schedule add "0 0 * * *"

schedule delete

Delete a notebook schedule.

Usage:

weikio notebooks <NotebookId> schedule delete <ScheduleId>

Arguments:

NameRequiredDescription
NotebookIdYesID of the notebook
ScheduleIdYesID of the schedule to delete

Example:

weikio notebooks my-notebook schedule delete schedule-123

endpoint

Manage notebook endpoints.

Usage:

weikio notebooks <NotebookId> endpoint [command]

endpoint add

Add an endpoint to a notebook.

Usage:

weikio notebooks <NotebookId> endpoint add <EndpointPath>

Arguments:

NameRequiredDescription
NotebookIdYesID of the notebook
EndpointPathYesPath for the endpoint

Example:

weikio notebooks my-notebook endpoint add /api/my-notebook

endpoint delete

Delete a notebook endpoint.

Usage:

weikio notebooks <NotebookId> endpoint delete <EndpointId>

Arguments:

NameRequiredDescription
NotebookIdYesID of the notebook
EndpointIdYesID of the endpoint to delete

Example:

weikio notebooks my-notebook endpoint delete endpoint-123