Publish & Unpublish

The CLI’s publish and unpublish commands control the visibility of a sandbox template. Publishing makes a template public to everyone outside your team; unpublishing makes it private to your team again. Under the hood both set the template’s public flag.

Note: By default the command asks for confirmation before changing visibility, warning that publishing makes the template public to everyone outside your team. Pass -y / --yes to skip the prompt.

Prerequisites

Set your API key in the environment:

CLI

export NOVITA_API_KEY=<your API key>

Usage

CLI

# Publish (alias: tpl pb)
novita-sandbox-cli template publish [template]

# Unpublish (alias: tpl upb)
novita-sandbox-cli template unpublish [template]

The [template] argument is optional. There are three ways to choose which template(s) to act on:

Way to select	Behavior
Pass `[template]`	Act on the template with the given template ID
Omit `[template]`	Use the template defined by `novita.toml` in the root directory
`-s` / `--select`	Pick from an interactive list (only shows templates eligible for the action)

Options

Option	Description
`-p, --path <path>`	Change the root directory where the command runs
`--config <novita-toml>`	Path to the sandbox config toml (defaults to `./novita.toml`)
`-s, --select`	Select template(s) from an interactive list
`-t, --team <team-id>`	Team ID the operation is associated with (used with `--select`)
`-y, --yes`	Skip the manual confirmation prompt

Examples

CLI

novita-sandbox-cli template publish <templateID>

CLI

novita-sandbox-cli template publish -y

CLI

novita-sandbox-cli template unpublish --select --team <teamID>

On success, publishing prints the public names the template was published as:

Output

- Publishing sandbox template <template>
  Published as: <name>

Get started

Model APIs

Novita Sandbox

GPUs

Observability

Resources

Prerequisites

Usage

Options

Examples

​Prerequisites

​Usage

​Options

​Examples

Prerequisites

Usage

Options

Examples