From 008c03b834cc7b2aff2c28596a0f92884fa7fe1c Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Tue, 14 May 2024 05:04:55 +0000 Subject: [PATCH 01/10] feat: add markdown docs generator and update generated docs --- .assets/paperspace.md | 4398 +++++++++++++++++ .assets/pspace.json | 9442 ++++++++++++++++++++++++++++--------- .scripts/generate-docs.ts | 42 +- 3 files changed, 11702 insertions(+), 2180 deletions(-) create mode 100644 .assets/paperspace.md diff --git a/.assets/paperspace.md b/.assets/paperspace.md new file mode 100644 index 0000000..08a743d --- /dev/null +++ b/.assets/paperspace.md @@ -0,0 +1,4398 @@ +# Paperspace CLI + +A CLI for using the Paperspace API. + +It allows you to authenticate, launch deployments, do logging, and more. + +* Deploy an ML app with the `deployment` command +* View a deployed app with the `deployment open` command +* Check the status of a deployment with the `deployment status` command + +Read the full documentation at: https://docs.paperspace.com/ + +## pspace + +A CLI for using the Paperspace API. + +It allows you to authenticate, launch deployments, do logging, and more. + +* Deploy an ML app with the `deployment` command +* View a deployed app with the `deployment open` command +* Check the status of a deployment with the `deployment status` command + +Read the full documentation at: https://docs.paperspace.com/ + +### Usage + +``` + pspace [command] + pspace [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [autoscaling-group](#autoscaling-group) +- [completion](#completion) +- [config](#config) +- [console](#console) +- [custom-template](#custom-template) +- [dataset](#dataset) +- [deployment](#deployment) +- [docs](#docs) +- [help](#help) +- [init](#init) +- [login](#login) +- [logout](#logout) +- [machine](#machine) +- [machine-event](#machine-event) +- [model](#model) +- [os-template](#os-template) +- [private-network](#private-network) +- [project](#project) +- [public-ip](#public-ip) +- [secret](#secret) +- [shared-drive](#shared-drive) +- [signup](#signup) +- [snapshot](#snapshot) +- [startup-script](#startup-script) +- [storage-provider](#storage-provider) +- [up](#up) +- [upgrade](#upgrade) +- [version](#version) +## pspace autoscaling-group + +Manage your autoscaling groups. Autoscaling groups enable using +the Kubernetes cluster-autoscaler to automatically scale your cluster. +You can also autoscaling groups as a primitive for your own autoscaler. + +### Usage + +``` + autoscaling-group [command] + autoscaling-group [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +## pspace autoscaling-group create + +Create an autoscaling group. + +### Usage + +``` + autoscaling-group create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace autoscaling-group delete + +Delete an autoscaling group from a team. + +### Usage + +``` + autoscaling-group delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace autoscaling-group get + +Get an autoscaling group from a team. + +### Usage + +``` + autoscaling-group get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace autoscaling-group help + +Show help for a autoscaling-group command + +### Usage + +``` + autoscaling-group help [command] + autoscaling-group help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace autoscaling-group help commands + +List autoscaling-group commands + +Example: +``` +$ autoscaling-group help commands commands +``` + +### Usage + +``` + autoscaling-group help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace autoscaling-group list + +List autoscaling groups in your team. + +Pick a subset of fields to display: +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +### Usage + +``` + autoscaling-group list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace autoscaling-group update + +Update an autoscaling group. + +### Usage + +``` + autoscaling-group update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace completion + +Generate an autocompletion script for pspace in the specified shell. +See each sub-command's help for details on how to use the generated script. + +### Usage + +``` + completion [command] + completion [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [bash](#bash) +- [fish](#fish) +- [help](#help) +- [zsh](#zsh) +## pspace completion bash + +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: +``` +$ source <(completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: +``` +$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` + completion bash [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace completion fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +``` +$ completion fish fish | source +``` + +To load completions for every new session, execute once: +``` +$ completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` + completion fish [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace completion help + +Show help for a completion command + +### Usage + +``` + completion help [command] + completion help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace completion help commands + +List completion commands + +Example: +``` +$ completion help commands commands +``` + +### Usage + +``` + completion help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace completion zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: +``` +$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: +``` +$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` + completion zsh [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace config + +This command manages your Paperspace configuration. You can use it to set, get, and +delete configuration values. Running this command without any subcommands will print +your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: +``` +pspace config set team "my-team" +``` + +### Usage + +``` + config [command] + config [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [set](#set) +## pspace config delete + +Delete a configuration value. + +### Usage + +``` + config delete [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace config get + +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: +``` +pspace config get team +``` + +### Usage + +``` + config get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace config help + +Show help for a config command + +### Usage + +``` + config help [command] + config help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace config help commands + +List config commands + +Example: +``` +$ config help commands commands +``` + +### Usage + +``` + config help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace config set + +Set a configuration value. + +### Usage + +``` + config set [arguments] [arguments...] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace console + +This command opens the Paperspace web console in your browser. + +### Usage + +``` + console [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace custom-template + +Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +### Usage + +``` + custom-template [command] + custom-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +## pspace custom-template create + +Create a custom template from a machine. + +### Usage + +``` + custom-template create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace custom-template delete + +Delete a custom template from a team. + +### Usage + +``` + custom-template delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace custom-template get + +Get a custom template from a team. + +### Usage + +``` + custom-template get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace custom-template help + +Show help for a custom-template command + +### Usage + +``` + custom-template help [command] + custom-template help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace custom-template help commands + +List custom-template commands + +Example: +``` +$ custom-template help commands commands +``` + +### Usage + +``` + custom-template help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace custom-template list + +List custom templates in your team. + +Pick a subset of fields to display: +``` +pspace custom-template list -F name -F dtModified +``` + +### Usage + +``` + custom-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset + +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +### Usage + +``` + dataset [command] + dataset [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +- [versions](#versions) +## pspace dataset create + +Create a dataset. + +### Usage + +``` + dataset create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset delete + +Delete a dataset from a team. + +### Usage + +``` + dataset delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset get + +Get a dataset from a team. + +### Usage + +``` + dataset get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset help + +Show help for a dataset command + +### Usage + +``` + dataset help [command] + dataset help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace dataset help commands + +List dataset commands + +Example: +``` +$ dataset help commands commands +``` + +### Usage + +``` + dataset help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace dataset list + +List datasets in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset list -F name -F dtModified +``` + +### Usage + +``` + dataset list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset update + +Update a dataset in a project or team. + +### Usage + +``` + dataset update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset versions + +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +### Usage + +``` + dataset versions [command] + dataset versions [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +## pspace dataset versions create + +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +### Usage + +``` + dataset versions create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset versions delete + +Delete a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +### Usage + +``` + dataset versions delete [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset versions get + +Get a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +### Usage + +``` + dataset versions get [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset versions help + +Show help for a versions command + +### Usage + +``` + dataset versions help [command] + dataset versions help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace dataset versions help commands + +List versions commands + +Example: +``` +$ dataset versions help commands commands +``` + +### Usage + +``` + dataset versions help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace dataset versions list + +List dataset versions in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset versions list -F name -F dtModified +``` + +### Usage + +``` + dataset versions list [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace dataset versions update + +Update a dataset version in a project or team. + +### Usage + +``` + dataset versions update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace deployment + +Effortlessly deploy ML apps to Paperspace. + +### Usage + +``` + deployment [command] + deployment [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [up](#up) +## pspace deployment delete + +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +### Usage + +``` + deployment delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace deployment get + +Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +### Usage + +``` + deployment get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace deployment help + +Show help for a deployment command + +### Usage + +``` + deployment help [command] + deployment help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace deployment help commands + +List deployment commands + +Example: +``` +$ deployment help commands commands +``` + +### Usage + +``` + deployment help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace deployment list + +List deployments in your team. + +Pick a subset of fields to display: +``` +pspace deployment list -F id -F name +``` + +### Usage + +``` + deployment list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace deployment up + +This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. +``` +$ pspace deployment create --project-id 1234 +``` + +### Usage + +``` + deployment up [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace docs + +This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` + +### Usage + +``` + docs [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace help + +Show help for a pspace command + +### Usage + +``` + help [command] + help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace help commands + +List pspace commands + +Example: +``` +$ help commands commands +``` + +### Usage + +``` + help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace init + +Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +``` +$ pspace init +``` + +Create a new app named "my-app" relative to the current directory. +``` +$ pspace init my-app +``` + +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` +$ pspace init my-app -t Paperspace/gradio-demo +``` + +### Usage + +``` + init [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| template | t | A template to use when creating the app. This can be a URL +to a git repository or a shorthand template name. + +These templates are equivalent: +``` +user/repo +github:user/repo +git@github.com:user/repo +https://github.com/user/repo +``` + +Download from GitLab: +``` +gitlab:user/repo +git@gitlab.com:user/repo +https://gitlab.com/user/repo +``` + +Download from Bitbucket +``` +bitbucket:user/repo +git@bitbucket.org:user/repo +https://bitbucket.org/user/repo +``` + +Specify a tag or branch: +``` +user/repo#dev # branch +user/repo#v1.2.3 # release tag +user/repo#1234abcd # commit hash +``` | true | +| mode | m | The mode to use when creating the app. This can be either "git" or +"tar". If "git" is specified, the template will be downloaded as a +tarball. Note that "git" clones over SSH, so you must have a valid +SSH key configured with GitHub, Bitbucket, or GitLab. | false | +| name | n | The name of the app. Defaults to the first argument current directory name. | false | +| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace login + +Log in to the CLI using your Paperspace API key or by opening the web console. + +### Usage + +``` + login [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace logout + +Log out of the CLI for the current team, a specific team, or all teams. + +### Usage + +``` + logout [arguments...] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| all | a | Log out of all teams. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine + +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` + machine [command] + machine [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [restart](#restart) +- [start](#start) +- [stop](#stop) +- [update](#update) +## pspace machine create + +Create a machine. + +### Usage + +``` + machine create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine delete + +Delete a machine from a team. + +### Usage + +``` + machine delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine get + +Get a machine from a team. + +### Usage + +``` + machine get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine help + +Show help for a machine command + +### Usage + +``` + machine help [command] + machine help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace machine help commands + +List machine commands + +Example: +``` +$ machine help commands commands +``` + +### Usage + +``` + machine help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace machine list + +List machines in your team. + +Pick a subset of fields to display: +``` +pspace machine list -F name -F dtModified +``` + +### Usage + +``` + machine list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine restart + +Restart a machine from a team. + +### Usage + +``` + machine restart [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine start + +Start a machine from a team. + +### Usage + +``` + machine start [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine stop + +Stop a machine from a team. + +### Usage + +``` + machine stop [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine update + +Update a machine's settings. + +### Usage + +``` + machine update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine-event + +Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` + machine-event [command] + machine-event [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [get](#get) +- [help](#help) +- [list](#list) +## pspace machine-event get + +Get a machine event from a team. + +### Usage + +``` + machine-event get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace machine-event help + +Show help for a machine-event command + +### Usage + +``` + machine-event help [command] + machine-event help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace machine-event help commands + +List machine-event commands + +Example: +``` +$ machine-event help commands commands +``` + +### Usage + +``` + machine-event help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace machine-event list + +List machine events in your team. + +Pick a subset of fields to display: +``` +pspace machine-event list -F name -F dtModified +``` + +### Usage + +``` + machine-event list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace model + +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +### Usage + +``` + model [command] + model [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +## pspace model create + +Create a new model. This command will prompt you for a name if you don't +provide one. + +### Usage + +``` + model create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace model delete + +Delete a model from a team. + +### Usage + +``` + model delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace model get + +Get a model from a team. + +### Usage + +``` + model get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace model help + +Show help for a model command + +### Usage + +``` + model help [command] + model help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace model help commands + +List model commands + +Example: +``` +$ model help commands commands +``` + +### Usage + +``` + model help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace model list + +List models in your team. + +Pick a subset of fields to display: +``` +pspace model list -F name -F dtModified +``` + +### Usage + +``` + model list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace os-template + +List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +### Usage + +``` + os-template [command] + os-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [list](#list) +## pspace os-template help + +Show help for a os-template command + +### Usage + +``` + os-template help [command] + os-template help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace os-template help commands + +List os-template commands + +Example: +``` +$ os-template help commands commands +``` + +### Usage + +``` + os-template help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace os-template list + +List OS templates. + +Pick a subset of fields to display: +``` +pspace os-template list -F name +``` + +### Usage + +``` + os-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace private-network + +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. + +### Usage + +``` + private-network [command] + private-network [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +## pspace private-network create + +Create a private network. + +### Usage + +``` + private-network create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace private-network delete + +Delete a private network from a team. + +### Usage + +``` + private-network delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace private-network get + +Get a private network from a team. + +### Usage + +``` + private-network get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace private-network help + +Show help for a private-network command + +### Usage + +``` + private-network help [command] + private-network help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace private-network help commands + +List private-network commands + +Example: +``` +$ private-network help commands commands +``` + +### Usage + +``` + private-network help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace private-network list + +List private networks in your team. + +Pick a subset of fields to display: +``` +pspace private-network list -F name -F dtModified +``` + +### Usage + +``` + private-network list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project + +Manage your Paperspace projects. + +### Usage + +``` + project [command] + project [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [link](#link) +- [list](#list) +- [update](#update) +## pspace project create + +Create a new project. This command will prompt you for a name if you don't +provide one. + +### Usage + +``` + project create [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project delete + +Delete a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +### Usage + +``` + project delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project get + +Get a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +### Usage + +``` + project get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project help + +Show help for a project command + +### Usage + +``` + project help [command] + project help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace project help commands + +List project commands + +Example: +``` +$ project help commands commands +``` + +### Usage + +``` + project help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace project link + +This will link a remote project to a local directory. Commands that +depend on a project ID will use the project ID of the linked project +when communicating with the Paperspace API. + +Link a project to the current directory. +``` +$ pspace link +``` + +Link a project to a different directory. +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. +``` +$ pspace link pzwf2g05ubegj +``` + +### Usage + +``` + project link [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project list + +List projects in your team. + +Pick a subset of fields to display: +``` +pspace project list -F id -F name -F dtCreated +``` + +### Usage + +``` + project list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace project update + +Update an existing project. + +Example: +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +### Usage + +``` + pspace project update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace public-ip + +Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +### Usage + +``` + public-ip [command] + public-ip [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [claim](#claim) +- [help](#help) +- [list](#list) +- [release](#release) +## pspace public-ip assign + +Assign a public IP to a machine. + +### Usage + +``` + public-ip assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace public-ip claim + +Claim a public IP for a team. + +### Usage + +``` + public-ip claim [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace public-ip help + +Show help for a public-ip command + +### Usage + +``` + public-ip help [command] + public-ip help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace public-ip help commands + +List public-ip commands + +Example: +``` +$ public-ip help commands commands +``` + +### Usage + +``` + public-ip help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace public-ip list + +List public IPs in your team or project. + +Pick a subset of fields to display: +``` +pspace public-ip list -F name -F dtModified +``` + +### Usage + +``` + public-ip list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace public-ip release + +Release a public IP from a team. This will unassign it from its assigned machine, if any. + +### Usage + +``` + public-ip release [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace secret + +Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +### Usage + +``` + secret [command] + secret [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +## pspace secret create + +Create a secret in a project or team. + +### Usage + +``` + secret create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace secret delete + +Delete a secret from a project or team. + +### Usage + +``` + secret delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace secret get + +Get a secret from a project or team. + +### Usage + +``` + secret get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace secret help + +Show help for a secret command + +### Usage + +``` + secret help [command] + secret help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace secret help commands + +List secret commands + +Example: +``` +$ secret help commands commands +``` + +### Usage + +``` + secret help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace secret list + +List secrets in your team or project. + +Pick a subset of fields to display: +``` +pspace secret list -F name -F dtModified +``` + +### Usage + +``` + secret list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace secret update + +Update a secret in a project or team. + +### Usage + +``` + secret update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace shared-drive + +Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +### Usage + +``` + shared-drive [command] + shared-drive [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +## pspace shared-drive create + +Create a shared drive. + +### Usage + +``` + shared-drive create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace shared-drive delete + +Delete a shared drive from a team. + +### Usage + +``` + shared-drive delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace shared-drive get + +Get a shared drive from a team. + +### Usage + +``` + shared-drive get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace shared-drive help + +Show help for a shared-drive command + +### Usage + +``` + shared-drive help [command] + shared-drive help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace shared-drive help commands + +List shared-drive commands + +Example: +``` +$ shared-drive help commands commands +``` + +### Usage + +``` + shared-drive help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace shared-drive list + +List shared drives in your team or project. + +Pick a subset of fields to display: +``` +pspace shared-drive list -F name -F dtModified +``` + +### Usage + +``` + shared-drive list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace signup + +This command opens the Paperspace signup page in your browser. + +### Usage + +``` + signup [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace snapshot + +Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +### Usage + +``` + snapshot [command] + snapshot [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [help](#help) +- [list](#list) +- [restore](#restore) +## pspace snapshot create + +Create a snapshot from a machine. + +### Usage + +``` + snapshot create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace snapshot delete + +Delete a snapshot from a team. + +### Usage + +``` + snapshot delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace snapshot help + +Show help for a snapshot command + +### Usage + +``` + snapshot help [command] + snapshot help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace snapshot help commands + +List snapshot commands + +Example: +``` +$ snapshot help commands commands +``` + +### Usage + +``` + snapshot help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace snapshot list + +List snapshots in your team. + +Pick a subset of fields to display: +``` +pspace snapshot list -F name -F dtModified +``` + +### Usage + +``` + snapshot list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace snapshot restore + +Restore a machine to a snapshot. + +### Usage + +``` + snapshot restore [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script + +Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. + +### Usage + +``` + startup-script [command] + startup-script [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [unassign](#unassign) +- [update](#update) +## pspace startup-script assign + +Assign a startup script to a machine. + +### Usage + +``` + startup-script assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script create + +Create a startup script. + +### Usage + +``` + startup-script create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script delete + +Delete a startup script from a team. + +### Usage + +``` + startup-script delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script get + +Get a startup script from a team. + +### Usage + +``` + startup-script get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script help + +Show help for a startup-script command + +### Usage + +``` + startup-script help [command] + startup-script help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace startup-script help commands + +List startup-script commands + +Example: +``` +$ startup-script help commands commands +``` + +### Usage + +``` + startup-script help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace startup-script list + +List startup scripts in your team. + +Pick a subset of fields to display: +``` +pspace startup-script list -F name -F dtCreated +``` + +### Usage + +``` + startup-script list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script unassign + +Unassign a startup script from a machine. + +### Usage + +``` + startup-script unassign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace startup-script update + +Update a startup script. + +### Usage + +``` + startup-script update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace storage-provider + +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +### Usage + +``` + storage-provider [command] + storage-provider [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +## pspace storage-provider create + +Create a storage provider. + +### Usage + +``` + storage-provider create [command] + storage-provider create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +## pspace storage-provider create help + +Show help for a create command + +### Usage + +``` + storage-provider create help [command] + storage-provider create help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace storage-provider create help commands + +List create commands + +Example: +``` +$ storage-provider create help commands commands +``` + +### Usage + +``` + storage-provider create help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace storage-provider create s3 + +Create an S3 storage provider. + +### Usage + +``` + storage-provider create s3 [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace storage-provider delete + +Delete a storage provider from a team. + +### Usage + +``` + storage-provider delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace storage-provider get + +Get a storage provider from a team. + +### Usage + +``` + storage-provider get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace storage-provider help + +Show help for a storage-provider command + +### Usage + +``` + storage-provider help [command] + storage-provider help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace storage-provider help commands + +List storage-provider commands + +Example: +``` +$ storage-provider help commands commands +``` + +### Usage + +``` + storage-provider help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace storage-provider list + +List storage providers in your team or project. + +Pick a subset of fields to display: +``` +pspace storage provider list -F name -F dtModified +``` + +### Usage + +``` + storage-provider list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace storage-provider update + +Update a storage provider. + +### Usage + +``` + storage-provider update [command] + storage-provider update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +## pspace storage-provider update help + +Show help for a update command + +### Usage + +``` + storage-provider update help [command] + storage-provider update help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +## pspace storage-provider update help commands + +List update commands + +Example: +``` +$ storage-provider update help commands commands +``` + +### Usage + +``` + storage-provider update help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +## pspace storage-provider update s3 + +Update an S3 storage provider in a project or team. + +### Usage + +``` + storage-provider update s3 [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace up + +This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` +$ pspace up +``` + +Deploy the app using a config file. +``` +$ pspace up -c paperspace.json +``` + +Deploy an app in a different directory. +``` +$ pspace up --cwd ../my-app +``` + +### Usage + +``` + up [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace upgrade + +This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` +brew upgrade pspace +``` + +If you installed `pspace` using the install script, you can upgrade by +running: +``` +pspace upgrade +``` + +### Usage + +``` + upgrade [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +## pspace version + +Shows version information command, including version number and build date. + +### Usage + +``` + version [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace.json b/.assets/pspace.json index 2b17a68..dbc5068 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2023-06-13T17:23:29.159Z", + "buildDate": "2024-05-14T05:02:13.799Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, @@ -91,7 +91,7 @@ "name": "autoscaling-group", "description": "Manage your autoscaling groups. Autoscaling groups enable using\nthe Kubernetes cluster-autoscaler to automatically scale your cluster.\nYou can also autoscaling groups as a primitive for your own autoscaler.", "summary": "Manage your autoscaling groups", - "usage": " pspace [command]\n pspace [flags]", + "usage": " autoscaling-group [command]\n autoscaling-group [flags]", "flags": [ { "name": "log-level", @@ -169,7 +169,7 @@ "name": "create", "description": "Create an autoscaling group.", "summary": "Create an autoscaling group", - "usage": " pspace autoscaling-group [flags]", + "usage": " autoscaling-group create [flags]", "flags": [ { "name": "fields", @@ -392,7 +392,7 @@ "name": "delete", "description": "Delete an autoscaling group from a team.", "summary": "Delete an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " autoscaling-group delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -504,7 +504,7 @@ "name": "get", "description": "Get an autoscaling group from a team.", "summary": "Get an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " autoscaling-group get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -616,7 +616,7 @@ "name": "help", "description": "Show help for a autoscaling-group command", "summary": "Show help for a autoscaling-group command", - "usage": " pspace autoscaling-group [command]\n pspace autoscaling-group [arguments] [flags]", + "usage": " autoscaling-group help [command]\n autoscaling-group help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -717,9 +717,9 @@ "commands": [ { "name": "commands", - "description": "List autoscaling-group commands\n\nExample:\n```\n$ pspace autoscaling-group help commands\n```", + "description": "List autoscaling-group commands\n\nExample:\n```\n$ autoscaling-group help commands commands\n```", "summary": "List autoscaling-group commands", - "usage": " pspace autoscaling-group help [flags]", + "usage": " autoscaling-group help commands [flags]", "flags": [ { "name": "log-level", @@ -817,7 +817,7 @@ "name": "list", "description": "List autoscaling groups in your team.\n\nPick a subset of fields to display:\n```\npspace autoscaling-group list -F name -F dtCreated\n```", "summary": "List autoscaling groups.", - "usage": " pspace autoscaling-group [flags]", + "usage": " autoscaling-group list [flags]", "flags": [ { "name": "limit", @@ -1013,7 +1013,7 @@ "name": "update", "description": "Update an autoscaling group.", "summary": "Update an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " autoscaling-group update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1269,7 +1269,7 @@ "name": "completion", "description": "Generate an autocompletion script for pspace in the specified shell.\nSee each sub-command's help for details on how to use the generated script.", "summary": "Generate an autocompletion script for the specified shell", - "usage": " pspace [command]\n pspace [flags]", + "usage": " completion [command]\n completion [flags]", "flags": [ { "name": "log-level", @@ -1345,9 +1345,9 @@ "commands": [ { "name": "bash", - "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(pspace completion bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ pspace completion bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(completion bash bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ completion bash bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ completion bash bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the bash shell", - "usage": " pspace completion [flags]", + "usage": " completion bash [flags]", "flags": [ { "name": "log-level", @@ -1424,9 +1424,9 @@ }, { "name": "fish", - "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ pspace completion fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ pspace completion fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ completion fish fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ completion fish fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the fish shell", - "usage": " pspace completion [flags]", + "usage": " completion fish [flags]", "flags": [ { "name": "no-descriptions", @@ -1520,7 +1520,7 @@ "name": "help", "description": "Show help for a completion command", "summary": "Show help for a completion command", - "usage": " pspace completion [command]\n pspace completion [arguments] [flags]", + "usage": " completion help [command]\n completion help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1619,9 +1619,9 @@ "commands": [ { "name": "commands", - "description": "List completion commands\n\nExample:\n```\n$ pspace completion help commands\n```", + "description": "List completion commands\n\nExample:\n```\n$ completion help commands commands\n```", "summary": "List completion commands", - "usage": " pspace completion help [flags]", + "usage": " completion help commands [flags]", "flags": [ { "name": "log-level", @@ -1717,9 +1717,9 @@ }, { "name": "zsh", - "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ pspace completion zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ pspace completion zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ completion zsh zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the zsh shell", - "usage": " pspace completion [flags]", + "usage": " completion zsh [flags]", "flags": [ { "name": "no-descriptions", @@ -1815,7 +1815,7 @@ "name": "config", "description": "This command manages your Paperspace configuration. You can use it to set, get, and \ndelete configuration values. Running this command without any subcommands will print \nyour current configuration.\n\nYour configuration is stored in a TOML file at `~/.paperspace/config.toml`. \n\nFor example, to set the current team, run: \n```\npspace config set team \"my-team\"\n```", "summary": "Manage your local Paperspace configuration.", - "usage": " pspace [command]\n pspace [flags]", + "usage": " config [command]\n config [flags]", "flags": [ { "name": "log-level", @@ -1893,7 +1893,7 @@ "name": "delete", "description": "Delete a configuration value.", "summary": "Delete a configuration value.", - "usage": " pspace config [flags]", + "usage": " config delete [flags]", "arguments": { "description": "", "summary": "The key to delete.", @@ -1994,7 +1994,7 @@ "name": "get", "description": "This command gets a configuration value. You can pass a key to get a specific\nvalue, or you can pass no arguments to get all configuration values.\n\nFor example, to get the current team run:\n```\npspace config get team\n```", "summary": "Get a configuration value.", - "usage": " pspace config [arguments] [flags]", + "usage": " config get [arguments] [flags]", "arguments": { "description": "", "summary": "The key to get.", @@ -2095,7 +2095,7 @@ "name": "help", "description": "Show help for a config command", "summary": "Show help for a config command", - "usage": " pspace config [command]\n pspace config [arguments] [flags]", + "usage": " config help [command]\n config help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2194,9 +2194,9 @@ "commands": [ { "name": "commands", - "description": "List config commands\n\nExample:\n```\n$ pspace config help commands\n```", + "description": "List config commands\n\nExample:\n```\n$ config help commands commands\n```", "summary": "List config commands", - "usage": " pspace config help [flags]", + "usage": " config help commands [flags]", "flags": [ { "name": "log-level", @@ -2294,7 +2294,7 @@ "name": "set", "description": "Set a configuration value.", "summary": "Set a configuration value.", - "usage": " pspace config [arguments] [arguments...] [flags]", + "usage": " config set [arguments] [arguments...] [flags]", "arguments": { "description": "", "summary": "The key/value pair to set.", @@ -2408,7 +2408,7 @@ "name": "console", "description": "This command opens the Paperspace web console in your browser.", "summary": "Open the Paperspace web console.", - "usage": " pspace [flags]", + "usage": " console [flags]", "flags": [ { "name": "log-level", @@ -2484,10 +2484,10 @@ "commands": [] }, { - "name": "deployment", - "description": "Effortlessly deploy ML apps to Paperspace.", - "summary": "Effortlessly deploy ML apps to Paperspace.", - "usage": " pspace [command]\n pspace [flags]", + "name": "custom-template", + "description": "Manage your custom templates. Custom templates are a backup of your\nmachine's disk. They can be used to create additional machines. You\ncan use them to prepopulate a machine with your desired software stack.\n\nFor more information, see https://docs.paperspace.com/compute/custom-templates.", + "summary": "Manage your custom templates", + "usage": " custom-template [command]\n custom-template [flags]", "flags": [ { "name": "log-level", @@ -2561,29 +2561,172 @@ } ], "commands": [ + { + "name": "create", + "description": "Create a custom template from a machine.", + "summary": "Create a custom template", + "usage": " custom-template create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the custom template", + "summary": "The name of the custom template", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-id", + "aliases": [ + "m" + ], + "description": "The ID of the machine to create a custom template from", + "summary": "The ID of the machine to create a custom template from", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, { "name": "delete", - "description": "Delete a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment delete 123e4567-e89b-12d3-a456-426614174000\n```", - "summary": "Delete a deployment.", - "usage": " pspace deployment [arguments] [flags]", + "description": "Delete a custom template from a team.", + "summary": "Delete a custom template", + "usage": " custom-template delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The deployment ID to delete.", + "summary": "The ID of the custom template to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The deployment ID to delete.", + "description": "The ID of the custom template to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } ] }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -2659,21 +2802,21 @@ }, { "name": "get", - "description": "Get a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000\n```\n\nPick a subset of fields to display:\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name\n```", - "summary": "Get a deployment.", - "usage": " pspace deployment [arguments] [flags]", + "description": "Get a custom template from a team.", + "summary": "Get a custom template", + "usage": " custom-template get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The deployment ID to get.", + "summary": "The ID of the custom template to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The deployment ID to get.", + "description": "The ID of the custom template to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -2771,9 +2914,9 @@ }, { "name": "help", - "description": "Show help for a deployment command", - "summary": "Show help for a deployment command", - "usage": " pspace deployment [command]\n pspace deployment [arguments] [flags]", + "description": "Show help for a custom-template command", + "summary": "Show help for a custom-template command", + "usage": " custom-template help [command]\n custom-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2786,10 +2929,10 @@ "schema": { "type": "string", "enum": [ + "create", "get", "list", "delete", - "up", "help" ], "description": "The command to show help for.", @@ -2873,9 +3016,9 @@ "commands": [ { "name": "commands", - "description": "List deployment commands\n\nExample:\n```\n$ pspace deployment help commands\n```", - "summary": "List deployment commands", - "usage": " pspace deployment help [flags]", + "description": "List custom-template commands\n\nExample:\n```\n$ custom-template help commands commands\n```", + "summary": "List custom-template commands", + "usage": " custom-template help commands [flags]", "flags": [ { "name": "log-level", @@ -2971,9 +3114,9 @@ }, { "name": "list", - "description": "List deployments in your team.\n\nPick a subset of fields to display:\n```\npspace deployment list -F id -F name\n```", - "summary": "List deployments.", - "usage": " pspace deployment [flags]", + "description": "List custom templates in your team.\n\nPick a subset of fields to display:\n```\npspace custom-template list -F name -F dtModified\n```", + "summary": "List custom templates.", + "usage": " custom-template list [flags]", "flags": [ { "name": "limit", @@ -3064,6 +3207,38 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "machine-id", + "aliases": [ + "m" + ], + "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", + "summary": "The ID of the machine the event is for", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3136,52 +3311,146 @@ } ], "commands": [] + } + ] + }, + { + "name": "dataset", + "description": "Manage your datasets.\n\nFor more information, see https://docs.paperspace.com/storage/datasets.", + "summary": "Manage your datasets", + "usage": " dataset [command]\n dataset [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "up", - "description": "This will create a new deployment for your app or update it if it already exists. \nYou can optionally specify a path to a config file. If no config file is specified, \nthe default config file paths will be tried.\n\nCreate a new deployment for the app in the current directory.\n```\n$ pspace deployment create\n```\n\nCreate a new deployment using a config file.\n```\n$ pspace deployment create -c paperspace.json\n```\n\nCreate a new deployment for an app in a different directory.\n```\n$ pspace deployment create --cwd ../my-app\n```\n\nCreate a new deployment for an app in a specific project.\n```\n$ pspace deployment create --project-id 1234\n```", - "summary": "Create or update a deployment", - "usage": " pspace deployment [flags]", - "flags": [ - { - "name": "config", - "aliases": [ - "c" - ], - "description": "The path to the config file. Defaults to our default config file paths.\n\nThe default config file paths are in order of precedence:\n\n- `paperspace.yaml`\n- `paperspace.yml`\n- `paperspace.json`\n- `paperspace.jsonc`\n- `paperspace.toml`\n- `.paperspace/app.yaml`\n- `.paperspace/app.yml`\n- `.paperspace/app.json`\n- `.paperspace/app.jsonc`\n- `.paperspace/app.toml`", - "summary": "The path to the config file. Defaults to our default config file paths.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "project-id", - "aliases": [ - "p" - ], - "description": "The ID of the project to deploy to.", - "summary": "The ID of the project to deploy to.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "cwd", - "aliases": [], - "description": "The directory to deploy the app from. Defaults to the current directory.", - "summary": "The directory to deploy the app from. Defaults to the current directory.", - "required": false, - "collects": false, + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a dataset.", + "summary": "Create a dataset", + "usage": " dataset create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the dataset", + "summary": "The name of the dataset", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [], + "description": "The description of the dataset", + "summary": "The description of the dataset", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "storage-provider-id", + "aliases": [], + "description": "The ID of the storage provider to use for the dataset", + "summary": "The ID of the storage provider to use for the dataset", + "required": false, + "collects": false, "negatable": false, "global": false, "schema": { @@ -3189,6 +3458,20 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "is-public", + "aliases": [], + "description": "Whether the dataset is public", + "summary": "Whether the dataset is public", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3261,236 +3544,158 @@ } ], "commands": [] - } - ] - }, - { - "name": "docs", - "description": "This command opens the Paperspace documentation in your browser.\nYou can optionally pass an argument that will take you to a specific \ndocs page.\n\nValid pages are:\n - `d`, `deployment`", - "summary": "Open Paperspace documention in your default browser.", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The page to open", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "d", - "deployment" + }, + { + "name": "delete", + "description": "Delete a dataset from a team.", + "summary": "Delete a dataset", + "usage": " dataset delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" ], - "description": "The page to open", - "$schema": "http://json-schema.org/draft-07/schema#" + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "help", - "description": "Show help for a pspace command", - "summary": "Show help for a pspace command", - "usage": " pspace [command]\n pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The command to show help for.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "autoscaling-group", - "config", - "console", - "deployment", - "docs", - "init", - "login", - "logout", - "machine", - "machine-event", - "private-network", - "project", - "public-ip", - "secret", - "signup", - "snapshot", - "shared-drive", - "startup-script", - "template", - "up", - "upgrade", - "version", - "completion", - "help" - ], - "description": "The command to show help for.", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "commands", - "description": "List pspace commands\n\nExample:\n```\n$ pspace help commands\n```", - "summary": "List pspace commands", - "usage": " pspace help [flags]", + "name": "get", + "description": "Get a dataset from a team.", + "summary": "Get a dataset", + "usage": " dataset get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3560,491 +3765,4384 @@ "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a dataset command", + "summary": "Show help for a dataset command", + "usage": " dataset help [command]\n dataset help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "versions", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { - "name": "all", + "name": "log-level", "aliases": [ - "a" + "l" ], - "description": "Show all commands, including hidden ones", - "summary": "Show all commands, including hidden ones", + "description": "Enable debug logging.", + "summary": "Enable debug logging", "required": false, "collects": false, "negatable": false, - "default": false, - "global": false, + "global": true, "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - } - ] - }, - { - "name": "init", - "description": "Create a new Paperspace app. This will create a new directory with a\ndefault app structure. You can optionally specify a name for the app\nand a template to use. If no template is specified, the default\ntemplate will be used.\n\nCreate a new app in the current directory.\n```\n$ pspace init\n```\n\nCreate a new app named \"my-app\" relative to the current directory.\n```\n$ pspace init my-app\n```\n\nCreate a new app named \"my-app\" relative to the current directory using\na template from the Paperspace GitHub organization.\n```\n$ pspace init my-app -t Paperspace/gradio-demo\n```", - "summary": "Create a new Paperspace app", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "The directory to create the app in. Defaults to the current directory.", - "items": [ - { - "position": 0, - "summary": "", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "template", - "aliases": [ - "t" - ], - "description": "A template to use when creating the app. This can be a URL \nto a git repository or a shorthand template name.\n\nThese templates are equivalent:\n```\nuser/repo\ngithub:user/repo\ngit@github.com:user/repo\nhttps://github.com/user/repo\n```\n\nDownload from GitLab:\n```\ngitlab:user/repo\ngit@gitlab.com:user/repo\nhttps://gitlab.com/user/repo\n```\n\nDownload from Bitbucket\n```\nbitbucket:user/repo\ngit@bitbucket.org:user/repo\nhttps://bitbucket.org/user/repo\n```\n\nSpecify a tag or branch:\n```\nuser/repo#dev # branch\nuser/repo#v1.2.3 # release tag\nuser/repo#1234abcd # commit hash\n```", - "summary": "A template to use when creating the app", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "anyOf": [ - { - "not": {} - }, - { - "type": "string" + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" } - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "mode", - "aliases": [ - "m" - ], - "description": "The mode to use when creating the app. This can be either \"git\" or\n\"tar\". If \"git\" is specified, the template will be downloaded as a\ntarball. Note that \"git\" clones over SSH, so you must have a valid\nSSH key configured with GitHub, Bitbucket, or GitLab.", - "summary": "The mode to use when creating the app: 'git' or 'tar'.", - "required": false, - "collects": false, - "negatable": false, - "default": "tar", - "global": false, - "schema": { - "type": "string", - "enum": [ - "git", - "tar" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the app. Defaults to the first argument current directory name.", - "summary": "The name of the app. Defaults to the first argument current directory name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "clean", - "aliases": [ - "c" + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Clean the Paperspace cache. This negates other args/flags.", - "summary": "Clean the Paperspace cache. This negates other args/flags.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [ + { + "name": "commands", + "description": "List dataset commands\n\nExample:\n```\n$ dataset help commands commands\n```", + "summary": "List dataset commands", + "usage": " dataset help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] }, { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" + "name": "list", + "description": "List datasets in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset list -F name -F dtModified\n```", + "summary": "List datasets.", + "usage": " dataset list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "update", + "description": "Update a dataset in a project or team.", + "summary": "Update a dataset", + "usage": " dataset update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the dataset", + "summary": "The name of the dataset", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [], + "description": "The description of the dataset", + "summary": "The description of the dataset", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "versions", + "description": "Manage your dataset versions.\n\nFor more information, see https://docs.paperspace.com/storage/datasetVersions.", + "summary": "Manage your dataset versions", + "usage": " dataset versions [command]\n dataset versions [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a dataset version. This command will prompt you for an ID if you don't\nprovide one.", + "summary": "Create a dataset version", + "usage": " dataset versions create [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The description of the dataset version.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The description of the dataset version.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "tags", + "aliases": [], + "description": "The tags for the version, comma-delimited", + "summary": "The tags for the version, comma-delimited", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "delete", + "description": "Delete a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", + "summary": "Delete a dataset version", + "usage": " dataset versions delete [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The version of the dataset to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The version of the dataset to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", + "summary": "Get a dataset version", + "usage": " dataset versions get [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The dataset version to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The dataset version to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a versions command", + "summary": "Show help for a versions command", + "usage": " dataset versions help [command]\n dataset versions help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List versions commands\n\nExample:\n```\n$ dataset versions help commands commands\n```", + "summary": "List versions commands", + "usage": " dataset versions help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List dataset versions in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset versions list -F name -F dtModified\n```", + "summary": "List dataset versions.", + "usage": " dataset versions list [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a dataset version in a project or team.", + "summary": "Update a dataset version", + "usage": " dataset versions update [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The version of the dataset to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The version of the dataset to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "message", + "aliases": [ + "m" + ], + "description": "The description of the dataset version", + "summary": "The description of the dataset version", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "tags", + "aliases": [], + "description": "The tags for the version, comma-delimited", + "summary": "The tags for the version, comma-delimited", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + } + ] + }, + { + "name": "deployment", + "description": "Effortlessly deploy ML apps to Paperspace.", + "summary": "Effortlessly deploy ML apps to Paperspace.", + "usage": " deployment [command]\n deployment [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "delete", + "description": "Delete a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment delete 123e4567-e89b-12d3-a456-426614174000\n```", + "summary": "Delete a deployment.", + "usage": " deployment delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The deployment ID to delete.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The deployment ID to delete.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000\n```\n\nPick a subset of fields to display:\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name\n```", + "summary": "Get a deployment.", + "usage": " deployment get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The deployment ID to get.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The deployment ID to get.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a deployment command", + "summary": "Show help for a deployment command", + "usage": " deployment help [command]\n deployment help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "get", + "list", + "delete", + "up", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List deployment commands\n\nExample:\n```\n$ deployment help commands commands\n```", + "summary": "List deployment commands", + "usage": " deployment help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List deployments in your team.\n\nPick a subset of fields to display:\n```\npspace deployment list -F id -F name\n```", + "summary": "List deployments.", + "usage": " deployment list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "up", + "description": "This will create a new deployment for your app or update it if it already exists. \nYou can optionally specify a path to a config file. If no config file is specified, \nthe default config file paths will be tried.\n\nCreate a new deployment for the app in the current directory.\n```\n$ pspace deployment create\n```\n\nCreate a new deployment using a config file.\n```\n$ pspace deployment create -c paperspace.json\n```\n\nCreate a new deployment for an app in a different directory.\n```\n$ pspace deployment create --cwd ../my-app\n```\n\nCreate a new deployment for an app in a specific project.\n```\n$ pspace deployment create --project-id 1234\n```", + "summary": "Create or update a deployment", + "usage": " deployment up [flags]", + "flags": [ + { + "name": "config", + "aliases": [ + "c" + ], + "description": "The path to the config file. Defaults to our default config file paths.\n\nThe default config file paths are in order of precedence:\n\n- `paperspace.yaml`\n- `paperspace.yml`\n- `paperspace.json`\n- `paperspace.jsonc`\n- `paperspace.toml`\n- `.paperspace/app.yaml`\n- `.paperspace/app.yml`\n- `.paperspace/app.json`\n- `.paperspace/app.jsonc`\n- `.paperspace/app.toml`", + "summary": "The path to the config file. Defaults to our default config file paths.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "project-id", + "aliases": [ + "p" + ], + "description": "The ID of the project to deploy to.", + "summary": "The ID of the project to deploy to.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "cwd", + "aliases": [], + "description": "The directory to deploy the app from. Defaults to the current directory.", + "summary": "The directory to deploy the app from. Defaults to the current directory.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "docs", + "description": "This command opens the Paperspace documentation in your browser.\nYou can optionally pass an argument that will take you to a specific \ndocs page.\n\nValid pages are:\n - `d`, `deployment`", + "summary": "Open Paperspace documention in your default browser.", + "usage": " docs [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The page to open", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "d", + "deployment" + ], + "description": "The page to open", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a pspace command", + "summary": "Show help for a pspace command", + "usage": " help [command]\n help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "autoscaling-group", + "config", + "console", + "custom-template", + "dataset", + "deployment", + "docs", + "init", + "login", + "logout", + "machine", + "machine-event", + "os-template", + "private-network", + "project", + "public-ip", + "secret", + "signup", + "snapshot", + "shared-drive", + "startup-script", + "storage-provider", + "up", + "upgrade", + "model", + "version", + "completion", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List pspace commands\n\nExample:\n```\n$ help commands commands\n```", + "summary": "List pspace commands", + "usage": " help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "init", + "description": "Create a new Paperspace app. This will create a new directory with a\ndefault app structure. You can optionally specify a name for the app\nand a template to use. If no template is specified, the default\ntemplate will be used.\n\nCreate a new app in the current directory.\n```\n$ pspace init\n```\n\nCreate a new app named \"my-app\" relative to the current directory.\n```\n$ pspace init my-app\n```\n\nCreate a new app named \"my-app\" relative to the current directory using\na template from the Paperspace GitHub organization.\n```\n$ pspace init my-app -t Paperspace/gradio-demo\n```", + "summary": "Create a new Paperspace app", + "usage": " init [arguments] [flags]", + "arguments": { + "description": "", + "summary": "The directory to create the app in. Defaults to the current directory.", + "items": [ + { + "position": 0, + "summary": "", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "template", + "aliases": [ + "t" + ], + "description": "A template to use when creating the app. This can be a URL \nto a git repository or a shorthand template name.\n\nThese templates are equivalent:\n```\nuser/repo\ngithub:user/repo\ngit@github.com:user/repo\nhttps://github.com/user/repo\n```\n\nDownload from GitLab:\n```\ngitlab:user/repo\ngit@gitlab.com:user/repo\nhttps://gitlab.com/user/repo\n```\n\nDownload from Bitbucket\n```\nbitbucket:user/repo\ngit@bitbucket.org:user/repo\nhttps://bitbucket.org/user/repo\n```\n\nSpecify a tag or branch:\n```\nuser/repo#dev # branch\nuser/repo#v1.2.3 # release tag\nuser/repo#1234abcd # commit hash\n```", + "summary": "A template to use when creating the app", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "anyOf": [ + { + "not": {} + }, + { + "type": "string" + } + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "mode", + "aliases": [ + "m" + ], + "description": "The mode to use when creating the app. This can be either \"git\" or\n\"tar\". If \"git\" is specified, the template will be downloaded as a\ntarball. Note that \"git\" clones over SSH, so you must have a valid\nSSH key configured with GitHub, Bitbucket, or GitLab.", + "summary": "The mode to use when creating the app: 'git' or 'tar'.", + "required": false, + "collects": false, + "negatable": false, + "default": "tar", + "global": false, + "schema": { + "type": "string", + "enum": [ + "git", + "tar" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the app. Defaults to the first argument current directory name.", + "summary": "The name of the app. Defaults to the first argument current directory name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "clean", + "aliases": [ + "c" + ], + "description": "Clean the Paperspace cache. This negates other args/flags.", + "summary": "Clean the Paperspace cache. This negates other args/flags.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "login", + "description": "Log in to the CLI using your Paperspace API key or by opening the web console.", + "summary": "Log in to the CLI.", + "usage": " login [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "An API key to log in with.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "An API key to log in with.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "logout", + "description": "Log out of the CLI for the current team, a specific team, or all teams.", + "summary": "Log out of the CLI.", + "usage": " logout [arguments...] [flags]", + "arguments": { + "description": "", + "summary": "The teams to logout of.", + "items": [ + { + "position": 0, + "summary": "The team to logout of.", + "required": true, + "variadic": true, + "schema": { + "type": "string", + "description": "The team to logout of.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Log out of all teams.", + "summary": "Log out of all teams.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "machine", + "description": "Manage your Paperspace machines.\n\nFor more information, see https://docs.paperspace.com/machines.", + "summary": "Manage your Paperspace machines", + "usage": " machine [command]\n machine [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a machine.", + "summary": "Create a machine", + "usage": " machine create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the machine", + "summary": "The name of the machine", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-type", + "aliases": [], + "description": "The machine type to create", + "summary": "The machine type to create", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "template-id", + "aliases": [], + "description": "The ID of the template to create the machine from", + "summary": "The ID of the template to create the machine from", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "network-id", + "aliases": [], + "description": "The ID of the network to create the machine in", + "summary": "The ID of the network to create the machine in", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region to create the machine in", + "summary": "The region to create the machine in", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "disk-size", + "aliases": [], + "description": "The size of the machine's disk", + "summary": "The size of the machine's disk", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "public-ip-type", + "aliases": [], + "description": "The public IP type.", + "summary": "The public IP type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-enabled", + "aliases": [], + "description": "Whether to enable auto snapshots.", + "summary": "Whether to enable auto snapshots.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-frequency", + "aliases": [], + "description": "The auto snapshot frequency.", + "summary": "The auto snapshot frequency.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-save-count", + "aliases": [], + "description": "The number of auto snapshots to save.", + "summary": "The number of auto snapshots to save.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-enabled", + "aliases": [], + "description": "Whether to enable auto shutdown.", + "summary": "Whether to enable auto shutdown.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-timeout", + "aliases": [], + "description": "The auto shutdown timeout in hours.", + "summary": "The auto shutdown timeout in hours.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-force", + "aliases": [], + "description": "Whether to force shutdown the machine.", + "summary": "Whether to force shutdown the machine.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "take-initial-snapshot", + "aliases": [], + "description": "Whether to take an initial snapshot.", + "summary": "Whether to take an initial snapshot.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "restore-point-enabled", + "aliases": [], + "description": "Whether to use initial snapshot as a restore point.", + "summary": "Whether to use initial snapshot as a restore point.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "restore-point-frequency", + "aliases": [], + "description": "The restore point frequency.", + "summary": "The restore point frequency.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "startup-script-id", + "aliases": [], + "description": "The startup script ID.", + "summary": "The startup script ID.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "email-password", + "aliases": [], + "description": "Whether to email the password.", + "summary": "Whether to email the password.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "start-on-create", + "aliases": [], + "description": "Whether to start the machine on creation.", + "summary": "Whether to start the machine on creation.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "enable-nvlink", + "aliases": [], + "description": "Whether to enable NVLink.", + "summary": "Whether to enable NVLink.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "accessor-ids", + "aliases": [], + "description": "The accessors of the machine.", + "summary": "The accessors of the machine.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "login", - "description": "Log in to the CLI using your Paperspace API key or by opening the web console.", - "summary": "Log in to the CLI.", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "An API key to log in with.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "An API key to log in with.", - "$schema": "http://json-schema.org/draft-07/schema#" + "name": "delete", + "description": "Delete a machine from a team.", + "summary": "Delete a machine", + "usage": " machine delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "json", - "aliases": [ - "j" + "name": "get", + "description": "Get a machine from a team.", + "summary": "Get a machine", + "usage": " machine get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { "name": "help", - "aliases": [ - "h" + "description": "Show help for a machine command", + "summary": "Show help for a machine command", + "usage": " machine help [command]\n machine help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "start", + "stop", + "restart", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "logout", - "description": "Log out of the CLI for the current team, a specific team, or all teams.", - "summary": "Log out of the CLI.", - "usage": " pspace [arguments...] [flags]", - "arguments": { - "description": "", - "summary": "The teams to logout of.", - "items": [ - { - "position": 0, - "summary": "The team to logout of.", - "required": true, - "variadic": true, - "schema": { - "type": "string", - "description": "The team to logout of.", - "$schema": "http://json-schema.org/draft-07/schema#" + "commands": [ + { + "name": "commands", + "description": "List machine commands\n\nExample:\n```\n$ machine help commands commands\n```", + "summary": "List machine commands", + "usage": " machine help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] } - } - ] - }, - "flags": [ - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Log out of all teams.", - "summary": "Log out of all teams.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + ] }, { - "name": "json", - "aliases": [ - "j" + "name": "list", + "description": "List machines in your team.\n\nPick a subset of fields to display:\n```\npspace machine list -F name -F dtModified\n```", + "summary": "List machines.", + "usage": " machine list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "agent-type", + "aliases": [ + "a" + ], + "description": "Filter by agent type.", + "summary": "Filter by agent type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-type", + "aliases": [ + "m" + ], + "description": "Filter by machine type.", + "summary": "Filter by machine type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [ + "r" + ], + "description": "Filter by region.", + "summary": "Filter by region.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "machine", - "description": "Manage your Paperspace machines.\n\nFor more information, see https://docs.paperspace.com/machines.", - "summary": "Manage your Paperspace machines", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" + "name": "restart", + "description": "Restart a machine from a team.", + "summary": "Restart a machine", + "usage": " machine restart [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to restart", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to restart", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "json", - "aliases": [ - "j" + "name": "start", + "description": "Start a machine from a team.", + "summary": "Start a machine", + "usage": " machine start [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to start", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to start", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a machine.", - "summary": "Create a machine", - "usage": " pspace machine [flags]", + "name": "stop", + "description": "Stop a machine from a team.", + "summary": "Stop a machine", + "usage": " machine stop [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to stop", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to stop", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ { "name": "fields", @@ -4063,26 +8161,124 @@ } }, { - "name": "name", + "name": "log-level", "aliases": [ - "n" + "l" ], - "description": "The name of the machine", - "summary": "The name of the machine", - "required": true, + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "machine-type", + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", "aliases": [], - "description": "The machine type to create", - "summary": "The machine type to create", + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a machine's settings.", + "summary": "Update a machine", + "usage": " machine update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the machine", + "summary": "The name of the machine", "required": true, "collects": false, "negatable": false, @@ -4093,10 +8289,10 @@ } }, { - "name": "template-id", + "name": "machine-type", "aliases": [], - "description": "The ID of the template to create the machine from", - "summary": "The ID of the template to create the machine from", + "description": "The machine type to update to", + "summary": "The machine type to update to", "required": true, "collects": false, "negatable": false, @@ -4120,20 +8316,6 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "region", - "aliases": [], - "description": "The region to create the machine in", - "summary": "The region to create the machine in", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "disk-size", "aliases": [], @@ -4246,25 +8428,11 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "take-initial-snapshot", - "aliases": [], - "description": "Whether to take an initial snapshot.", - "summary": "Whether to take an initial snapshot.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "restore-point-enabled", "aliases": [], - "description": "Whether to use initial snapshot as a restore point.", - "summary": "Whether to use initial snapshot as a restore point.", + "description": "Whether to enable a restore point.", + "summary": "Whether to enable a restore point.", "required": false, "collects": false, "negatable": false, @@ -4289,70 +8457,14 @@ } }, { - "name": "startup-script-id", - "aliases": [], - "description": "The startup script ID.", - "summary": "The startup script ID.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "email-password", - "aliases": [], - "description": "Whether to email the password.", - "summary": "Whether to email the password.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "start-on-create", - "aliases": [], - "description": "Whether to start the machine on creation.", - "summary": "Whether to start the machine on creation.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "enable-nvlink", + "name": "restore-point-snapshot-id", "aliases": [], - "description": "Whether to enable NVLink.", - "summary": "Whether to enable NVLink.", + "description": "The ID of the snapshot to use as a restore point.", + "summary": "The ID of the snapshot to use as a restore point.", "required": false, "collects": false, "negatable": false, "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "accessor-ids", - "aliases": [], - "description": "The accessors of the machine.", - "summary": "The accessors of the machine.", - "required": false, - "collects": true, - "negatable": false, - "global": false, "schema": { "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" @@ -4430,136 +8542,104 @@ } ], "commands": [] + } + ] + }, + { + "name": "machine-event", + "description": "Manage your machine events. Events are asynchronous tasks performed by our system on your machines.\nNot all machine commands are asynchronous. For those that are, a machine event will be returned\nwhich can be tracked using this command.\n\nFor more information, see https://docs.paperspace.com/machines.", + "summary": "Manage your machine events", + "usage": " machine-event [command]\n machine-event [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "delete", - "description": "Delete a machine from a team.", - "summary": "Delete a machine", - "usage": " pspace machine [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine to delete", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine to delete", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } + "name": "json", + "aliases": [ + "j" ], - "commands": [] + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ { "name": "get", - "description": "Get a machine from a team.", - "summary": "Get a machine", - "usage": " pspace machine [arguments] [flags]", + "description": "Get a machine event from a team.", + "summary": "Get a machine event", + "usage": " machine-event get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to get", + "summary": "The ID of the machine event to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to get", + "description": "The ID of the machine event to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -4657,9 +8737,9 @@ }, { "name": "help", - "description": "Show help for a machine command", - "summary": "Show help for a machine command", - "usage": " pspace machine [command]\n pspace machine [arguments] [flags]", + "description": "Show help for a machine-event command", + "summary": "Show help for a machine-event command", + "usage": " machine-event help [command]\n machine-event help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4672,14 +8752,8 @@ "schema": { "type": "string", "enum": [ - "create", "get", "list", - "start", - "stop", - "restart", - "delete", - "update", "help" ], "description": "The command to show help for.", @@ -4763,9 +8837,9 @@ "commands": [ { "name": "commands", - "description": "List machine commands\n\nExample:\n```\n$ pspace machine help commands\n```", - "summary": "List machine commands", - "usage": " pspace machine help [flags]", + "description": "List machine-event commands\n\nExample:\n```\n$ machine-event help commands commands\n```", + "summary": "List machine-event commands", + "usage": " machine-event help commands [flags]", "flags": [ { "name": "log-level", @@ -4861,9 +8935,9 @@ }, { "name": "list", - "description": "List machines in your team.\n\nPick a subset of fields to display:\n```\npspace machine list -F name -F dtModified\n```", - "summary": "List machines.", - "usage": " pspace machine [flags]", + "description": "List machine events in your team.\n\nPick a subset of fields to display:\n```\npspace machine-event list -F name -F dtModified\n```", + "summary": "List machine events.", + "usage": " machine-event list [flags]", "flags": [ { "name": "limit", @@ -4955,60 +9029,12 @@ } }, { - "name": "agent-type", - "aliases": [ - "a" - ], - "description": "Filter by agent type.", - "summary": "Filter by agent type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-type", + "name": "machine-id", "aliases": [ "m" ], - "description": "Filter by machine type.", - "summary": "Filter by machine type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "Filter by name.", - "summary": "Filter by name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "region", - "aliases": [ - "r" - ], - "description": "Filter by region.", - "summary": "Filter by region.", + "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", + "summary": "The ID of the machine the event is for", "required": false, "collects": false, "negatable": false, @@ -5090,39 +9116,180 @@ } ], "commands": [] + } + ] + }, + { + "name": "model", + "description": "Manage your Paperspace models.\n\nFor more information, see https://docs.paperspace.com/deploying/models.", + "summary": "Manage your Paperspace models", + "usage": " model [command]\n model [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "restart", - "description": "Restart a machine from a team.", - "summary": "Restart a machine", - "usage": " pspace machine [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine to restart", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine to restart", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a new model. This command will prompt you for a name if you don't\nprovide one.", + "summary": "Create a new model", + "usage": " model create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the model", + "summary": "The name of the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "The description of the model", + "summary": "The description of the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-public", + "aliases": [], + "description": "Whether the model is public", + "summary": "Whether the model is public", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "storage-provider-id", + "aliases": [ + "s" + ], + "description": "The ID of the storage provider to use for the model", + "summary": "The ID of the storage provider to use for the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" } - ] - }, - "flags": [ + }, { - "name": "fields", + "name": "project-id", "aliases": [ - "F" + "p" ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + "description": "The ID of the project to create the model in", + "summary": "The ID of the project to create the model in", "required": false, - "collects": true, + "collects": false, "negatable": false, "global": false, "schema": { @@ -5204,22 +9371,22 @@ "commands": [] }, { - "name": "start", - "description": "Start a machine from a team.", - "summary": "Start a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "delete", + "description": "Delete a model from a team.", + "summary": "Delete a model", + "usage": " model delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to start", + "summary": "The ID of the model to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to start", + "description": "The ID of the model to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -5316,22 +9483,22 @@ "commands": [] }, { - "name": "stop", - "description": "Stop a machine from a team.", - "summary": "Stop a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "get", + "description": "Get a model from a team.", + "summary": "Get a model", + "usage": " model get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to stop", + "summary": "The ID of the model to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to stop", + "description": "The ID of the model to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -5428,242 +9595,35 @@ "commands": [] }, { - "name": "update", - "description": "Update a machine's settings.", - "summary": "Update a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "help", + "description": "Show help for a model command", + "summary": "Show help for a model command", + "usage": " model help [command]\n model help [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to update", + "summary": "The command to show help for.", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to update", + "enum": [ + "create", + "list", + "get", + "delete", + "help" + ], + "description": "The command to show help for.", "$schema": "http://json-schema.org/draft-07/schema#" } } ] }, "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the machine", - "summary": "The name of the machine", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-type", - "aliases": [], - "description": "The machine type to update to", - "summary": "The machine type to update to", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "network-id", - "aliases": [], - "description": "The ID of the network to create the machine in", - "summary": "The ID of the network to create the machine in", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "disk-size", - "aliases": [], - "description": "The size of the machine's disk", - "summary": "The size of the machine's disk", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "public-ip-type", - "aliases": [], - "description": "The public IP type.", - "summary": "The public IP type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-enabled", - "aliases": [], - "description": "Whether to enable auto snapshots.", - "summary": "Whether to enable auto snapshots.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-frequency", - "aliases": [], - "description": "The auto snapshot frequency.", - "summary": "The auto snapshot frequency.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-save-count", - "aliases": [], - "description": "The number of auto snapshots to save.", - "summary": "The number of auto snapshots to save.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-enabled", - "aliases": [], - "description": "Whether to enable auto shutdown.", - "summary": "Whether to enable auto shutdown.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-timeout", - "aliases": [], - "description": "The auto shutdown timeout in hours.", - "summary": "The auto shutdown timeout in hours.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-force", - "aliases": [], - "description": "Whether to force shutdown the machine.", - "summary": "Whether to force shutdown the machine.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-enabled", - "aliases": [], - "description": "Whether to enable a restore point.", - "summary": "Whether to enable a restore point.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-frequency", - "aliases": [], - "description": "The restore point frequency.", - "summary": "The restore point frequency.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-snapshot-id", - "aliases": [], - "description": "The ID of the snapshot to use as a restore point.", - "summary": "The ID of the snapshot to use as a restore point.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -5735,111 +9695,184 @@ } } ], - "commands": [] - } - ] - }, - { - "name": "machine-event", - "description": "Manage your machine events. Events are asynchronous tasks performed by our system on your machines.\nNot all machine commands are asynchronous. For those that are, a machine event will be returned\nwhich can be tracked using this command.\n\nFor more information, see https://docs.paperspace.com/machines.", - "summary": "Manage your machine events", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [ + { + "name": "commands", + "description": "List model commands\n\nExample:\n```\n$ model help commands commands\n```", + "summary": "List model commands", + "usage": " model help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "get", - "description": "Get a machine event from a team.", - "summary": "Get a machine event", - "usage": " pspace machine-event [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine event to get", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine event to get", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "list", + "description": "List models in your team.\n\nPick a subset of fields to display:\n```\npspace model list -F name -F dtModified\n```", + "summary": "List models.", + "usage": " model list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" } - ] - }, - "flags": [ + }, { "name": "fields", "aliases": [ @@ -5928,12 +9961,92 @@ } ], "commands": [] + } + ] + }, + { + "name": "os-template", + "description": "List OS templates. OS templates are pre-configured virtual machines that\nyou can use to create a new machine.\n\nFor more information, see https://docs.paperspace.com/compute/os-templates.", + "summary": "List OS templates", + "usage": " os-template [command]\n os-template [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { "name": "help", - "description": "Show help for a machine-event command", - "summary": "Show help for a machine-event command", - "usage": " pspace machine-event [command]\n pspace machine-event [arguments] [flags]", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "help", + "description": "Show help for a os-template command", + "summary": "Show help for a os-template command", + "usage": " os-template help [command]\n os-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5946,7 +10059,6 @@ "schema": { "type": "string", "enum": [ - "get", "list", "help" ], @@ -6031,9 +10143,9 @@ "commands": [ { "name": "commands", - "description": "List machine-event commands\n\nExample:\n```\n$ pspace machine-event help commands\n```", - "summary": "List machine-event commands", - "usage": " pspace machine-event help [flags]", + "description": "List os-template commands\n\nExample:\n```\n$ os-template help commands commands\n```", + "summary": "List os-template commands", + "usage": " os-template help commands [flags]", "flags": [ { "name": "log-level", @@ -6129,9 +10241,9 @@ }, { "name": "list", - "description": "List machine events in your team.\n\nPick a subset of fields to display:\n```\npspace machine-event list -F name -F dtModified\n```", - "summary": "List machine events.", - "usage": " pspace machine-event [flags]", + "description": "List OS templates.\n\nPick a subset of fields to display:\n```\npspace os-template list -F name\n```", + "summary": "List OS templates.", + "usage": " os-template list [flags]", "flags": [ { "name": "limit", @@ -6223,12 +10335,12 @@ } }, { - "name": "machine-id", + "name": "name", "aliases": [ - "m" + "n" ], - "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", - "summary": "The ID of the machine the event is for", + "description": "Filter by name.", + "summary": "Filter by name.", "required": false, "collects": false, "negatable": false, @@ -6317,7 +10429,7 @@ "name": "private-network", "description": "Manage your private networks. Private networks are logically isolated networks\nfor your machines and shared drives. They can also be used for site-to-site VPNs\nand direct connections to your on-premise network.\n\nFor more information, see https://docs.paperspace.com/networking/private-networks.", "summary": "Manage your private networks", - "usage": " pspace [command]\n pspace [flags]", + "usage": " private-network [command]\n private-network [flags]", "flags": [ { "name": "log-level", @@ -6395,7 +10507,7 @@ "name": "create", "description": "Create a private network.", "summary": "Create a private network", - "usage": " pspace private-network [flags]", + "usage": " private-network create [flags]", "flags": [ { "name": "fields", @@ -6520,7 +10632,7 @@ "name": "delete", "description": "Delete a private network from a team.", "summary": "Delete a private network", - "usage": " pspace private-network [arguments] [flags]", + "usage": " private-network delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6632,7 +10744,7 @@ "name": "get", "description": "Get a private network from a team.", "summary": "Get a private network", - "usage": " pspace private-network [arguments] [flags]", + "usage": " private-network get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6744,7 +10856,7 @@ "name": "help", "description": "Show help for a private-network command", "summary": "Show help for a private-network command", - "usage": " pspace private-network [command]\n pspace private-network [arguments] [flags]", + "usage": " private-network help [command]\n private-network help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6844,9 +10956,9 @@ "commands": [ { "name": "commands", - "description": "List private-network commands\n\nExample:\n```\n$ pspace private-network help commands\n```", + "description": "List private-network commands\n\nExample:\n```\n$ private-network help commands commands\n```", "summary": "List private-network commands", - "usage": " pspace private-network help [flags]", + "usage": " private-network help commands [flags]", "flags": [ { "name": "log-level", @@ -6944,7 +11056,7 @@ "name": "list", "description": "List private networks in your team.\n\nPick a subset of fields to display:\n```\npspace private-network list -F name -F dtModified\n```", "summary": "List private networks.", - "usage": " pspace private-network [flags]", + "usage": " private-network list [flags]", "flags": [ { "name": "limit", @@ -7146,7 +11258,7 @@ "name": "project", "description": "Manage your Paperspace projects.", "summary": "Manage your Paperspace projects.", - "usage": " pspace [command]\n pspace [flags]", + "usage": " project [command]\n project [flags]", "flags": [ { "name": "log-level", @@ -7176,68 +11288,180 @@ "aliases": [ "j" ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a new project. This command will prompt you for a name if you don't\nprovide one.", + "summary": "Create a new project", + "usage": " project create [arguments] [flags]", + "arguments": { + "description": "", + "summary": "Create a project with these properties.", + "items": [ + { + "position": 0, + "summary": "", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 120, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a new project. This command will prompt you for a name if you don't\nprovide one.", - "summary": "Create a new project", - "usage": " pspace project [arguments] [flags]", + "name": "delete", + "description": "Delete a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", + "summary": "Delete a project.", + "usage": " project delete [arguments] [flags]", "arguments": { "description": "", - "summary": "Create a project with these properties.", + "summary": "", "items": [ { "position": 0, - "summary": "", + "summary": "The project ID to delete.", "required": true, "variadic": false, "schema": { "type": "string", - "minLength": 1, - "maxLength": 120, + "description": "The project ID to delete.", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -7337,7 +11561,7 @@ "name": "get", "description": "Get a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", "summary": "Get a project.", - "usage": " pspace project [arguments] [flags]", + "usage": " project get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7449,7 +11673,7 @@ "name": "help", "description": "Show help for a project command", "summary": "Show help for a project command", - "usage": " pspace project [command]\n pspace project [arguments] [flags]", + "usage": " project help [command]\n project help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7467,6 +11691,7 @@ "create", "update", "link", + "delete", "help" ], "description": "The command to show help for.", @@ -7550,9 +11775,9 @@ "commands": [ { "name": "commands", - "description": "List project commands\n\nExample:\n```\n$ pspace project help commands\n```", + "description": "List project commands\n\nExample:\n```\n$ project help commands commands\n```", "summary": "List project commands", - "usage": " pspace project help [flags]", + "usage": " project help commands [flags]", "flags": [ { "name": "log-level", @@ -7650,7 +11875,7 @@ "name": "link", "description": "This will link a remote project to a local directory. Commands that\ndepend on a project ID will use the project ID of the linked project\nwhen communicating with the Paperspace API.\n\nLink a project to the current directory.\n```\n$ pspace link\n```\n\nLink a project to a different directory.\n```\n$ pspace link --cwd ../my-app\n```\n\nLink a project and specify a project ID.\n```\n$ pspace link pzwf2g05ubegj\n```", "summary": "Link a remote project to ", - "usage": " pspace project [arguments] [flags]", + "usage": " project link [arguments] [flags]", "arguments": { "description": "", "summary": "A project ID. If not provided, you will be prompted to select one.", @@ -7760,7 +11985,7 @@ "name": "list", "description": "List projects in your team.\n\nPick a subset of fields to display:\n```\npspace project list -F id -F name -F dtCreated\n```", "summary": "List projects.", - "usage": " pspace project [flags]", + "usage": " project list [flags]", "flags": [ { "name": "limit", @@ -8058,7 +12283,7 @@ "name": "public-ip", "description": "Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet.\n\nFor more information, see https://docs.paperspace.com/networking/public-ips.", "summary": "Manage your public IPs", - "usage": " pspace [command]\n pspace [flags]", + "usage": " public-ip [command]\n public-ip [flags]", "flags": [ { "name": "log-level", @@ -8136,7 +12361,7 @@ "name": "assign", "description": "Assign a public IP to a machine.", "summary": "Assign a public IP", - "usage": " pspace public-ip [arguments] [flags]", + "usage": " public-ip assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8267,7 +12492,7 @@ "name": "claim", "description": "Claim a public IP for a team.", "summary": "Claim a public IP", - "usage": " pspace public-ip [flags]", + "usage": " public-ip claim [flags]", "flags": [ { "name": "fields", @@ -8378,7 +12603,7 @@ "name": "help", "description": "Show help for a public-ip command", "summary": "Show help for a public-ip command", - "usage": " pspace public-ip [command]\n pspace public-ip [arguments] [flags]", + "usage": " public-ip help [command]\n public-ip help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8478,9 +12703,9 @@ "commands": [ { "name": "commands", - "description": "List public-ip commands\n\nExample:\n```\n$ pspace public-ip help commands\n```", + "description": "List public-ip commands\n\nExample:\n```\n$ public-ip help commands commands\n```", "summary": "List public-ip commands", - "usage": " pspace public-ip help [flags]", + "usage": " public-ip help commands [flags]", "flags": [ { "name": "log-level", @@ -8578,7 +12803,7 @@ "name": "list", "description": "List public IPs in your team or project.\n\nPick a subset of fields to display:\n```\npspace public-ip list -F name -F dtModified\n```", "summary": "List public IPs.", - "usage": " pspace public-ip [flags]", + "usage": " public-ip list [flags]", "flags": [ { "name": "limit", @@ -8762,7 +12987,7 @@ "name": "release", "description": "Release a public IP from a team. This will unassign it from its assigned machine, if any.", "summary": "Release a public IP", - "usage": " pspace public-ip [arguments] [flags]", + "usage": " public-ip release [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8876,7 +13101,7 @@ "name": "secret", "description": "Manage your Paperspace secrets. Secrets are used to store sensitive\ninformation such as API keys, passwords, and other credentials. Secrets \ncan be safely injected into workloads as environment variables. An environment \nvariable that uses a Secret will not reveal the contents of the secret itself.\n\nSecrets can be created at the following levels:\n\n- Project (default): these secrets are applied to all resources in a project\n- Global: these secrets can be applied to all resources on your current team\n\nFor more information, see https://docs.paperspace.com/secrets.", "summary": "Manage your Paperspace secrets", - "usage": " pspace [command]\n pspace [flags]", + "usage": " secret [command]\n secret [flags]", "flags": [ { "name": "log-level", @@ -8954,7 +13179,7 @@ "name": "create", "description": "Create a secret in a project or team.", "summary": "Create a secret", - "usage": " pspace secret [arguments] [arguments] [flags]", + "usage": " secret create [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9112,7 +13337,7 @@ "name": "delete", "description": "Delete a secret from a project or team.", "summary": "Delete a secret", - "usage": " pspace secret [arguments] [flags]", + "usage": " secret delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9257,7 +13482,7 @@ "name": "get", "description": "Get a secret from a project or team.", "summary": "Get a secret", - "usage": " pspace secret [arguments] [flags]", + "usage": " secret get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9418,7 +13643,7 @@ "name": "help", "description": "Show help for a secret command", "summary": "Show help for a secret command", - "usage": " pspace secret [command]\n pspace secret [arguments] [flags]", + "usage": " secret help [command]\n secret help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9519,9 +13744,9 @@ "commands": [ { "name": "commands", - "description": "List secret commands\n\nExample:\n```\n$ pspace secret help commands\n```", + "description": "List secret commands\n\nExample:\n```\n$ secret help commands commands\n```", "summary": "List secret commands", - "usage": " pspace secret help [flags]", + "usage": " secret help commands [flags]", "flags": [ { "name": "log-level", @@ -9619,7 +13844,7 @@ "name": "list", "description": "List secrets in your team or project.\n\nPick a subset of fields to display:\n```\npspace secret list -F name -F dtModified\n```", "summary": "List secrets.", - "usage": " pspace secret [flags]", + "usage": " secret list [flags]", "flags": [ { "name": "limit", @@ -9833,7 +14058,7 @@ "name": "update", "description": "Update a secret in a project or team.", "summary": "Update a secret", - "usage": " pspace secret [arguments] [arguments] [flags]", + "usage": " secret update [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9993,7 +14218,7 @@ "name": "shared-drive", "description": "Manage your shared drives. Shared drives are used to centralize data\nused by your team. Shared drives can be mounted on any Paperspace machine\nin the same private network.\n\nFor more information, see https://docs.paperspace.com/storage/shared-drives.", "summary": "Manage your shared drives", - "usage": " pspace [command]\n pspace [flags]", + "usage": " shared-drive [command]\n shared-drive [flags]", "flags": [ { "name": "log-level", @@ -10071,7 +14296,7 @@ "name": "create", "description": "Create a shared drive.", "summary": "Create a shared drive", - "usage": " pspace shared-drive [flags]", + "usage": " shared-drive create [flags]", "flags": [ { "name": "fields", @@ -10222,21 +14447,21 @@ }, { "name": "delete", - "description": "Delete a template from a team.", - "summary": "Delete a template", - "usage": " pspace shared-drive [arguments] [flags]", + "description": "Delete a shared drive from a team.", + "summary": "Delete a shared drive", + "usage": " shared-drive delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to delete", + "summary": "The ID of the shared drive to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to delete", + "description": "The ID of the shared drive to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -10334,21 +14559,21 @@ }, { "name": "get", - "description": "Get a template from a team.", - "summary": "Get a template", - "usage": " pspace shared-drive [arguments] [flags]", + "description": "Get a shared drive from a team.", + "summary": "Get a shared drive", + "usage": " shared-drive get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to get", + "summary": "The ID of the shared drive to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to get", + "description": "The ID of the shared drive to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -10448,7 +14673,7 @@ "name": "help", "description": "Show help for a shared-drive command", "summary": "Show help for a shared-drive command", - "usage": " pspace shared-drive [command]\n pspace shared-drive [arguments] [flags]", + "usage": " shared-drive help [command]\n shared-drive help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10548,9 +14773,9 @@ "commands": [ { "name": "commands", - "description": "List shared-drive commands\n\nExample:\n```\n$ pspace shared-drive help commands\n```", + "description": "List shared-drive commands\n\nExample:\n```\n$ shared-drive help commands commands\n```", "summary": "List shared-drive commands", - "usage": " pspace shared-drive help [flags]", + "usage": " shared-drive help commands [flags]", "flags": [ { "name": "log-level", @@ -10648,7 +14873,7 @@ "name": "list", "description": "List shared drives in your team or project.\n\nPick a subset of fields to display:\n```\npspace shared-drive list -F name -F dtModified\n```", "summary": "List shared drives.", - "usage": " pspace shared-drive [flags]", + "usage": " shared-drive list [flags]", "flags": [ { "name": "limit", @@ -10850,7 +15075,7 @@ "name": "signup", "description": "This command opens the Paperspace signup page in your browser.", "summary": "Sign up for a Paperspace account.", - "usage": " pspace [flags]", + "usage": " signup [flags]", "flags": [ { "name": "log-level", @@ -10929,7 +15154,7 @@ "name": "snapshot", "description": "Manage your snapshots. Snapshots are copies of your machine's disk at a point in time.\nThey can be used to restore the machine to its previous state. Using snapshots is recommended\nbefore taking any action that could affect the usability of the machine or its network connection.\n\nFor more information, see https://docs.paperspace.com/storage/snapshots.", "summary": "Manage your snapshots", - "usage": " pspace [command]\n pspace [flags]", + "usage": " snapshot [command]\n snapshot [flags]", "flags": [ { "name": "log-level", @@ -11007,7 +15232,7 @@ "name": "create", "description": "Create a snapshot from a machine.", "summary": "Create a snapshot", - "usage": " pspace snapshot [flags]", + "usage": " snapshot create [flags]", "flags": [ { "name": "fields", @@ -11134,7 +15359,7 @@ "name": "delete", "description": "Delete a snapshot from a team.", "summary": "Delete a snapshot", - "usage": " pspace snapshot [arguments] [flags]", + "usage": " snapshot delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11246,7 +15471,7 @@ "name": "help", "description": "Show help for a snapshot command", "summary": "Show help for a snapshot command", - "usage": " pspace snapshot [command]\n pspace snapshot [arguments] [flags]", + "usage": " snapshot help [command]\n snapshot help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11346,9 +15571,9 @@ "commands": [ { "name": "commands", - "description": "List snapshot commands\n\nExample:\n```\n$ pspace snapshot help commands\n```", + "description": "List snapshot commands\n\nExample:\n```\n$ snapshot help commands commands\n```", "summary": "List snapshot commands", - "usage": " pspace snapshot help [flags]", + "usage": " snapshot help commands [flags]", "flags": [ { "name": "log-level", @@ -11446,7 +15671,7 @@ "name": "list", "description": "List snapshots in your team.\n\nPick a subset of fields to display:\n```\npspace snapshot list -F name -F dtModified\n```", "summary": "List snapshots.", - "usage": " pspace snapshot [flags]", + "usage": " snapshot list [flags]", "flags": [ { "name": "limit", @@ -11630,7 +15855,7 @@ "name": "restore", "description": "Restore a machine to a snapshot.", "summary": "Restore a snapshot", - "usage": " pspace snapshot [arguments] [flags]", + "usage": " snapshot restore [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11758,7 +15983,7 @@ "name": "startup-script", "description": "Manage your startup scripts. Startup scripts allow you to configure a machine\non first boot or on every boot.", "summary": "Manage your startup scripts", - "usage": " pspace [command]\n pspace [flags]", + "usage": " startup-script [command]\n startup-script [flags]", "flags": [ { "name": "log-level", @@ -11836,7 +16061,7 @@ "name": "assign", "description": "Assign a startup script to a machine.", "summary": "Assign a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " startup-script assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11962,7 +16187,7 @@ "name": "create", "description": "Create a startup script.", "summary": "Create a startup script", - "usage": " pspace startup-script [flags]", + "usage": " startup-script create [flags]", "flags": [ { "name": "fields", @@ -12101,7 +16326,7 @@ "name": "delete", "description": "Delete a startup script from a team.", "summary": "Delete a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " startup-script delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12213,7 +16438,7 @@ "name": "get", "description": "Get a startup script from a team.", "summary": "Get a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " startup-script get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12325,7 +16550,7 @@ "name": "help", "description": "Show help for a startup-script command", "summary": "Show help for a startup-script command", - "usage": " pspace startup-script [command]\n pspace startup-script [arguments] [flags]", + "usage": " startup-script help [command]\n startup-script help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12428,9 +16653,9 @@ "commands": [ { "name": "commands", - "description": "List startup-script commands\n\nExample:\n```\n$ pspace startup-script help commands\n```", + "description": "List startup-script commands\n\nExample:\n```\n$ startup-script help commands commands\n```", "summary": "List startup-script commands", - "usage": " pspace startup-script help [flags]", + "usage": " startup-script help commands [flags]", "flags": [ { "name": "log-level", @@ -12519,37 +16744,240 @@ "$schema": "http://json-schema.org/draft-07/schema#" } } - ], - "commands": [] - } - ] - }, - { - "name": "list", - "description": "List startup scripts in your team.\n\nPick a subset of fields to display:\n```\npspace startup-script list -F name -F dtCreated\n```", - "summary": "List startup scripts.", - "usage": " pspace startup-script [flags]", + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List startup scripts in your team.\n\nPick a subset of fields to display:\n```\npspace startup-script list -F name -F dtCreated\n```", + "summary": "List startup scripts.", + "usage": " startup-script list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "unassign", + "description": "Unassign a startup script from a machine.", + "summary": "Unassign a startup script", + "usage": " startup-script unassign [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the startup script to unassign", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the startup script to unassign", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ { - "name": "limit", - "aliases": [], - "description": "The number of items to return in the next page.", - "summary": "The number of items to return in the next page.", + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", "required": false, - "collects": false, + "collects": true, "negatable": false, "global": false, "schema": { - "type": "number", + "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "after", + "name": "machine-id", "aliases": [], - "description": "The cursor to fetch the next results from.", - "summary": "The cursor to fetch the next results from.", - "required": false, + "description": "The ID of the machine to unassign the startup script from", + "summary": "The ID of the machine to unassign the startup script from", + "required": true, "collects": false, "negatable": false, "global": false, @@ -12559,50 +16987,101 @@ } }, { - "name": "orderBy", - "aliases": [], - "description": "The field to order items by.", - "summary": "The field to order items by.", + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", "enum": [ - "dtCreated" + "debug", + "info", + "warning", + "error", + "critical" ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "asc", - "aliases": [], - "description": "Whether to order items ascending.", - "summary": "Whether to order items ascending.", + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "boolean", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "desc", + "name": "api-key", "aliases": [], - "description": "Whether to order items descending.", - "summary": "Whether to order items descending.", + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { - "type": "boolean", + "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a startup script.", + "summary": "Update a startup script", + "usage": " startup-script update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the startup script to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the startup script to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { "name": "fields", "aliases": [ @@ -12624,8 +17103,22 @@ "aliases": [ "n" ], - "description": "Filter by name.", - "summary": "Filter by name.", + "description": "The name of the startup script", + "summary": "The name of the startup script", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "script", + "aliases": [], + "description": "The script to run", + "summary": "The script to run", "required": false, "collects": false, "negatable": false, @@ -12635,6 +17128,34 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "run-once", + "aliases": [], + "description": "Whether to run once or on every boot", + "summary": "Whether to run once or on every boot", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "enabled", + "aliases": [], + "description": "Whether the startup script is enabled or not", + "summary": "Whether the startup script is enabled or not", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -12707,60 +17228,93 @@ } ], "commands": [] + } + ] + }, + { + "name": "storage-provider", + "description": "Manage your storage providers.\n\nFor more information, see https://docs.paperspace.com/storage/storageProviders.", + "summary": "Manage your storage providers", + "usage": " storage-provider [command]\n storage-provider [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "unassign", - "description": "Unassign a startup script from a machine.", - "summary": "Unassign a startup script", - "usage": " pspace startup-script [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the startup script to unassign", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the startup script to unassign", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a storage provider.", + "summary": "Create a storage provider", + "usage": " storage-provider create [command]\n storage-provider create [flags]", "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-id", - "aliases": [], - "description": "The ID of the machine to unassign the startup script from", - "summary": "The ID of the machine to unassign the startup script from", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -12819,38 +17373,459 @@ "aliases": [ "h" ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "help", + "description": "Show help for a create command", + "summary": "Show help for a create command", + "usage": " storage-provider create help [command]\n storage-provider create help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "s3", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List create commands\n\nExample:\n```\n$ storage-provider create help commands commands\n```", + "summary": "List create commands", + "usage": " storage-provider create help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "s3", + "description": "Create an S3 storage provider.", + "summary": "Create an S3 storage provider", + "usage": " storage-provider create s3 [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the storage provider", + "summary": "The name of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-team-default", + "aliases": [], + "description": "Whether the storage provider is the team's default provider", + "summary": "Whether the storage provider is the team's default provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "endpoint", + "aliases": [], + "description": "The endpoint of the storage provider", + "summary": "The endpoint of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "bucket", + "aliases": [], + "description": "The bucket of the storage provider", + "summary": "The bucket of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region of the storage provider", + "summary": "The region of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "access-key", + "aliases": [], + "description": "The access key of the storage provider", + "summary": "The access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "secret-access-key", + "aliases": [], + "description": "The secret access key of the storage provider", + "summary": "The secret access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "signature-version", + "aliases": [], + "description": "The signature version of the storage provider", + "summary": "The signature version of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "retain-data", + "aliases": [], + "description": "Whether to retain data in the storage provider", + "summary": "Whether to retain data in the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] } - ], - "commands": [] + ] }, { - "name": "update", - "description": "Update a startup script.", - "summary": "Update a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "name": "delete", + "description": "Delete a storage provider from a team.", + "summary": "Delete a storage provider", + "usage": " storage-provider delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the startup script to update", + "summary": "The ID of the storage provider to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the startup script to update", + "description": "The ID of the storage provider to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -12873,64 +17848,6 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the startup script", - "summary": "The name of the startup script", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "script", - "aliases": [], - "description": "The script to run", - "summary": "The script to run", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "run-once", - "aliases": [], - "description": "Whether to run once or on every boot", - "summary": "Whether to run once or on every boot", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "enabled", - "aliases": [], - "description": "Whether the startup script is enabled or not", - "summary": "Whether the startup script is enabled or not", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -12970,167 +17887,72 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - } - ] - }, - { - "name": "template", - "description": "Manage your templates. Templates are a backup of your machine's disk.\nThey can be used to create additional machines. You can use them to\nprepopulate a machine with your desired software stack.\n\nFor more information, see https://docs.paperspace.com/compute/custom-templates.", - "summary": "Manage your templates", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a template from a machine.", - "summary": "Create a template", - "usage": " pspace template [flags]", - "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", "required": false, - "collects": true, + "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "name", + "name": "help", "aliases": [ - "n" + "h" ], - "description": "The name of the template", - "summary": "The name of the template", - "required": true, + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { - "type": "string", + "type": "boolean", + "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a storage provider from a team.", + "summary": "Get a storage provider", + "usage": " storage-provider get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the storage provider to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the storage provider to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { - "name": "machine-id", + "name": "fields", "aliases": [ - "m" + "F" ], - "description": "The ID of the machine to create a template from", - "summary": "The ID of the machine to create a template from", - "required": true, - "collects": false, + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, "negatable": false, "global": false, "schema": { @@ -13212,22 +18034,30 @@ "commands": [] }, { - "name": "delete", - "description": "Delete a template from a team.", - "summary": "Delete a template", - "usage": " pspace template [arguments] [flags]", + "name": "help", + "description": "Show help for a storage-provider command", + "summary": "Show help for a storage-provider command", + "usage": " storage-provider help [command]\n storage-provider help [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to delete", + "summary": "The command to show help for.", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to delete", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -13235,14 +18065,202 @@ }, "flags": [ { - "name": "fields", + "name": "log-level", "aliases": [ - "F" + "l" ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List storage-provider commands\n\nExample:\n```\n$ storage-provider help commands commands\n```", + "summary": "List storage-provider commands", + "usage": " storage-provider help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List storage providers in your team or project.\n\nPick a subset of fields to display:\n```\npspace storage provider list -F name -F dtModified\n```", + "summary": "List storage providers.", + "usage": " storage-provider list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", "required": false, - "collects": true, + "collects": false, "negatable": false, "global": false, "schema": { @@ -13251,101 +18269,50 @@ } }, { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "string", "enum": [ - "debug", - "info", - "warning", - "error", - "critical" + "dtCreated" ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "boolean", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "api-key", + "name": "desc", "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "boolean", - "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - } - ], - "commands": [] - }, - { - "name": "get", - "description": "Get a template from a team.", - "summary": "Get a template", - "usage": " pspace template [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the template to get", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the template to get", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ + }, { "name": "fields", "aliases": [ @@ -13436,34 +18403,10 @@ "commands": [] }, { - "name": "help", - "description": "Show help for a template command", - "summary": "Show help for a template command", - "usage": " pspace template [command]\n pspace template [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The command to show help for.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "create", - "get", - "list", - "delete", - "help" - ], - "description": "The command to show help for.", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, + "name": "update", + "description": "Update a storage provider.", + "summary": "Update a storage provider", + "usage": " storage-provider update [command]\n storage-provider update [flags]", "flags": [ { "name": "log-level", @@ -13538,11 +18481,369 @@ ], "commands": [ { - "name": "commands", - "description": "List template commands\n\nExample:\n```\n$ pspace template help commands\n```", - "summary": "List template commands", - "usage": " pspace template help [flags]", + "name": "help", + "description": "Show help for a update command", + "summary": "Show help for a update command", + "usage": " storage-provider update help [command]\n storage-provider update help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "s3", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List update commands\n\nExample:\n```\n$ storage-provider update help commands commands\n```", + "summary": "List update commands", + "usage": " storage-provider update help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "s3", + "description": "Update an S3 storage provider in a project or team.", + "summary": "Update an S3 storage provider", + "usage": " storage-provider update s3 [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the storage provider to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the storage provider to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the storage provider", + "summary": "The name of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-team-default", + "aliases": [], + "description": "Whether the storage provider is the team's default provider", + "summary": "Whether the storage provider is the team's default provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "endpoint", + "aliases": [], + "description": "The endpoint of the storage provider", + "summary": "The endpoint of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "bucket", + "aliases": [], + "description": "The bucket of the storage provider", + "summary": "The bucket of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region of the storage provider", + "summary": "The region of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "access-key", + "aliases": [], + "description": "The access key of the storage provider", + "summary": "The access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "secret-access-key", + "aliases": [], + "description": "The secret access key of the storage provider", + "summary": "The secret access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "signature-version", + "aliases": [], + "description": "The signature version of the storage provider", + "summary": "The signature version of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "retain-data", + "aliases": [], + "description": "Whether to retain data in the storage provider", + "summary": "Whether to retain data in the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -13612,228 +18913,11 @@ "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Show all commands, including hidden ones", - "summary": "Show all commands, including hidden ones", - "required": false, - "collects": false, - "negatable": false, - "default": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } } ], "commands": [] } ] - }, - { - "name": "list", - "description": "List templates in your team.\n\nPick a subset of fields to display:\n```\npspace template list -F name -F dtModified\n```", - "summary": "List templates.", - "usage": " pspace template [flags]", - "flags": [ - { - "name": "limit", - "aliases": [], - "description": "The number of items to return in the next page.", - "summary": "The number of items to return in the next page.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "after", - "aliases": [], - "description": "The cursor to fetch the next results from.", - "summary": "The cursor to fetch the next results from.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "orderBy", - "aliases": [], - "description": "The field to order items by.", - "summary": "The field to order items by.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "enum": [ - "dtCreated" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "asc", - "aliases": [], - "description": "Whether to order items ascending.", - "summary": "Whether to order items ascending.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "desc", - "aliases": [], - "description": "Whether to order items descending.", - "summary": "Whether to order items descending.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-id", - "aliases": [ - "m" - ], - "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", - "summary": "The ID of the machine the event is for", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "Filter by name.", - "summary": "Filter by name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] } ] }, @@ -13841,7 +18925,7 @@ "name": "up", "description": "This will upsert an app config and deploy your app to Paperspace. You can optionally \nspecify a path to a config file. If no config file is specified, the default\nconfig file paths will be tried.\n\nDeploy the app in the current directory.\n```\n$ pspace up\n```\n\nDeploy the app using a config file.\n```\n$ pspace up -c paperspace.json\n```\n\nDeploy an app in a different directory.\n```\n$ pspace up --cwd ../my-app\n```", "summary": "Deploy your app to Paperspace", - "usage": " pspace [flags]", + "usage": " up [flags]", "flags": [ { "name": "config", @@ -13966,7 +19050,7 @@ "name": "upgrade", "description": "This command upgrades \u001b[1mpspace\u001b[22m to the latest version.\n\nIf you used a package manager like `brew` to install `pspace`, \nyou should use that to upgrade in order to avoid potential permissions \nissues. For example, for `brew` you can upgrade by running:\n```\nbrew upgrade pspace\n```\n\nIf you installed `pspace` using the install script, you can upgrade by\nrunning:\n```\npspace upgrade\n```", "summary": "Upgrade \u001b[1mpspace\u001b[22m to the latest version.", - "usage": " pspace [flags]", + "usage": " upgrade [flags]", "flags": [ { "name": "log-level", @@ -14045,7 +19129,7 @@ "name": "version", "description": "Shows version information command, including version number and build date.", "summary": "Show version information", - "usage": " pspace [flags]", + "usage": " version [flags]", "flags": [ { "name": "log-level", @@ -14123,4 +19207,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index e0eaeab..265d403 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -1,6 +1,9 @@ import { app } from "../zcli.ts"; import { root } from "../commands/mod.ts"; -import { zcliJson } from "https://deno.land/x/zcli@1.3.3/zcli-json.ts"; +import { + zcliJson, + ZcliJsonCommand, +} from "https://deno.land/x/zcli@1.3.3/zcli-json.ts"; // Read the markdown file adjacent to this script const json = await zcliJson(app, root); @@ -10,3 +13,40 @@ await Deno.writeTextFile( ".assets/pspace.json", JSON.stringify(json, null, 2), ); + +// Also generate markdown for the CLI +let markdown = ""; +markdown += "# Paperspace CLI\n\n"; +markdown += json.info.description + "\n\n"; + +function renderCommand(path: string[], command: ZcliJsonCommand) { + markdown += `## ${path.join(" ")}\n\n`; + markdown += command.description + "\n\n"; + markdown += "### Usage\n\n"; + markdown += `\`\`\`\n`; + markdown += `${command.usage}\n`; + markdown += "\`\`\`\n\n"; + markdown += "### Flags\n\n"; + markdown += "| Name | Aliases | Description | Required |\n"; + markdown += "| --- | --- | --- | --- |\n"; + for (const flag of command.flags) { + markdown += `| ${flag.name} | ${ + flag.aliases.join(", ") + } | ${flag.description} | ${flag.required} |\n`; + } + markdown += "\n"; + + markdown += "### Subcommands\n\n"; + for (const subcommand of command.commands) { + markdown += `- [${subcommand.name}](#${subcommand.name})\n`; + } + for (const subcommand of command.commands) { + renderCommand([...path, subcommand.name], subcommand); + } +} + +for (const command of json.commands) { + renderCommand([command.name], command); +} + +await Deno.writeTextFile(".assets/paperspace.md", markdown); From f2b4d0daa93738bbdfb2d985ce1ee7f9009e6773 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Tue, 14 May 2024 05:05:34 +0000 Subject: [PATCH 02/10] rename --- .assets/{paperspace.md => pspace.md} | 0 .scripts/generate-docs.ts | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename .assets/{paperspace.md => pspace.md} (100%) diff --git a/.assets/paperspace.md b/.assets/pspace.md similarity index 100% rename from .assets/paperspace.md rename to .assets/pspace.md diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index 265d403..c2c5f0b 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -49,4 +49,4 @@ for (const command of json.commands) { renderCommand([command.name], command); } -await Deno.writeTextFile(".assets/paperspace.md", markdown); +await Deno.writeTextFile(".assets/pspace.md", markdown); From fe91d2851613d443adf50c9889675ae2ee03d24a Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Tue, 14 May 2024 13:59:59 +0000 Subject: [PATCH 03/10] fmt --- .assets/pspace.json | 2 +- .assets/pspace.md | 1894 ++++++++++++++++++++++--------------------- 2 files changed, 977 insertions(+), 919 deletions(-) diff --git a/.assets/pspace.json b/.assets/pspace.json index dbc5068..c7f485f 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -19207,4 +19207,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/.assets/pspace.md b/.assets/pspace.md index 08a743d..24f8766 100644 --- a/.assets/pspace.md +++ b/.assets/pspace.md @@ -1,42 +1,42 @@ # Paperspace CLI -A CLI for using the Paperspace API. +A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. -* Deploy an ML app with the `deployment` command -* View a deployed app with the `deployment open` command -* Check the status of a deployment with the `deployment status` command +- Deploy an ML app with the `deployment` command +- View a deployed app with the `deployment open` command +- Check the status of a deployment with the `deployment status` command Read the full documentation at: https://docs.paperspace.com/ ## pspace -A CLI for using the Paperspace API. +A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. -* Deploy an ML app with the `deployment` command -* View a deployed app with the `deployment open` command -* Check the status of a deployment with the `deployment status` command +- Deploy an ML app with the `deployment` command +- View a deployed app with the `deployment open` command +- Check the status of a deployment with the `deployment status` command Read the full documentation at: https://docs.paperspace.com/ ### Usage ``` - pspace [command] - pspace [flags] +pspace [command] +pspace [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -68,27 +68,28 @@ Read the full documentation at: https://docs.paperspace.com/ - [up](#up) - [upgrade](#upgrade) - [version](#version) + ## pspace autoscaling-group -Manage your autoscaling groups. Autoscaling groups enable using -the Kubernetes cluster-autoscaler to automatically scale your cluster. -You can also autoscaling groups as a primitive for your own autoscaler. +Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes +cluster-autoscaler to automatically scale your cluster. You can also autoscaling +groups as a primitive for your own autoscaler. ### Usage ``` - autoscaling-group [command] - autoscaling-group [flags] +autoscaling-group [command] +autoscaling-group [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -98,6 +99,7 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) + ## pspace autoscaling-group create Create an autoscaling group. @@ -105,27 +107,27 @@ Create an autoscaling group. ### Usage ``` - autoscaling-group create [flags] +autoscaling-group create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -136,18 +138,18 @@ Delete an autoscaling group from a team. ### Usage ``` - autoscaling-group delete [arguments] [flags] +autoscaling-group delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -158,18 +160,18 @@ Get an autoscaling group from a team. ### Usage ``` - autoscaling-group get [arguments] [flags] +autoscaling-group get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -180,27 +182,29 @@ Show help for a autoscaling-group command ### Usage ``` - autoscaling-group help [command] - autoscaling-group help [arguments] [flags] +autoscaling-group help [command] +autoscaling-group help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace autoscaling-group help commands List autoscaling-group commands Example: + ``` $ autoscaling-group help commands commands ``` @@ -208,18 +212,18 @@ $ autoscaling-group help commands commands ### Usage ``` - autoscaling-group help commands [flags] +autoscaling-group help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -228,6 +232,7 @@ $ autoscaling-group help commands commands List autoscaling groups in your team. Pick a subset of fields to display: + ``` pspace autoscaling-group list -F name -F dtCreated ``` @@ -235,25 +240,25 @@ pspace autoscaling-group list -F name -F dtCreated ### Usage ``` - autoscaling-group list [flags] +autoscaling-group list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -264,51 +269,51 @@ Update an autoscaling group. ### Usage ``` - autoscaling-group update [arguments] [flags] +autoscaling-group update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace completion -Generate an autocompletion script for pspace in the specified shell. -See each sub-command's help for details on how to use the generated script. +Generate an autocompletion script for pspace in the specified shell. See each +sub-command's help for details on how to use the generated script. ### Usage ``` - completion [command] - completion [flags] +completion [command] +completion [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -316,14 +321,16 @@ See each sub-command's help for details on how to use the generated script. - [fish](#fish) - [help](#help) - [zsh](#zsh) + ## pspace completion bash Generate the autocompletion script for the bash shell. -This script depends on the `bash-completion` package. -If it is not installed already, you can install it via your OS's package manager. +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. To load completions in your current shell session: + ``` $ source <(completion bash bash) ``` @@ -331,11 +338,13 @@ $ source <(completion bash bash) To load completions for every new session, execute once: Linux: + ``` $ completion bash bash > /etc/bash_completion.d/pspace ``` macOS: + ``` $ completion bash bash > /usr/local/etc/bash_completion.d/pspace ``` @@ -345,17 +354,17 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion bash [flags] +completion bash [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -364,11 +373,13 @@ You will need to start a new shell for this setup to take effect. Generate the autocompletion script for the fish shell. To load completions in your current shell session: + ``` $ completion fish fish | source ``` To load completions for every new session, execute once: + ``` $ completion fish fish > ~/.config/fish/completions/pspace.fish ``` @@ -378,18 +389,18 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion fish [flags] +completion fish [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -400,27 +411,29 @@ Show help for a completion command ### Usage ``` - completion help [command] - completion help [arguments] [flags] +completion help [command] +completion help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace completion help commands List completion commands Example: + ``` $ completion help commands commands ``` @@ -428,18 +441,18 @@ $ completion help commands commands ### Usage ``` - completion help commands [flags] +completion help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -447,8 +460,8 @@ $ completion help commands commands Generate the autocompletion script for the zsh shell. -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: ``` $ echo "autoload -U compinit; compinit" >> ~/.zshrc @@ -457,16 +470,19 @@ $ echo "autoload -U compinit; compinit" >> ~/.zshrc To load completions for every new session, execute once: Linux: + ``` $ completion zsh zsh > "${fpath[1]}/_pspace" ``` macOS: + ``` $ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace ``` Oh My Zsh: + ``` $ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace ``` @@ -476,30 +492,31 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion zsh [flags] +completion zsh [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace config -This command manages your Paperspace configuration. You can use it to set, get, and -delete configuration values. Running this command without any subcommands will print -your current configuration. +This command manages your Paperspace configuration. You can use it to set, get, +and delete configuration values. Running this command without any subcommands +will print your current configuration. -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: -For example, to set the current team, run: ``` pspace config set team "my-team" ``` @@ -507,18 +524,18 @@ pspace config set team "my-team" ### Usage ``` - config [command] - config [flags] +config [command] +config [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -526,6 +543,7 @@ pspace config set team "my-team" - [get](#get) - [help](#help) - [set](#set) + ## pspace config delete Delete a configuration value. @@ -533,17 +551,17 @@ Delete a configuration value. ### Usage ``` - config delete [flags] +config delete [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -553,6 +571,7 @@ This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values. For example, to get the current team run: + ``` pspace config get team ``` @@ -560,17 +579,17 @@ pspace config get team ### Usage ``` - config get [arguments] [flags] +config get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -581,27 +600,29 @@ Show help for a config command ### Usage ``` - config help [command] - config help [arguments] [flags] +config help [command] +config help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace config help commands List config commands Example: + ``` $ config help commands commands ``` @@ -609,18 +630,18 @@ $ config help commands commands ### Usage ``` - config help commands [flags] +config help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -631,17 +652,17 @@ Set a configuration value. ### Usage ``` - config set [arguments] [arguments...] [flags] +config set [arguments] [arguments...] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -652,43 +673,43 @@ This command opens the Paperspace web console in your browser. ### Usage ``` - console [flags] +console [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace custom-template -Manage your custom templates. Custom templates are a backup of your -machine's disk. They can be used to create additional machines. You -can use them to prepopulate a machine with your desired software stack. +Manage your custom templates. Custom templates are a backup of your machine's +disk. They can be used to create additional machines. You can use them to +prepopulate a machine with your desired software stack. For more information, see https://docs.paperspace.com/compute/custom-templates. ### Usage ``` - custom-template [command] - custom-template [flags] +custom-template [command] +custom-template [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -697,6 +718,7 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. - [get](#get) - [help](#help) - [list](#list) + ## pspace custom-template create Create a custom template from a machine. @@ -704,20 +726,20 @@ Create a custom template from a machine. ### Usage ``` - custom-template create [flags] +custom-template create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -728,18 +750,18 @@ Delete a custom template from a team. ### Usage ``` - custom-template delete [arguments] [flags] +custom-template delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -750,18 +772,18 @@ Get a custom template from a team. ### Usage ``` - custom-template get [arguments] [flags] +custom-template get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -772,27 +794,29 @@ Show help for a custom-template command ### Usage ``` - custom-template help [command] - custom-template help [arguments] [flags] +custom-template help [command] +custom-template help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace custom-template help commands List custom-template commands Example: + ``` $ custom-template help commands commands ``` @@ -800,18 +824,18 @@ $ custom-template help commands commands ### Usage ``` - custom-template help commands [flags] +custom-template help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -820,6 +844,7 @@ $ custom-template help commands commands List custom templates in your team. Pick a subset of fields to display: + ``` pspace custom-template list -F name -F dtModified ``` @@ -827,26 +852,26 @@ pspace custom-template list -F name -F dtModified ### Usage ``` - custom-template list [flags] +custom-template list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -859,18 +884,18 @@ For more information, see https://docs.paperspace.com/storage/datasets. ### Usage ``` - dataset [command] - dataset [flags] +dataset [command] +dataset [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -881,6 +906,7 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) + ## pspace dataset create Create a dataset. @@ -888,22 +914,22 @@ Create a dataset. ### Usage ``` - dataset create [flags] +dataset create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -914,18 +940,18 @@ Delete a dataset from a team. ### Usage ``` - dataset delete [arguments] [flags] +dataset delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -936,18 +962,18 @@ Get a dataset from a team. ### Usage ``` - dataset get [arguments] [flags] +dataset get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -958,27 +984,29 @@ Show help for a dataset command ### Usage ``` - dataset help [command] - dataset help [arguments] [flags] +dataset help [command] +dataset help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace dataset help commands List dataset commands Example: + ``` $ dataset help commands commands ``` @@ -986,18 +1014,18 @@ $ dataset help commands commands ### Usage ``` - dataset help commands [flags] +dataset help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -1006,6 +1034,7 @@ $ dataset help commands commands List datasets in your team or project. Pick a subset of fields to display: + ``` pspace dataset list -F name -F dtModified ``` @@ -1013,23 +1042,23 @@ pspace dataset list -F name -F dtModified ### Usage ``` - dataset list [flags] +dataset list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1040,20 +1069,20 @@ Update a dataset in a project or team. ### Usage ``` - dataset update [arguments] [flags] +dataset update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1066,18 +1095,18 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. ### Usage ``` - dataset versions [command] - dataset versions [flags] +dataset versions [command] +dataset versions [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1087,6 +1116,7 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. - [help](#help) - [list](#list) - [update](#update) + ## pspace dataset versions create Create a dataset version. This command will prompt you for an ID if you don't @@ -1095,65 +1125,65 @@ provide one. ### Usage ``` - dataset versions create [arguments] [arguments] [flags] +dataset versions create [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace dataset versions delete -Delete a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Delete a dataset version from a team. This command will prompt you for an ID if +you don't provide one. ### Usage ``` - dataset versions delete [arguments] [arguments] [flags] +dataset versions delete [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace dataset versions get -Get a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Get a dataset version from a team. This command will prompt you for an ID if you +don't provide one. ### Usage ``` - dataset versions get [arguments] [arguments] [flags] +dataset versions get [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1164,27 +1194,29 @@ Show help for a versions command ### Usage ``` - dataset versions help [command] - dataset versions help [arguments] [flags] +dataset versions help [command] +dataset versions help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace dataset versions help commands List versions commands Example: + ``` $ dataset versions help commands commands ``` @@ -1192,18 +1224,18 @@ $ dataset versions help commands commands ### Usage ``` - dataset versions help commands [flags] +dataset versions help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -1212,6 +1244,7 @@ $ dataset versions help commands commands List dataset versions in your team or project. Pick a subset of fields to display: + ``` pspace dataset versions list -F name -F dtModified ``` @@ -1219,23 +1252,23 @@ pspace dataset versions list -F name -F dtModified ### Usage ``` - dataset versions list [arguments] [flags] +dataset versions list [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1246,20 +1279,20 @@ Update a dataset version in a project or team. ### Usage ``` - dataset versions update [arguments] [arguments] [flags] +dataset versions update [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1270,18 +1303,18 @@ Effortlessly deploy ML apps to Paperspace. ### Usage ``` - deployment [command] - deployment [flags] +deployment [command] +deployment [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1290,6 +1323,7 @@ Effortlessly deploy ML apps to Paperspace. - [help](#help) - [list](#list) - [up](#up) + ## pspace deployment delete Delete a deployment by its ID. If you don't provide an ID, this command will @@ -1302,30 +1336,31 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ### Usage ``` - deployment delete [arguments] [flags] +deployment delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace deployment get -Get a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. +Get a deployment by its ID. If you don't provide an ID, this command will prompt +you for one based on the deployments you have access to. ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 ``` Pick a subset of fields to display: + ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ``` @@ -1333,18 +1368,18 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ### Usage ``` - deployment get [arguments] [flags] +deployment get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1355,27 +1390,29 @@ Show help for a deployment command ### Usage ``` - deployment help [command] - deployment help [arguments] [flags] +deployment help [command] +deployment help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace deployment help commands List deployment commands Example: + ``` $ deployment help commands commands ``` @@ -1383,18 +1420,18 @@ $ deployment help commands commands ### Usage ``` - deployment help commands [flags] +deployment help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands @@ -1403,6 +1440,7 @@ $ deployment help commands commands List deployments in your team. Pick a subset of fields to display: + ``` pspace deployment list -F id -F name ``` @@ -1410,48 +1448,52 @@ pspace deployment list -F id -F name ### Usage ``` - deployment list [flags] +deployment list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands ## pspace deployment up -This will create a new deployment for your app or update it if it already exists. -You can optionally specify a path to a config file. If no config file is specified, -the default config file paths will be tried. +This will create a new deployment for your app or update it if it already +exists. You can optionally specify a path to a config file. If no config file is +specified, the default config file paths will be tried. Create a new deployment for the app in the current directory. + ``` $ pspace deployment create ``` Create a new deployment using a config file. + ``` $ pspace deployment create -c paperspace.json ``` Create a new deployment for an app in a different directory. + ``` $ pspace deployment create --cwd ../my-app ``` Create a new deployment for an app in a specific project. + ``` $ pspace deployment create --project-id 1234 ``` @@ -1459,14 +1501,14 @@ $ pspace deployment create --project-id 1234 ### Usage ``` - deployment up [flags] +deployment up [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. +| Name | Aliases | Description | Required | +| ------ | ------- | ----------------------------------------------------------------------- | -------- | +| config | c | The path to the config file. Defaults to our default config file paths. | | The default config file paths are in order of precedence: @@ -1479,39 +1521,38 @@ The default config file paths are in order of precedence: - `.paperspace/app.yml` - `.paperspace/app.json` - `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to + deploy to. | false | | cwd | | The directory to deploy the app from. Defaults + to the current directory. | false | | log-level | l | Enable debug logging. | + false | | json | j | Output JSON | false | | api-key | | A Paperspace public + API Key used for authenticating requests | false | | help | h | Show help for + a command | false | ### Subcommands ## pspace docs -This command opens the Paperspace documentation in your browser. -You can optionally pass an argument that will take you to a specific -docs page. +This command opens the Paperspace documentation in your browser. You can +optionally pass an argument that will take you to a specific docs page. Valid pages are: - - `d`, `deployment` + +- `d`, `deployment` ### Usage ``` - docs [arguments] [flags] +docs [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -1522,27 +1563,29 @@ Show help for a pspace command ### Usage ``` - help [command] - help [arguments] [flags] +help [command] +help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands - [commands](#commands) + ## pspace help commands List pspace commands Example: + ``` $ help commands commands ``` @@ -1550,40 +1593,42 @@ $ help commands commands ### Usage ``` - help commands [flags] +help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | ### Subcommands ## pspace init -Create a new Paperspace app. This will create a new directory with a -default app structure. You can optionally specify a name for the app -and a template to use. If no template is specified, the default -template will be used. +Create a new Paperspace app. This will create a new directory with a default app +structure. You can optionally specify a name for the app and a template to use. +If no template is specified, the default template will be used. Create a new app in the current directory. + ``` $ pspace init ``` Create a new app named "my-app" relative to the current directory. + ``` $ pspace init my-app ``` -Create a new app named "my-app" relative to the current directory using -a template from the Paperspace GitHub organization. +Create a new app named "my-app" relative to the current directory using a +template from the Paperspace GitHub organization. + ``` $ pspace init my-app -t Paperspace/gradio-demo ``` @@ -1591,17 +1636,18 @@ $ pspace init my-app -t Paperspace/gradio-demo ### Usage ``` - init [arguments] [flags] +init [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| template | t | A template to use when creating the app. This can be a URL -to a git repository or a shorthand template name. +| Name | Aliases | Description | Required | +| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | +| template | t | A template to use when creating the app. This can be a URL | | +| to a git repository or a shorthand template name. | | | | These templates are equivalent: + ``` user/repo github:user/repo @@ -1610,6 +1656,7 @@ https://github.com/user/repo ``` Download from GitLab: + ``` gitlab:user/repo git@gitlab.com:user/repo @@ -1617,6 +1664,7 @@ https://gitlab.com/user/repo ``` Download from Bitbucket + ``` bitbucket:user/repo git@bitbucket.org:user/repo @@ -1624,7 +1672,8 @@ https://bitbucket.org/user/repo ``` Specify a tag or branch: -``` + +```` user/repo#dev # branch user/repo#v1.2.3 # release tag user/repo#1234abcd # commit hash @@ -1647,11 +1696,11 @@ SSH key configured with GitHub, Bitbucket, or GitLab. | false | Log in to the CLI using your Paperspace API key or by opening the web console. ### Usage +```` -``` - login [arguments] [flags] -``` +login [arguments] [flags] +``` ### Flags | Name | Aliases | Description | Required | @@ -1667,12 +1716,12 @@ Log in to the CLI using your Paperspace API key or by opening the web console. Log out of the CLI for the current team, a specific team, or all teams. -### Usage +### Usage +``` + +logout [arguments...] [flags] ``` - logout [arguments...] [flags] -``` - ### Flags | Name | Aliases | Description | Required | @@ -1692,12 +1741,11 @@ Manage your Paperspace machines. For more information, see https://docs.paperspace.com/machines. ### Usage - -``` - machine [command] - machine [flags] ``` +machine [command] machine [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1723,11 +1771,11 @@ For more information, see https://docs.paperspace.com/machines. Create a machine. ### Usage - -``` - machine create [flags] ``` +machine create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1766,11 +1814,11 @@ Create a machine. Delete a machine from a team. ### Usage - -``` - machine delete [arguments] [flags] ``` +machine delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1788,11 +1836,11 @@ Delete a machine from a team. Get a machine from a team. ### Usage - -``` - machine get [arguments] [flags] ``` +machine get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1810,12 +1858,11 @@ Get a machine from a team. Show help for a machine command ### Usage - -``` - machine help [command] - machine help [arguments] [flags] ``` +machine help [command] machine help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1834,15 +1881,16 @@ List machine commands Example: ``` -$ machine help commands commands -``` -### Usage +$ machine help commands commands ``` - machine help commands [flags] +### Usage ``` +machine help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1861,15 +1909,16 @@ List machines in your team. Pick a subset of fields to display: ``` -pspace machine list -F name -F dtModified -``` -### Usage +pspace machine list -F name -F dtModified ``` - machine list [flags] +### Usage ``` +machine list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1896,11 +1945,11 @@ pspace machine list -F name -F dtModified Restart a machine from a team. ### Usage - -``` - machine restart [arguments] [flags] ``` +machine restart [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1918,11 +1967,11 @@ Restart a machine from a team. Start a machine from a team. ### Usage - -``` - machine start [arguments] [flags] ``` +machine start [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1940,11 +1989,11 @@ Start a machine from a team. Stop a machine from a team. ### Usage - -``` - machine stop [arguments] [flags] ``` +machine stop [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1962,11 +2011,11 @@ Stop a machine from a team. Update a machine's settings. ### Usage - -``` - machine update [arguments] [flags] ``` +machine update [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2002,12 +2051,11 @@ which can be tracked using this command. For more information, see https://docs.paperspace.com/machines. ### Usage - -``` - machine-event [command] - machine-event [flags] ``` +machine-event [command] machine-event [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2027,11 +2075,11 @@ For more information, see https://docs.paperspace.com/machines. Get a machine event from a team. ### Usage - -``` - machine-event get [arguments] [flags] ``` +machine-event get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2049,12 +2097,11 @@ Get a machine event from a team. Show help for a machine-event command ### Usage - -``` - machine-event help [command] - machine-event help [arguments] [flags] ``` +machine-event help [command] machine-event help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2073,15 +2120,16 @@ List machine-event commands Example: ``` -$ machine-event help commands commands -``` -### Usage +$ machine-event help commands commands ``` - machine-event help commands [flags] +### Usage ``` +machine-event help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2100,15 +2148,16 @@ List machine events in your team. Pick a subset of fields to display: ``` -pspace machine-event list -F name -F dtModified -``` -### Usage +pspace machine-event list -F name -F dtModified ``` - machine-event list [flags] +### Usage ``` +machine-event list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2135,12 +2184,11 @@ Manage your Paperspace models. For more information, see https://docs.paperspace.com/deploying/models. ### Usage - -``` - model [command] - model [flags] ``` +model [command] model [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2163,11 +2211,11 @@ Create a new model. This command will prompt you for a name if you don't provide one. ### Usage - -``` - model create [flags] ``` +model create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2190,11 +2238,11 @@ provide one. Delete a model from a team. ### Usage - -``` - model delete [arguments] [flags] ``` +model delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2212,11 +2260,11 @@ Delete a model from a team. Get a model from a team. ### Usage - -``` - model get [arguments] [flags] ``` +model get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2234,12 +2282,11 @@ Get a model from a team. Show help for a model command ### Usage - -``` - model help [command] - model help [arguments] [flags] ``` +model help [command] model help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2258,15 +2305,16 @@ List model commands Example: ``` -$ model help commands commands -``` -### Usage +$ model help commands commands ``` - model help commands [flags] +### Usage ``` +model help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2285,15 +2333,16 @@ List models in your team. Pick a subset of fields to display: ``` -pspace model list -F name -F dtModified -``` -### Usage +pspace model list -F name -F dtModified ``` - model list [flags] +### Usage ``` +model list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2319,12 +2368,11 @@ you can use to create a new machine. For more information, see https://docs.paperspace.com/compute/os-templates. ### Usage - -``` - os-template [command] - os-template [flags] ``` +os-template [command] os-template [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2343,12 +2391,11 @@ For more information, see https://docs.paperspace.com/compute/os-templates. Show help for a os-template command ### Usage - -``` - os-template help [command] - os-template help [arguments] [flags] ``` +os-template help [command] os-template help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2367,15 +2414,16 @@ List os-template commands Example: ``` -$ os-template help commands commands -``` -### Usage +$ os-template help commands commands ``` - os-template help commands [flags] +### Usage ``` +os-template help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2394,15 +2442,16 @@ List OS templates. Pick a subset of fields to display: ``` -pspace os-template list -F name -``` -### Usage +pspace os-template list -F name ``` - os-template list [flags] +### Usage ``` +os-template list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2430,12 +2479,11 @@ and direct connections to your on-premise network. For more information, see https://docs.paperspace.com/networking/private-networks. ### Usage - -``` - private-network [command] - private-network [flags] ``` +private-network [command] private-network [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2457,11 +2505,11 @@ For more information, see https://docs.paperspace.com/networking/private-network Create a private network. ### Usage - -``` - private-network create [flags] ``` +private-network create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2481,11 +2529,11 @@ Create a private network. Delete a private network from a team. ### Usage - -``` - private-network delete [arguments] [flags] ``` +private-network delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2503,11 +2551,11 @@ Delete a private network from a team. Get a private network from a team. ### Usage - -``` - private-network get [arguments] [flags] ``` +private-network get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2525,12 +2573,11 @@ Get a private network from a team. Show help for a private-network command ### Usage - -``` - private-network help [command] - private-network help [arguments] [flags] ``` +private-network help [command] private-network help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2549,15 +2596,16 @@ List private-network commands Example: ``` -$ private-network help commands commands -``` -### Usage +$ private-network help commands commands ``` - private-network help commands [flags] +### Usage ``` +private-network help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2576,15 +2624,16 @@ List private networks in your team. Pick a subset of fields to display: ``` -pspace private-network list -F name -F dtModified -``` -### Usage +pspace private-network list -F name -F dtModified ``` - private-network list [flags] +### Usage ``` +private-network list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2609,12 +2658,11 @@ pspace private-network list -F name -F dtModified Manage your Paperspace projects. ### Usage - -``` - project [command] - project [flags] ``` +project [command] project [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2639,11 +2687,11 @@ Create a new project. This command will prompt you for a name if you don't provide one. ### Usage - -``` - project create [arguments] [flags] ``` +project create [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2662,11 +2710,11 @@ Delete a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. ### Usage - -``` - project delete [arguments] [flags] ``` +project delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2685,11 +2733,11 @@ Get a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. ### Usage - -``` - project get [arguments] [flags] ``` +project get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2707,12 +2755,11 @@ prompt you for one based on the projects you have access to. Show help for a project command ### Usage - -``` - project help [command] - project help [arguments] [flags] ``` +project help [command] project help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2731,15 +2778,16 @@ List project commands Example: ``` -$ project help commands commands -``` -### Usage +$ project help commands commands ``` - project help commands [flags] +### Usage ``` +project help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2760,25 +2808,28 @@ when communicating with the Paperspace API. Link a project to the current directory. ``` + $ pspace link -``` +``` Link a project to a different directory. ``` + $ pspace link --cwd ../my-app -``` -Link a project and specify a project ID. ``` -$ pspace link pzwf2g05ubegj +Link a project and specify a project ID. ``` -### Usage +$ pspace link pzwf2g05ubegj ``` - project link [arguments] [flags] +### Usage ``` +project link [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2797,15 +2848,16 @@ List projects in your team. Pick a subset of fields to display: ``` -pspace project list -F id -F name -F dtCreated -``` -### Usage +pspace project list -F id -F name -F dtCreated ``` - project list [flags] +### Usage ``` +project list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2829,15 +2881,16 @@ Update an existing project. Example: ``` -pspace project update psukfyemho7 --name my-cool-project -``` -### Usage +pspace project update psukfyemho7 --name my-cool-project ``` - pspace project update [flags] +### Usage ``` +pspace project update [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2858,12 +2911,11 @@ Manage your public IPs. Public IP addresses allow your compute machines to be re For more information, see https://docs.paperspace.com/networking/public-ips. ### Usage - -``` - public-ip [command] - public-ip [flags] ``` +public-ip [command] public-ip [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2885,11 +2937,11 @@ For more information, see https://docs.paperspace.com/networking/public-ips. Assign a public IP to a machine. ### Usage - -``` - public-ip assign [arguments] [flags] ``` +public-ip assign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2908,11 +2960,11 @@ Assign a public IP to a machine. Claim a public IP for a team. ### Usage - -``` - public-ip claim [flags] ``` +public-ip claim [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2931,12 +2983,11 @@ Claim a public IP for a team. Show help for a public-ip command ### Usage - -``` - public-ip help [command] - public-ip help [arguments] [flags] ``` +public-ip help [command] public-ip help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2955,15 +3006,16 @@ List public-ip commands Example: ``` -$ public-ip help commands commands -``` -### Usage +$ public-ip help commands commands ``` - public-ip help commands [flags] +### Usage ``` +public-ip help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2982,15 +3034,16 @@ List public IPs in your team or project. Pick a subset of fields to display: ``` -pspace public-ip list -F name -F dtModified -``` -### Usage +pspace public-ip list -F name -F dtModified ``` - public-ip list [flags] +### Usage ``` +public-ip list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3013,12 +3066,12 @@ pspace public-ip list -F name -F dtModified Release a public IP from a team. This will unassign it from its assigned machine, if any. -### Usage +### Usage +``` + +public-ip release [arguments] [flags] ``` - public-ip release [arguments] [flags] -``` - ### Flags | Name | Aliases | Description | Required | @@ -3046,12 +3099,11 @@ Secrets can be created at the following levels: For more information, see https://docs.paperspace.com/secrets. ### Usage - -``` - secret [command] - secret [flags] ``` +secret [command] secret [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3074,11 +3126,11 @@ For more information, see https://docs.paperspace.com/secrets. Create a secret in a project or team. ### Usage - -``` - secret create [arguments] [arguments] [flags] ``` +secret create [arguments] [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3103,11 +3155,11 @@ a project. | false | Delete a secret from a project or team. ### Usage - -``` - secret delete [arguments] [flags] ``` +secret delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3132,11 +3184,11 @@ a project. | false | Get a secret from a project or team. ### Usage - -``` - secret get [arguments] [flags] ``` +secret get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3162,12 +3214,11 @@ a project. | false | Show help for a secret command ### Usage - -``` - secret help [command] - secret help [arguments] [flags] ``` +secret help [command] secret help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3186,15 +3237,16 @@ List secret commands Example: ``` -$ secret help commands commands -``` -### Usage +$ secret help commands commands ``` - secret help commands [flags] +### Usage ``` +secret help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3213,15 +3265,16 @@ List secrets in your team or project. Pick a subset of fields to display: ``` -pspace secret list -F name -F dtModified -``` -### Usage +pspace secret list -F name -F dtModified ``` - secret list [flags] +### Usage ``` +secret list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3252,11 +3305,11 @@ a project. | false | Update a secret in a project or team. ### Usage - -``` - secret update [arguments] [arguments] [flags] ``` +secret update [arguments] [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3285,12 +3338,11 @@ in the same private network. For more information, see https://docs.paperspace.com/storage/shared-drives. ### Usage - -``` - shared-drive [command] - shared-drive [flags] ``` +shared-drive [command] shared-drive [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3312,11 +3364,11 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. Create a shared drive. ### Usage - -``` - shared-drive create [flags] ``` +shared-drive create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3338,11 +3390,11 @@ Create a shared drive. Delete a shared drive from a team. ### Usage - -``` - shared-drive delete [arguments] [flags] ``` +shared-drive delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3360,11 +3412,11 @@ Delete a shared drive from a team. Get a shared drive from a team. ### Usage - -``` - shared-drive get [arguments] [flags] ``` +shared-drive get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3382,12 +3434,11 @@ Get a shared drive from a team. Show help for a shared-drive command ### Usage - -``` - shared-drive help [command] - shared-drive help [arguments] [flags] ``` +shared-drive help [command] shared-drive help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3406,15 +3457,16 @@ List shared-drive commands Example: ``` -$ shared-drive help commands commands -``` -### Usage +$ shared-drive help commands commands ``` - shared-drive help commands [flags] +### Usage ``` +shared-drive help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3433,15 +3485,16 @@ List shared drives in your team or project. Pick a subset of fields to display: ``` -pspace shared-drive list -F name -F dtModified -``` -### Usage +pspace shared-drive list -F name -F dtModified ``` - shared-drive list [flags] +### Usage ``` +shared-drive list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3466,11 +3519,11 @@ pspace shared-drive list -F name -F dtModified This command opens the Paperspace signup page in your browser. ### Usage - -``` - signup [flags] ``` +signup [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3491,12 +3544,11 @@ before taking any action that could affect the usability of the machine or its n For more information, see https://docs.paperspace.com/storage/snapshots. ### Usage - -``` - snapshot [command] - snapshot [flags] ``` +snapshot [command] snapshot [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3518,11 +3570,11 @@ For more information, see https://docs.paperspace.com/storage/snapshots. Create a snapshot from a machine. ### Usage - -``` - snapshot create [flags] ``` +snapshot create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3542,11 +3594,11 @@ Create a snapshot from a machine. Delete a snapshot from a team. ### Usage - -``` - snapshot delete [arguments] [flags] ``` +snapshot delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3564,12 +3616,11 @@ Delete a snapshot from a team. Show help for a snapshot command ### Usage - -``` - snapshot help [command] - snapshot help [arguments] [flags] ``` +snapshot help [command] snapshot help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3588,15 +3639,16 @@ List snapshot commands Example: ``` -$ snapshot help commands commands -``` -### Usage +$ snapshot help commands commands ``` - snapshot help commands [flags] +### Usage ``` +snapshot help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3615,15 +3667,16 @@ List snapshots in your team. Pick a subset of fields to display: ``` -pspace snapshot list -F name -F dtModified -``` -### Usage +pspace snapshot list -F name -F dtModified ``` - snapshot list [flags] +### Usage ``` +snapshot list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3648,11 +3701,11 @@ will be returned. | false | Restore a machine to a snapshot. ### Usage - -``` - snapshot restore [arguments] [flags] ``` +snapshot restore [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3672,12 +3725,11 @@ Manage your startup scripts. Startup scripts allow you to configure a machine on first boot or on every boot. ### Usage - -``` - startup-script [command] - startup-script [flags] ``` +startup-script [command] startup-script [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3702,11 +3754,11 @@ on first boot or on every boot. Assign a startup script to a machine. ### Usage - -``` - startup-script assign [arguments] [flags] ``` +startup-script assign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3725,11 +3777,11 @@ Assign a startup script to a machine. Create a startup script. ### Usage - -``` - startup-script create [flags] ``` +startup-script create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3750,11 +3802,11 @@ Create a startup script. Delete a startup script from a team. ### Usage - -``` - startup-script delete [arguments] [flags] ``` +startup-script delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3772,11 +3824,11 @@ Delete a startup script from a team. Get a startup script from a team. ### Usage - -``` - startup-script get [arguments] [flags] ``` +startup-script get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3794,12 +3846,11 @@ Get a startup script from a team. Show help for a startup-script command ### Usage - -``` - startup-script help [command] - startup-script help [arguments] [flags] ``` +startup-script help [command] startup-script help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3818,15 +3869,16 @@ List startup-script commands Example: ``` -$ startup-script help commands commands -``` -### Usage +$ startup-script help commands commands ``` - startup-script help commands [flags] +### Usage ``` +startup-script help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3845,15 +3897,16 @@ List startup scripts in your team. Pick a subset of fields to display: ``` -pspace startup-script list -F name -F dtCreated -``` -### Usage +pspace startup-script list -F name -F dtCreated ``` - startup-script list [flags] +### Usage ``` +startup-script list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3877,11 +3930,11 @@ pspace startup-script list -F name -F dtCreated Unassign a startup script from a machine. ### Usage - -``` - startup-script unassign [arguments] [flags] ``` +startup-script unassign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3900,11 +3953,11 @@ Unassign a startup script from a machine. Update a startup script. ### Usage - -``` - startup-script update [arguments] [flags] ``` +startup-script update [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3928,12 +3981,11 @@ Manage your storage providers. For more information, see https://docs.paperspace.com/storage/storageProviders. ### Usage - -``` - storage-provider [command] - storage-provider [flags] ``` +storage-provider [command] storage-provider [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3956,12 +4008,11 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. Create a storage provider. ### Usage - -``` - storage-provider create [command] - storage-provider create [flags] ``` +storage-provider create [command] storage-provider create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3980,12 +4031,12 @@ Create a storage provider. Show help for a create command ### Usage - -``` - storage-provider create help [command] - storage-provider create help [arguments] [flags] ``` +storage-provider create help [command] storage-provider create help [arguments] +[flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4004,15 +4055,16 @@ List create commands Example: ``` -$ storage-provider create help commands commands -``` -### Usage +$ storage-provider create help commands commands ``` - storage-provider create help commands [flags] +### Usage ``` +storage-provider create help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4030,11 +4082,11 @@ $ storage-provider create help commands commands Create an S3 storage provider. ### Usage - -``` - storage-provider create s3 [flags] ``` +storage-provider create s3 [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4061,11 +4113,11 @@ Create an S3 storage provider. Delete a storage provider from a team. ### Usage - -``` - storage-provider delete [arguments] [flags] ``` +storage-provider delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4083,11 +4135,11 @@ Delete a storage provider from a team. Get a storage provider from a team. ### Usage - -``` - storage-provider get [arguments] [flags] ``` +storage-provider get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4105,12 +4157,11 @@ Get a storage provider from a team. Show help for a storage-provider command ### Usage - -``` - storage-provider help [command] - storage-provider help [arguments] [flags] ``` +storage-provider help [command] storage-provider help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4129,15 +4180,16 @@ List storage-provider commands Example: ``` -$ storage-provider help commands commands -``` -### Usage +$ storage-provider help commands commands ``` - storage-provider help commands [flags] +### Usage ``` +storage-provider help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4156,15 +4208,16 @@ List storage providers in your team or project. Pick a subset of fields to display: ``` -pspace storage provider list -F name -F dtModified -``` -### Usage +pspace storage provider list -F name -F dtModified ``` - storage-provider list [flags] +### Usage ``` +storage-provider list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4187,12 +4240,11 @@ pspace storage provider list -F name -F dtModified Update a storage provider. ### Usage - -``` - storage-provider update [command] - storage-provider update [flags] ``` +storage-provider update [command] storage-provider update [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4211,12 +4263,12 @@ Update a storage provider. Show help for a update command ### Usage - -``` - storage-provider update help [command] - storage-provider update help [arguments] [flags] ``` +storage-provider update help [command] storage-provider update help [arguments] +[flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4235,15 +4287,16 @@ List update commands Example: ``` -$ storage-provider update help commands commands -``` -### Usage +$ storage-provider update help commands commands ``` - storage-provider update help commands [flags] +### Usage ``` +storage-provider update help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4261,11 +4314,11 @@ $ storage-provider update help commands commands Update an S3 storage provider in a project or team. ### Usage - -``` - storage-provider update s3 [arguments] [flags] ``` +storage-provider update s3 [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4295,25 +4348,28 @@ config file paths will be tried. Deploy the app in the current directory. ``` + $ pspace up -``` +``` Deploy the app using a config file. ``` + $ pspace up -c paperspace.json -``` -Deploy an app in a different directory. ``` -$ pspace up --cwd ../my-app +Deploy an app in a different directory. ``` -### Usage +$ pspace up --cwd ../my-app ``` - up [flags] +### Usage ``` +up [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4349,21 +4405,23 @@ If you used a package manager like `brew` to install `pspace`, you should use that to upgrade in order to avoid potential permissions issues. For example, for `brew` you can upgrade by running: ``` + brew upgrade pspace -``` +``` If you installed `pspace` using the install script, you can upgrade by running: ``` -pspace upgrade -``` -### Usage +pspace upgrade ``` - upgrade [flags] +### Usage ``` +upgrade [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4380,11 +4438,11 @@ pspace upgrade Shows version information command, including version number and build date. ### Usage - -``` - version [flags] ``` +version [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4395,4 +4453,4 @@ Shows version information command, including version number and build date. | help | h | Show help for a command | false | ### Subcommands - +``` From bd4221b323350fa39055c08514161864645cac57 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Wed, 22 May 2024 11:41:17 -0400 Subject: [PATCH 04/10] fix --- .assets/pspace.json | 4 +- .assets/pspace.md | 4428 +---------------- .assets/pspace/autoscaling-group.md | 30 + .assets/pspace/autoscaling-group/create.md | 31 + .assets/pspace/autoscaling-group/delete.md | 22 + .assets/pspace/autoscaling-group/get.md | 22 + .assets/pspace/autoscaling-group/help.md | 23 + .../pspace/autoscaling-group/help/commands.md | 27 + .assets/pspace/autoscaling-group/list.md | 34 + .assets/pspace/autoscaling-group/update.md | 32 + .assets/pspace/completion.md | 27 + .assets/pspace/completion/bash.md | 43 + .assets/pspace/completion/fish.md | 34 + .assets/pspace/completion/help.md | 23 + .assets/pspace/completion/help/commands.md | 27 + .assets/pspace/completion/zsh.md | 48 + .assets/pspace/config.md | 35 + .assets/pspace/config/delete.md | 21 + .assets/pspace/config/get.md | 27 + .assets/pspace/config/help.md | 23 + .assets/pspace/config/help/commands.md | 27 + .assets/pspace/config/set.md | 21 + .assets/pspace/console.md | 21 + .assets/pspace/custom-template.md | 31 + .assets/pspace/custom-template/create.md | 24 + .assets/pspace/custom-template/delete.md | 22 + .assets/pspace/custom-template/get.md | 22 + .assets/pspace/custom-template/help.md | 23 + .../pspace/custom-template/help/commands.md | 27 + .assets/pspace/custom-template/list.md | 35 + .assets/pspace/dataset.md | 31 + .assets/pspace/dataset/create.md | 26 + .assets/pspace/dataset/delete.md | 22 + .assets/pspace/dataset/get.md | 22 + .assets/pspace/dataset/help.md | 23 + .assets/pspace/dataset/help/commands.md | 27 + .assets/pspace/dataset/list.md | 32 + .assets/pspace/dataset/update.md | 24 + .assets/pspace/dataset/versions.md | 30 + .assets/pspace/dataset/versions/create.md | 24 + .assets/pspace/dataset/versions/delete.md | 23 + .assets/pspace/dataset/versions/get.md | 23 + .assets/pspace/dataset/versions/help.md | 23 + .../pspace/dataset/versions/help/commands.md | 27 + .assets/pspace/dataset/versions/list.md | 32 + .assets/pspace/dataset/versions/update.md | 24 + .assets/pspace/deployment.md | 27 + .assets/pspace/deployment/delete.md | 26 + .assets/pspace/deployment/get.md | 32 + .assets/pspace/deployment/help.md | 23 + .assets/pspace/deployment/help/commands.md | 27 + .assets/pspace/deployment/list.md | 32 + .assets/pspace/deployment/up.md | 59 + .assets/pspace/docs.md | 26 + .assets/pspace/help.md | 23 + .assets/pspace/help/commands.md | 27 + .assets/pspace/init.md | 77 + .assets/pspace/login.md | 21 + .assets/pspace/logout.md | 22 + .assets/pspace/machine-event.md | 29 + .assets/pspace/machine-event/get.md | 22 + .assets/pspace/machine-event/help.md | 23 + .assets/pspace/machine-event/help/commands.md | 27 + .assets/pspace/machine-event/list.md | 34 + .assets/pspace/machine.md | 33 + .assets/pspace/machine/create.md | 43 + .assets/pspace/machine/delete.md | 22 + .assets/pspace/machine/get.md | 22 + .assets/pspace/machine/help.md | 23 + .assets/pspace/machine/help/commands.md | 27 + .assets/pspace/machine/list.md | 36 + .assets/pspace/machine/restart.md | 22 + .assets/pspace/machine/start.md | 22 + .assets/pspace/machine/stop.md | 22 + .assets/pspace/machine/update.md | 36 + .assets/pspace/model.md | 29 + .assets/pspace/model/create.md | 28 + .assets/pspace/model/delete.md | 22 + .assets/pspace/model/get.md | 22 + .assets/pspace/model/help.md | 23 + .assets/pspace/model/help/commands.md | 27 + .assets/pspace/model/list.md | 32 + .assets/pspace/os-template.md | 27 + .assets/pspace/os-template/help.md | 23 + .assets/pspace/os-template/help/commands.md | 27 + .assets/pspace/os-template/list.md | 33 + .assets/pspace/private-network.md | 31 + .assets/pspace/private-network/create.md | 24 + .assets/pspace/private-network/delete.md | 22 + .assets/pspace/private-network/get.md | 22 + .assets/pspace/private-network/help.md | 23 + .../pspace/private-network/help/commands.md | 27 + .assets/pspace/private-network/list.md | 34 + .assets/pspace/project.md | 29 + .assets/pspace/project/create.md | 23 + .assets/pspace/project/delete.md | 23 + .assets/pspace/project/get.md | 23 + .assets/pspace/project/help.md | 23 + .assets/pspace/project/help/commands.md | 27 + .assets/pspace/project/link.md | 39 + .assets/pspace/project/list.md | 32 + .assets/pspace/project/update.md | 28 + .assets/pspace/public-ip.md | 29 + .assets/pspace/public-ip/assign.md | 23 + .assets/pspace/public-ip/claim.md | 23 + .assets/pspace/public-ip/help.md | 23 + .assets/pspace/public-ip/help/commands.md | 27 + .assets/pspace/public-ip/list.md | 33 + .assets/pspace/public-ip/release.md | 22 + .assets/pspace/secret.md | 38 + .assets/pspace/secret/create.md | 29 + .assets/pspace/secret/delete.md | 29 + .assets/pspace/secret/get.md | 30 + .assets/pspace/secret/help.md | 23 + .assets/pspace/secret/help/commands.md | 27 + .assets/pspace/secret/list.md | 40 + .assets/pspace/secret/update.md | 29 + .assets/pspace/shared-drive.md | 31 + .assets/pspace/shared-drive/create.md | 26 + .assets/pspace/shared-drive/delete.md | 22 + .assets/pspace/shared-drive/get.md | 22 + .assets/pspace/shared-drive/help.md | 23 + .assets/pspace/shared-drive/help/commands.md | 27 + .assets/pspace/shared-drive/list.md | 34 + .assets/pspace/signup.md | 21 + .assets/pspace/snapshot.md | 31 + .assets/pspace/snapshot/create.md | 24 + .assets/pspace/snapshot/delete.md | 22 + .assets/pspace/snapshot/help.md | 23 + .assets/pspace/snapshot/help/commands.md | 27 + .assets/pspace/snapshot/list.md | 34 + .assets/pspace/snapshot/restore.md | 23 + .assets/pspace/startup-script.md | 31 + .assets/pspace/startup-script/assign.md | 23 + .assets/pspace/startup-script/create.md | 25 + .assets/pspace/startup-script/delete.md | 22 + .assets/pspace/startup-script/get.md | 22 + .assets/pspace/startup-script/help.md | 23 + .../pspace/startup-script/help/commands.md | 27 + .assets/pspace/startup-script/list.md | 33 + .assets/pspace/startup-script/unassign.md | 23 + .assets/pspace/startup-script/update.md | 26 + .assets/pspace/storage-provider.md | 30 + .assets/pspace/storage-provider/create.md | 24 + .../pspace/storage-provider/create/help.md | 23 + .../storage-provider/create/help/commands.md | 27 + .assets/pspace/storage-provider/create/s3.md | 31 + .assets/pspace/storage-provider/delete.md | 22 + .assets/pspace/storage-provider/get.md | 22 + .assets/pspace/storage-provider/help.md | 23 + .../pspace/storage-provider/help/commands.md | 27 + .assets/pspace/storage-provider/list.md | 32 + .assets/pspace/storage-provider/update.md | 24 + .../pspace/storage-provider/update/help.md | 23 + .../storage-provider/update/help/commands.md | 27 + .assets/pspace/storage-provider/update/s3.md | 31 + .assets/pspace/up.md | 54 + .assets/pspace/upgrade.md | 34 + .assets/pspace/version.md | 21 + .scripts/generate-docs.ts | 33 +- .scripts/zcli-json.ts | 228 + deno.lock | 201 +- 162 files changed, 4595 insertions(+), 4627 deletions(-) create mode 100644 .assets/pspace/autoscaling-group.md create mode 100644 .assets/pspace/autoscaling-group/create.md create mode 100644 .assets/pspace/autoscaling-group/delete.md create mode 100644 .assets/pspace/autoscaling-group/get.md create mode 100644 .assets/pspace/autoscaling-group/help.md create mode 100644 .assets/pspace/autoscaling-group/help/commands.md create mode 100644 .assets/pspace/autoscaling-group/list.md create mode 100644 .assets/pspace/autoscaling-group/update.md create mode 100644 .assets/pspace/completion.md create mode 100644 .assets/pspace/completion/bash.md create mode 100644 .assets/pspace/completion/fish.md create mode 100644 .assets/pspace/completion/help.md create mode 100644 .assets/pspace/completion/help/commands.md create mode 100644 .assets/pspace/completion/zsh.md create mode 100644 .assets/pspace/config.md create mode 100644 .assets/pspace/config/delete.md create mode 100644 .assets/pspace/config/get.md create mode 100644 .assets/pspace/config/help.md create mode 100644 .assets/pspace/config/help/commands.md create mode 100644 .assets/pspace/config/set.md create mode 100644 .assets/pspace/console.md create mode 100644 .assets/pspace/custom-template.md create mode 100644 .assets/pspace/custom-template/create.md create mode 100644 .assets/pspace/custom-template/delete.md create mode 100644 .assets/pspace/custom-template/get.md create mode 100644 .assets/pspace/custom-template/help.md create mode 100644 .assets/pspace/custom-template/help/commands.md create mode 100644 .assets/pspace/custom-template/list.md create mode 100644 .assets/pspace/dataset.md create mode 100644 .assets/pspace/dataset/create.md create mode 100644 .assets/pspace/dataset/delete.md create mode 100644 .assets/pspace/dataset/get.md create mode 100644 .assets/pspace/dataset/help.md create mode 100644 .assets/pspace/dataset/help/commands.md create mode 100644 .assets/pspace/dataset/list.md create mode 100644 .assets/pspace/dataset/update.md create mode 100644 .assets/pspace/dataset/versions.md create mode 100644 .assets/pspace/dataset/versions/create.md create mode 100644 .assets/pspace/dataset/versions/delete.md create mode 100644 .assets/pspace/dataset/versions/get.md create mode 100644 .assets/pspace/dataset/versions/help.md create mode 100644 .assets/pspace/dataset/versions/help/commands.md create mode 100644 .assets/pspace/dataset/versions/list.md create mode 100644 .assets/pspace/dataset/versions/update.md create mode 100644 .assets/pspace/deployment.md create mode 100644 .assets/pspace/deployment/delete.md create mode 100644 .assets/pspace/deployment/get.md create mode 100644 .assets/pspace/deployment/help.md create mode 100644 .assets/pspace/deployment/help/commands.md create mode 100644 .assets/pspace/deployment/list.md create mode 100644 .assets/pspace/deployment/up.md create mode 100644 .assets/pspace/docs.md create mode 100644 .assets/pspace/help.md create mode 100644 .assets/pspace/help/commands.md create mode 100644 .assets/pspace/init.md create mode 100644 .assets/pspace/login.md create mode 100644 .assets/pspace/logout.md create mode 100644 .assets/pspace/machine-event.md create mode 100644 .assets/pspace/machine-event/get.md create mode 100644 .assets/pspace/machine-event/help.md create mode 100644 .assets/pspace/machine-event/help/commands.md create mode 100644 .assets/pspace/machine-event/list.md create mode 100644 .assets/pspace/machine.md create mode 100644 .assets/pspace/machine/create.md create mode 100644 .assets/pspace/machine/delete.md create mode 100644 .assets/pspace/machine/get.md create mode 100644 .assets/pspace/machine/help.md create mode 100644 .assets/pspace/machine/help/commands.md create mode 100644 .assets/pspace/machine/list.md create mode 100644 .assets/pspace/machine/restart.md create mode 100644 .assets/pspace/machine/start.md create mode 100644 .assets/pspace/machine/stop.md create mode 100644 .assets/pspace/machine/update.md create mode 100644 .assets/pspace/model.md create mode 100644 .assets/pspace/model/create.md create mode 100644 .assets/pspace/model/delete.md create mode 100644 .assets/pspace/model/get.md create mode 100644 .assets/pspace/model/help.md create mode 100644 .assets/pspace/model/help/commands.md create mode 100644 .assets/pspace/model/list.md create mode 100644 .assets/pspace/os-template.md create mode 100644 .assets/pspace/os-template/help.md create mode 100644 .assets/pspace/os-template/help/commands.md create mode 100644 .assets/pspace/os-template/list.md create mode 100644 .assets/pspace/private-network.md create mode 100644 .assets/pspace/private-network/create.md create mode 100644 .assets/pspace/private-network/delete.md create mode 100644 .assets/pspace/private-network/get.md create mode 100644 .assets/pspace/private-network/help.md create mode 100644 .assets/pspace/private-network/help/commands.md create mode 100644 .assets/pspace/private-network/list.md create mode 100644 .assets/pspace/project.md create mode 100644 .assets/pspace/project/create.md create mode 100644 .assets/pspace/project/delete.md create mode 100644 .assets/pspace/project/get.md create mode 100644 .assets/pspace/project/help.md create mode 100644 .assets/pspace/project/help/commands.md create mode 100644 .assets/pspace/project/link.md create mode 100644 .assets/pspace/project/list.md create mode 100644 .assets/pspace/project/update.md create mode 100644 .assets/pspace/public-ip.md create mode 100644 .assets/pspace/public-ip/assign.md create mode 100644 .assets/pspace/public-ip/claim.md create mode 100644 .assets/pspace/public-ip/help.md create mode 100644 .assets/pspace/public-ip/help/commands.md create mode 100644 .assets/pspace/public-ip/list.md create mode 100644 .assets/pspace/public-ip/release.md create mode 100644 .assets/pspace/secret.md create mode 100644 .assets/pspace/secret/create.md create mode 100644 .assets/pspace/secret/delete.md create mode 100644 .assets/pspace/secret/get.md create mode 100644 .assets/pspace/secret/help.md create mode 100644 .assets/pspace/secret/help/commands.md create mode 100644 .assets/pspace/secret/list.md create mode 100644 .assets/pspace/secret/update.md create mode 100644 .assets/pspace/shared-drive.md create mode 100644 .assets/pspace/shared-drive/create.md create mode 100644 .assets/pspace/shared-drive/delete.md create mode 100644 .assets/pspace/shared-drive/get.md create mode 100644 .assets/pspace/shared-drive/help.md create mode 100644 .assets/pspace/shared-drive/help/commands.md create mode 100644 .assets/pspace/shared-drive/list.md create mode 100644 .assets/pspace/signup.md create mode 100644 .assets/pspace/snapshot.md create mode 100644 .assets/pspace/snapshot/create.md create mode 100644 .assets/pspace/snapshot/delete.md create mode 100644 .assets/pspace/snapshot/help.md create mode 100644 .assets/pspace/snapshot/help/commands.md create mode 100644 .assets/pspace/snapshot/list.md create mode 100644 .assets/pspace/snapshot/restore.md create mode 100644 .assets/pspace/startup-script.md create mode 100644 .assets/pspace/startup-script/assign.md create mode 100644 .assets/pspace/startup-script/create.md create mode 100644 .assets/pspace/startup-script/delete.md create mode 100644 .assets/pspace/startup-script/get.md create mode 100644 .assets/pspace/startup-script/help.md create mode 100644 .assets/pspace/startup-script/help/commands.md create mode 100644 .assets/pspace/startup-script/list.md create mode 100644 .assets/pspace/startup-script/unassign.md create mode 100644 .assets/pspace/startup-script/update.md create mode 100644 .assets/pspace/storage-provider.md create mode 100644 .assets/pspace/storage-provider/create.md create mode 100644 .assets/pspace/storage-provider/create/help.md create mode 100644 .assets/pspace/storage-provider/create/help/commands.md create mode 100644 .assets/pspace/storage-provider/create/s3.md create mode 100644 .assets/pspace/storage-provider/delete.md create mode 100644 .assets/pspace/storage-provider/get.md create mode 100644 .assets/pspace/storage-provider/help.md create mode 100644 .assets/pspace/storage-provider/help/commands.md create mode 100644 .assets/pspace/storage-provider/list.md create mode 100644 .assets/pspace/storage-provider/update.md create mode 100644 .assets/pspace/storage-provider/update/help.md create mode 100644 .assets/pspace/storage-provider/update/help/commands.md create mode 100644 .assets/pspace/storage-provider/update/s3.md create mode 100644 .assets/pspace/up.md create mode 100644 .assets/pspace/upgrade.md create mode 100644 .assets/pspace/version.md create mode 100644 .scripts/zcli-json.ts diff --git a/.assets/pspace.json b/.assets/pspace.json index c7f485f..923da56 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-14T05:02:13.799Z", + "buildDate": "2024-05-22T15:40:50.043Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, @@ -19207,4 +19207,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/.assets/pspace.md b/.assets/pspace.md index 24f8766..7028821 100644 --- a/.assets/pspace.md +++ b/.assets/pspace.md @@ -1,42 +1,30 @@ -# Paperspace CLI +# pspace -A CLI for using the Paperspace API. +A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. -- Deploy an ML app with the `deployment` command -- View a deployed app with the `deployment open` command -- Check the status of a deployment with the `deployment status` command +* Deploy an ML app with the `deployment` command +* View a deployed app with the `deployment open` command +* Check the status of a deployment with the `deployment status` command Read the full documentation at: https://docs.paperspace.com/ -## pspace - -A CLI for using the Paperspace API. - -It allows you to authenticate, launch deployments, do logging, and more. - -- Deploy an ML app with the `deployment` command -- View a deployed app with the `deployment open` command -- Check the status of a deployment with the `deployment status` command - -Read the full documentation at: https://docs.paperspace.com/ - -### Usage +## Usage ``` -pspace [command] -pspace [flags] + pspace [command] + pspace [flags] ``` -### Flags +## Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -68,4389 +56,3 @@ pspace [flags] - [up](#up) - [upgrade](#upgrade) - [version](#version) - -## pspace autoscaling-group - -Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes -cluster-autoscaler to automatically scale your cluster. You can also autoscaling -groups as a primitive for your own autoscaler. - -### Usage - -``` -autoscaling-group [command] -autoscaling-group [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace autoscaling-group create - -Create an autoscaling group. - -### Usage - -``` -autoscaling-group create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group delete - -Delete an autoscaling group from a team. - -### Usage - -``` -autoscaling-group delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group get - -Get an autoscaling group from a team. - -### Usage - -``` -autoscaling-group get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group help - -Show help for a autoscaling-group command - -### Usage - -``` -autoscaling-group help [command] -autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace autoscaling-group help commands - -List autoscaling-group commands - -Example: - -``` -$ autoscaling-group help commands commands -``` - -### Usage - -``` -autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace autoscaling-group list - -List autoscaling groups in your team. - -Pick a subset of fields to display: - -``` -pspace autoscaling-group list -F name -F dtCreated -``` - -### Usage - -``` -autoscaling-group list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------ | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group update - -Update an autoscaling group. - -### Usage - -``` -autoscaling-group update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion - -Generate an autocompletion script for pspace in the specified shell. See each -sub-command's help for details on how to use the generated script. - -### Usage - -``` -completion [command] -completion [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [bash](#bash) -- [fish](#fish) -- [help](#help) -- [zsh](#zsh) - -## pspace completion bash - -Generate the autocompletion script for the bash shell. - -This script depends on the `bash-completion` package. If it is not installed -already, you can install it via your OS's package manager. - -To load completions in your current shell session: - -``` -$ source <(completion bash bash) -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion bash bash > /etc/bash_completion.d/pspace -``` - -macOS: - -``` -$ completion bash bash > /usr/local/etc/bash_completion.d/pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion bash [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - -``` -$ completion fish fish | source -``` - -To load completions for every new session, execute once: - -``` -$ completion fish fish > ~/.config/fish/completions/pspace.fish -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion fish [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion help - -Show help for a completion command - -### Usage - -``` -completion help [command] -completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace completion help commands - -List completion commands - -Example: - -``` -$ completion help commands commands -``` - -### Usage - -``` -completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace completion zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need to -enable it. You can execute the following once: - -``` -$ echo "autoload -U compinit; compinit" >> ~/.zshrc -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion zsh zsh > "${fpath[1]}/_pspace" -``` - -macOS: - -``` -$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace -``` - -Oh My Zsh: - -``` -$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion zsh [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config - -This command manages your Paperspace configuration. You can use it to set, get, -and delete configuration values. Running this command without any subcommands -will print your current configuration. - -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. - -For example, to set the current team, run: - -``` -pspace config set team "my-team" -``` - -### Usage - -``` -config [command] -config [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [set](#set) - -## pspace config delete - -Delete a configuration value. - -### Usage - -``` -config delete [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config get - -This command gets a configuration value. You can pass a key to get a specific -value, or you can pass no arguments to get all configuration values. - -For example, to get the current team run: - -``` -pspace config get team -``` - -### Usage - -``` -config get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config help - -Show help for a config command - -### Usage - -``` -config help [command] -config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace config help commands - -List config commands - -Example: - -``` -$ config help commands commands -``` - -### Usage - -``` -config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace config set - -Set a configuration value. - -### Usage - -``` -config set [arguments] [arguments...] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace console - -This command opens the Paperspace web console in your browser. - -### Usage - -``` -console [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template - -Manage your custom templates. Custom templates are a backup of your machine's -disk. They can be used to create additional machines. You can use them to -prepopulate a machine with your desired software stack. - -For more information, see https://docs.paperspace.com/compute/custom-templates. - -### Usage - -``` -custom-template [command] -custom-template [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace custom-template create - -Create a custom template from a machine. - -### Usage - -``` -custom-template create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template delete - -Delete a custom template from a team. - -### Usage - -``` -custom-template delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template get - -Get a custom template from a team. - -### Usage - -``` -custom-template get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template help - -Show help for a custom-template command - -### Usage - -``` -custom-template help [command] -custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace custom-template help commands - -List custom-template commands - -Example: - -``` -$ custom-template help commands commands -``` - -### Usage - -``` -custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace custom-template list - -List custom templates in your team. - -Pick a subset of fields to display: - -``` -pspace custom-template list -F name -F dtModified -``` - -### Usage - -``` -custom-template list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset - -Manage your datasets. - -For more information, see https://docs.paperspace.com/storage/datasets. - -### Usage - -``` -dataset [command] -dataset [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -- [versions](#versions) - -## pspace dataset create - -Create a dataset. - -### Usage - -``` -dataset create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset delete - -Delete a dataset from a team. - -### Usage - -``` -dataset delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset get - -Get a dataset from a team. - -### Usage - -``` -dataset get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset help - -Show help for a dataset command - -### Usage - -``` -dataset help [command] -dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace dataset help commands - -List dataset commands - -Example: - -``` -$ dataset help commands commands -``` - -### Usage - -``` -dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace dataset list - -List datasets in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset list -F name -F dtModified -``` - -### Usage - -``` -dataset list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset update - -Update a dataset in a project or team. - -### Usage - -``` -dataset update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions - -Manage your dataset versions. - -For more information, see https://docs.paperspace.com/storage/datasetVersions. - -### Usage - -``` -dataset versions [command] -dataset versions [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace dataset versions create - -Create a dataset version. This command will prompt you for an ID if you don't -provide one. - -### Usage - -``` -dataset versions create [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions delete - -Delete a dataset version from a team. This command will prompt you for an ID if -you don't provide one. - -### Usage - -``` -dataset versions delete [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions get - -Get a dataset version from a team. This command will prompt you for an ID if you -don't provide one. - -### Usage - -``` -dataset versions get [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions help - -Show help for a versions command - -### Usage - -``` -dataset versions help [command] -dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace dataset versions help commands - -List versions commands - -Example: - -``` -$ dataset versions help commands commands -``` - -### Usage - -``` -dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace dataset versions list - -List dataset versions in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset versions list -F name -F dtModified -``` - -### Usage - -``` -dataset versions list [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions update - -Update a dataset version in a project or team. - -### Usage - -``` -dataset versions update [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment - -Effortlessly deploy ML apps to Paperspace. - -### Usage - -``` -deployment [command] -deployment [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [up](#up) - -## pspace deployment delete - -Delete a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 -``` - -### Usage - -``` -deployment delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment get - -Get a deployment by its ID. If you don't provide an ID, this command will prompt -you for one based on the deployments you have access to. - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -``` - -Pick a subset of fields to display: - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name -``` - -### Usage - -``` -deployment get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment help - -Show help for a deployment command - -### Usage - -``` -deployment help [command] -deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace deployment help commands - -List deployment commands - -Example: - -``` -$ deployment help commands commands -``` - -### Usage - -``` -deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace deployment list - -List deployments in your team. - -Pick a subset of fields to display: - -``` -pspace deployment list -F id -F name -``` - -### Usage - -``` -deployment list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment up - -This will create a new deployment for your app or update it if it already -exists. You can optionally specify a path to a config file. If no config file is -specified, the default config file paths will be tried. - -Create a new deployment for the app in the current directory. - -``` -$ pspace deployment create -``` - -Create a new deployment using a config file. - -``` -$ pspace deployment create -c paperspace.json -``` - -Create a new deployment for an app in a different directory. - -``` -$ pspace deployment create --cwd ../my-app -``` - -Create a new deployment for an app in a specific project. - -``` -$ pspace deployment create --project-id 1234 -``` - -### Usage - -``` -deployment up [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------ | ------- | ----------------------------------------------------------------------- | -------- | -| config | c | The path to the config file. Defaults to our default config file paths. | | - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to - deploy to. | false | | cwd | | The directory to deploy the app from. Defaults - to the current directory. | false | | log-level | l | Enable debug logging. | - false | | json | j | Output JSON | false | | api-key | | A Paperspace public - API Key used for authenticating requests | false | | help | h | Show help for - a command | false | - -### Subcommands - -## pspace docs - -This command opens the Paperspace documentation in your browser. You can -optionally pass an argument that will take you to a specific docs page. - -Valid pages are: - -- `d`, `deployment` - -### Usage - -``` -docs [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace help - -Show help for a pspace command - -### Usage - -``` -help [command] -help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace help commands - -List pspace commands - -Example: - -``` -$ help commands commands -``` - -### Usage - -``` -help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace init - -Create a new Paperspace app. This will create a new directory with a default app -structure. You can optionally specify a name for the app and a template to use. -If no template is specified, the default template will be used. - -Create a new app in the current directory. - -``` -$ pspace init -``` - -Create a new app named "my-app" relative to the current directory. - -``` -$ pspace init my-app -``` - -Create a new app named "my-app" relative to the current directory using a -template from the Paperspace GitHub organization. - -``` -$ pspace init my-app -t Paperspace/gradio-demo -``` - -### Usage - -``` -init [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | -| template | t | A template to use when creating the app. This can be a URL | | -| to a git repository or a shorthand template name. | | | | - -These templates are equivalent: - -``` -user/repo -github:user/repo -git@github.com:user/repo -https://github.com/user/repo -``` - -Download from GitLab: - -``` -gitlab:user/repo -git@gitlab.com:user/repo -https://gitlab.com/user/repo -``` - -Download from Bitbucket - -``` -bitbucket:user/repo -git@bitbucket.org:user/repo -https://bitbucket.org/user/repo -``` - -Specify a tag or branch: - -```` -user/repo#dev # branch -user/repo#v1.2.3 # release tag -user/repo#1234abcd # commit hash -``` | true | -| mode | m | The mode to use when creating the app. This can be either "git" or -"tar". If "git" is specified, the template will be downloaded as a -tarball. Note that "git" clones over SSH, so you must have a valid -SSH key configured with GitHub, Bitbucket, or GitLab. | false | -| name | n | The name of the app. Defaults to the first argument current directory name. | false | -| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace login - -Log in to the CLI using your Paperspace API key or by opening the web console. - -### Usage -```` - -login [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace logout - -Log out of the CLI for the current team, a specific team, or all teams. - -### Usage -``` - -logout [arguments...] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| all | a | Log out of all teams. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine - -Manage your Paperspace machines. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine [command] machine [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [restart](#restart) -- [start](#start) -- [stop](#stop) -- [update](#update) -## pspace machine create - -Create a machine. - -### Usage -``` - -machine create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine delete - -Delete a machine from a team. - -### Usage -``` - -machine delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine get - -Get a machine from a team. - -### Usage -``` - -machine get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine help - -Show help for a machine command - -### Usage -``` - -machine help [command] machine help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace machine help commands - -List machine commands - -Example: -``` - -$ machine help commands commands - -``` -### Usage -``` - -machine help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace machine list - -List machines in your team. - -Pick a subset of fields to display: -``` - -pspace machine list -F name -F dtModified - -``` -### Usage -``` - -machine list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine restart - -Restart a machine from a team. - -### Usage -``` - -machine restart [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine start - -Start a machine from a team. - -### Usage -``` - -machine start [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine stop - -Stop a machine from a team. - -### Usage -``` - -machine stop [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine update - -Update a machine's settings. - -### Usage -``` - -machine update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine-event - -Manage your machine events. Events are asynchronous tasks performed by our system on your machines. -Not all machine commands are asynchronous. For those that are, a machine event will be returned -which can be tracked using this command. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine-event [command] machine-event [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [get](#get) -- [help](#help) -- [list](#list) -## pspace machine-event get - -Get a machine event from a team. - -### Usage -``` - -machine-event get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine-event help - -Show help for a machine-event command - -### Usage -``` - -machine-event help [command] machine-event help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace machine-event help commands - -List machine-event commands - -Example: -``` - -$ machine-event help commands commands - -``` -### Usage -``` - -machine-event help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace machine-event list - -List machine events in your team. - -Pick a subset of fields to display: -``` - -pspace machine-event list -F name -F dtModified - -``` -### Usage -``` - -machine-event list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model - -Manage your Paperspace models. - -For more information, see https://docs.paperspace.com/deploying/models. - -### Usage -``` - -model [command] model [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace model create - -Create a new model. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -model create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model delete - -Delete a model from a team. - -### Usage -``` - -model delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model get - -Get a model from a team. - -### Usage -``` - -model get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model help - -Show help for a model command - -### Usage -``` - -model help [command] model help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace model help commands - -List model commands - -Example: -``` - -$ model help commands commands - -``` -### Usage -``` - -model help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace model list - -List models in your team. - -Pick a subset of fields to display: -``` - -pspace model list -F name -F dtModified - -``` -### Usage -``` - -model list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace os-template - -List OS templates. OS templates are pre-configured virtual machines that -you can use to create a new machine. - -For more information, see https://docs.paperspace.com/compute/os-templates. - -### Usage -``` - -os-template [command] os-template [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [list](#list) -## pspace os-template help - -Show help for a os-template command - -### Usage -``` - -os-template help [command] os-template help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace os-template help commands - -List os-template commands - -Example: -``` - -$ os-template help commands commands - -``` -### Usage -``` - -os-template help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace os-template list - -List OS templates. - -Pick a subset of fields to display: -``` - -pspace os-template list -F name - -``` -### Usage -``` - -os-template list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network - -Manage your private networks. Private networks are logically isolated networks -for your machines and shared drives. They can also be used for site-to-site VPNs -and direct connections to your on-premise network. - -For more information, see https://docs.paperspace.com/networking/private-networks. - -### Usage -``` - -private-network [command] private-network [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace private-network create - -Create a private network. - -### Usage -``` - -private-network create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network delete - -Delete a private network from a team. - -### Usage -``` - -private-network delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network get - -Get a private network from a team. - -### Usage -``` - -private-network get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network help - -Show help for a private-network command - -### Usage -``` - -private-network help [command] private-network help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace private-network help commands - -List private-network commands - -Example: -``` - -$ private-network help commands commands - -``` -### Usage -``` - -private-network help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace private-network list - -List private networks in your team. - -Pick a subset of fields to display: -``` - -pspace private-network list -F name -F dtModified - -``` -### Usage -``` - -private-network list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project - -Manage your Paperspace projects. - -### Usage -``` - -project [command] project [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [link](#link) -- [list](#list) -- [update](#update) -## pspace project create - -Create a new project. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -project create [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project delete - -Delete a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project get - -Get a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project help - -Show help for a project command - -### Usage -``` - -project help [command] project help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace project help commands - -List project commands - -Example: -``` - -$ project help commands commands - -``` -### Usage -``` - -project help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace project link - -This will link a remote project to a local directory. Commands that -depend on a project ID will use the project ID of the linked project -when communicating with the Paperspace API. - -Link a project to the current directory. -``` - -$ pspace link - -``` -Link a project to a different directory. -``` - -$ pspace link --cwd ../my-app - -``` -Link a project and specify a project ID. -``` - -$ pspace link pzwf2g05ubegj - -``` -### Usage -``` - -project link [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project list - -List projects in your team. - -Pick a subset of fields to display: -``` - -pspace project list -F id -F name -F dtCreated - -``` -### Usage -``` - -project list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project update - -Update an existing project. - -Example: -``` - -pspace project update psukfyemho7 --name my-cool-project - -``` -### Usage -``` - -pspace project update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip - -Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. - -For more information, see https://docs.paperspace.com/networking/public-ips. - -### Usage -``` - -public-ip [command] public-ip [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [assign](#assign) -- [claim](#claim) -- [help](#help) -- [list](#list) -- [release](#release) -## pspace public-ip assign - -Assign a public IP to a machine. - -### Usage -``` - -public-ip assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip claim - -Claim a public IP for a team. - -### Usage -``` - -public-ip claim [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip help - -Show help for a public-ip command - -### Usage -``` - -public-ip help [command] public-ip help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace public-ip help commands - -List public-ip commands - -Example: -``` - -$ public-ip help commands commands - -``` -### Usage -``` - -public-ip help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace public-ip list - -List public IPs in your team or project. - -Pick a subset of fields to display: -``` - -pspace public-ip list -F name -F dtModified - -``` -### Usage -``` - -public-ip list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip release - -Release a public IP from a team. This will unassign it from its assigned machine, if any. - -### Usage -``` - -public-ip release [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret - -Manage your Paperspace secrets. Secrets are used to store sensitive -information such as API keys, passwords, and other credentials. Secrets -can be safely injected into workloads as environment variables. An environment -variable that uses a Secret will not reveal the contents of the secret itself. - -Secrets can be created at the following levels: - -- Project (default): these secrets are applied to all resources in a project -- Global: these secrets can be applied to all resources on your current team - -For more information, see https://docs.paperspace.com/secrets. - -### Usage -``` - -secret [command] secret [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace secret create - -Create a secret in a project or team. - -### Usage -``` - -secret create [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret delete - -Delete a secret from a project or team. - -### Usage -``` - -secret delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret get - -Get a secret from a project or team. - -### Usage -``` - -secret get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret help - -Show help for a secret command - -### Usage -``` - -secret help [command] secret help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace secret help commands - -List secret commands - -Example: -``` - -$ secret help commands commands - -``` -### Usage -``` - -secret help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace secret list - -List secrets in your team or project. - -Pick a subset of fields to display: -``` - -pspace secret list -F name -F dtModified - -``` -### Usage -``` - -secret list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret update - -Update a secret in a project or team. - -### Usage -``` - -secret update [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive - -Manage your shared drives. Shared drives are used to centralize data -used by your team. Shared drives can be mounted on any Paperspace machine -in the same private network. - -For more information, see https://docs.paperspace.com/storage/shared-drives. - -### Usage -``` - -shared-drive [command] shared-drive [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace shared-drive create - -Create a shared drive. - -### Usage -``` - -shared-drive create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive delete - -Delete a shared drive from a team. - -### Usage -``` - -shared-drive delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive get - -Get a shared drive from a team. - -### Usage -``` - -shared-drive get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive help - -Show help for a shared-drive command - -### Usage -``` - -shared-drive help [command] shared-drive help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace shared-drive help commands - -List shared-drive commands - -Example: -``` - -$ shared-drive help commands commands - -``` -### Usage -``` - -shared-drive help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace shared-drive list - -List shared drives in your team or project. - -Pick a subset of fields to display: -``` - -pspace shared-drive list -F name -F dtModified - -``` -### Usage -``` - -shared-drive list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace signup - -This command opens the Paperspace signup page in your browser. - -### Usage -``` - -signup [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot - -Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. -They can be used to restore the machine to its previous state. Using snapshots is recommended -before taking any action that could affect the usability of the machine or its network connection. - -For more information, see https://docs.paperspace.com/storage/snapshots. - -### Usage -``` - -snapshot [command] snapshot [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [help](#help) -- [list](#list) -- [restore](#restore) -## pspace snapshot create - -Create a snapshot from a machine. - -### Usage -``` - -snapshot create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot delete - -Delete a snapshot from a team. - -### Usage -``` - -snapshot delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot help - -Show help for a snapshot command - -### Usage -``` - -snapshot help [command] snapshot help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace snapshot help commands - -List snapshot commands - -Example: -``` - -$ snapshot help commands commands - -``` -### Usage -``` - -snapshot help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace snapshot list - -List snapshots in your team. - -Pick a subset of fields to display: -``` - -pspace snapshot list -F name -F dtModified - -``` -### Usage -``` - -snapshot list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot restore - -Restore a machine to a snapshot. - -### Usage -``` - -snapshot restore [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script - -Manage your startup scripts. Startup scripts allow you to configure a machine -on first boot or on every boot. - -### Usage -``` - -startup-script [command] startup-script [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [assign](#assign) -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [unassign](#unassign) -- [update](#update) -## pspace startup-script assign - -Assign a startup script to a machine. - -### Usage -``` - -startup-script assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script create - -Create a startup script. - -### Usage -``` - -startup-script create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script delete - -Delete a startup script from a team. - -### Usage -``` - -startup-script delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script get - -Get a startup script from a team. - -### Usage -``` - -startup-script get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script help - -Show help for a startup-script command - -### Usage -``` - -startup-script help [command] startup-script help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace startup-script help commands - -List startup-script commands - -Example: -``` - -$ startup-script help commands commands - -``` -### Usage -``` - -startup-script help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace startup-script list - -List startup scripts in your team. - -Pick a subset of fields to display: -``` - -pspace startup-script list -F name -F dtCreated - -``` -### Usage -``` - -startup-script list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script unassign - -Unassign a startup script from a machine. - -### Usage -``` - -startup-script unassign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script update - -Update a startup script. - -### Usage -``` - -startup-script update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider - -Manage your storage providers. - -For more information, see https://docs.paperspace.com/storage/storageProviders. - -### Usage -``` - -storage-provider [command] storage-provider [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace storage-provider create - -Create a storage provider. - -### Usage -``` - -storage-provider create [command] storage-provider create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider create help - -Show help for a create command - -### Usage -``` - -storage-provider create help [command] storage-provider create help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider create help commands - -List create commands - -Example: -``` - -$ storage-provider create help commands commands - -``` -### Usage -``` - -storage-provider create help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider create s3 - -Create an S3 storage provider. - -### Usage -``` - -storage-provider create s3 [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider delete - -Delete a storage provider from a team. - -### Usage -``` - -storage-provider delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider get - -Get a storage provider from a team. - -### Usage -``` - -storage-provider get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider help - -Show help for a storage-provider command - -### Usage -``` - -storage-provider help [command] storage-provider help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider help commands - -List storage-provider commands - -Example: -``` - -$ storage-provider help commands commands - -``` -### Usage -``` - -storage-provider help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider list - -List storage providers in your team or project. - -Pick a subset of fields to display: -``` - -pspace storage provider list -F name -F dtModified - -``` -### Usage -``` - -storage-provider list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider update - -Update a storage provider. - -### Usage -``` - -storage-provider update [command] storage-provider update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider update help - -Show help for a update command - -### Usage -``` - -storage-provider update help [command] storage-provider update help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider update help commands - -List update commands - -Example: -``` - -$ storage-provider update help commands commands - -``` -### Usage -``` - -storage-provider update help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider update s3 - -Update an S3 storage provider in a project or team. - -### Usage -``` - -storage-provider update s3 [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace up - -This will upsert an app config and deploy your app to Paperspace. You can optionally -specify a path to a config file. If no config file is specified, the default -config file paths will be tried. - -Deploy the app in the current directory. -``` - -$ pspace up - -``` -Deploy the app using a config file. -``` - -$ pspace up -c paperspace.json - -``` -Deploy an app in a different directory. -``` - -$ pspace up --cwd ../my-app - -``` -### Usage -``` - -up [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace upgrade - -This command upgrades pspace to the latest version. - -If you used a package manager like `brew` to install `pspace`, -you should use that to upgrade in order to avoid potential permissions -issues. For example, for `brew` you can upgrade by running: -``` - -brew upgrade pspace - -``` -If you installed `pspace` using the install script, you can upgrade by -running: -``` - -pspace upgrade - -``` -### Usage -``` - -upgrade [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace version - -Shows version information command, including version number and build date. - -### Usage -``` - -version [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands -``` diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md new file mode 100644 index 0000000..0086595 --- /dev/null +++ b/.assets/pspace/autoscaling-group.md @@ -0,0 +1,30 @@ +# pspace autoscaling-group + +Manage your autoscaling groups. Autoscaling groups enable using +the Kubernetes cluster-autoscaler to automatically scale your cluster. +You can also autoscaling groups as a primitive for your own autoscaler. + +## Usage + +``` + autoscaling-group [command] + autoscaling-group [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/autoscaling-group/create.md b/.assets/pspace/autoscaling-group/create.md new file mode 100644 index 0000000..cb6a760 --- /dev/null +++ b/.assets/pspace/autoscaling-group/create.md @@ -0,0 +1,31 @@ +# pspace autoscaling-group create + +Create an autoscaling group. + +## Usage + +``` + autoscaling-group create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/delete.md b/.assets/pspace/autoscaling-group/delete.md new file mode 100644 index 0000000..4f332b4 --- /dev/null +++ b/.assets/pspace/autoscaling-group/delete.md @@ -0,0 +1,22 @@ +# pspace autoscaling-group delete + +Delete an autoscaling group from a team. + +## Usage + +``` + autoscaling-group delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/get.md b/.assets/pspace/autoscaling-group/get.md new file mode 100644 index 0000000..3f7e032 --- /dev/null +++ b/.assets/pspace/autoscaling-group/get.md @@ -0,0 +1,22 @@ +# pspace autoscaling-group get + +Get an autoscaling group from a team. + +## Usage + +``` + autoscaling-group get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/help.md b/.assets/pspace/autoscaling-group/help.md new file mode 100644 index 0000000..3270e64 --- /dev/null +++ b/.assets/pspace/autoscaling-group/help.md @@ -0,0 +1,23 @@ +# pspace autoscaling-group help + +Show help for a autoscaling-group command + +## Usage + +``` + autoscaling-group help [command] + autoscaling-group help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md new file mode 100644 index 0000000..7c21fbb --- /dev/null +++ b/.assets/pspace/autoscaling-group/help/commands.md @@ -0,0 +1,27 @@ +# pspace autoscaling-group help commands + +List autoscaling-group commands + +Example: +``` +$ autoscaling-group help commands commands +``` + +## Usage + +``` + autoscaling-group help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/list.md b/.assets/pspace/autoscaling-group/list.md new file mode 100644 index 0000000..f2c0eed --- /dev/null +++ b/.assets/pspace/autoscaling-group/list.md @@ -0,0 +1,34 @@ +# pspace autoscaling-group list + +List autoscaling groups in your team. + +Pick a subset of fields to display: +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +## Usage + +``` + autoscaling-group list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/update.md b/.assets/pspace/autoscaling-group/update.md new file mode 100644 index 0000000..46ba46a --- /dev/null +++ b/.assets/pspace/autoscaling-group/update.md @@ -0,0 +1,32 @@ +# pspace autoscaling-group update + +Update an autoscaling group. + +## Usage + +``` + autoscaling-group update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md new file mode 100644 index 0000000..ca4ae3f --- /dev/null +++ b/.assets/pspace/completion.md @@ -0,0 +1,27 @@ +# pspace completion + +Generate an autocompletion script for pspace in the specified shell. +See each sub-command's help for details on how to use the generated script. + +## Usage + +``` + completion [command] + completion [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [bash](#bash) +- [fish](#fish) +- [help](#help) +- [zsh](#zsh) diff --git a/.assets/pspace/completion/bash.md b/.assets/pspace/completion/bash.md new file mode 100644 index 0000000..3534d87 --- /dev/null +++ b/.assets/pspace/completion/bash.md @@ -0,0 +1,43 @@ +# pspace completion bash + +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: +``` +$ source <(completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: +``` +$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion bash [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion/fish.md b/.assets/pspace/completion/fish.md new file mode 100644 index 0000000..aeea101 --- /dev/null +++ b/.assets/pspace/completion/fish.md @@ -0,0 +1,34 @@ +# pspace completion fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +``` +$ completion fish fish | source +``` + +To load completions for every new session, execute once: +``` +$ completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion fish [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion/help.md b/.assets/pspace/completion/help.md new file mode 100644 index 0000000..994b1d5 --- /dev/null +++ b/.assets/pspace/completion/help.md @@ -0,0 +1,23 @@ +# pspace completion help + +Show help for a completion command + +## Usage + +``` + completion help [command] + completion help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md new file mode 100644 index 0000000..642005b --- /dev/null +++ b/.assets/pspace/completion/help/commands.md @@ -0,0 +1,27 @@ +# pspace completion help commands + +List completion commands + +Example: +``` +$ completion help commands commands +``` + +## Usage + +``` + completion help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/completion/zsh.md b/.assets/pspace/completion/zsh.md new file mode 100644 index 0000000..45d8c01 --- /dev/null +++ b/.assets/pspace/completion/zsh.md @@ -0,0 +1,48 @@ +# pspace completion zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: +``` +$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: +``` +$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion zsh [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md new file mode 100644 index 0000000..8d59793 --- /dev/null +++ b/.assets/pspace/config.md @@ -0,0 +1,35 @@ +# pspace config + +This command manages your Paperspace configuration. You can use it to set, get, and +delete configuration values. Running this command without any subcommands will print +your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: +``` +pspace config set team "my-team" +``` + +## Usage + +``` + config [command] + config [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [set](#set) diff --git a/.assets/pspace/config/delete.md b/.assets/pspace/config/delete.md new file mode 100644 index 0000000..83cb5b2 --- /dev/null +++ b/.assets/pspace/config/delete.md @@ -0,0 +1,21 @@ +# pspace config delete + +Delete a configuration value. + +## Usage + +``` + config delete [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config/get.md b/.assets/pspace/config/get.md new file mode 100644 index 0000000..c13a592 --- /dev/null +++ b/.assets/pspace/config/get.md @@ -0,0 +1,27 @@ +# pspace config get + +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: +``` +pspace config get team +``` + +## Usage + +``` + config get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config/help.md b/.assets/pspace/config/help.md new file mode 100644 index 0000000..1ddb36f --- /dev/null +++ b/.assets/pspace/config/help.md @@ -0,0 +1,23 @@ +# pspace config help + +Show help for a config command + +## Usage + +``` + config help [command] + config help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md new file mode 100644 index 0000000..e749bf5 --- /dev/null +++ b/.assets/pspace/config/help/commands.md @@ -0,0 +1,27 @@ +# pspace config help commands + +List config commands + +Example: +``` +$ config help commands commands +``` + +## Usage + +``` + config help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/config/set.md b/.assets/pspace/config/set.md new file mode 100644 index 0000000..82c69b6 --- /dev/null +++ b/.assets/pspace/config/set.md @@ -0,0 +1,21 @@ +# pspace config set + +Set a configuration value. + +## Usage + +``` + config set [arguments] [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md new file mode 100644 index 0000000..973c9e2 --- /dev/null +++ b/.assets/pspace/console.md @@ -0,0 +1,21 @@ +# pspace console + +This command opens the Paperspace web console in your browser. + +## Usage + +``` + console [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md new file mode 100644 index 0000000..e7d12c4 --- /dev/null +++ b/.assets/pspace/custom-template.md @@ -0,0 +1,31 @@ +# pspace custom-template + +Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +## Usage + +``` + custom-template [command] + custom-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/custom-template/create.md b/.assets/pspace/custom-template/create.md new file mode 100644 index 0000000..00b1f0d --- /dev/null +++ b/.assets/pspace/custom-template/create.md @@ -0,0 +1,24 @@ +# pspace custom-template create + +Create a custom template from a machine. + +## Usage + +``` + custom-template create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/delete.md b/.assets/pspace/custom-template/delete.md new file mode 100644 index 0000000..24b083a --- /dev/null +++ b/.assets/pspace/custom-template/delete.md @@ -0,0 +1,22 @@ +# pspace custom-template delete + +Delete a custom template from a team. + +## Usage + +``` + custom-template delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/get.md b/.assets/pspace/custom-template/get.md new file mode 100644 index 0000000..8eb97ef --- /dev/null +++ b/.assets/pspace/custom-template/get.md @@ -0,0 +1,22 @@ +# pspace custom-template get + +Get a custom template from a team. + +## Usage + +``` + custom-template get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/help.md b/.assets/pspace/custom-template/help.md new file mode 100644 index 0000000..6868f7d --- /dev/null +++ b/.assets/pspace/custom-template/help.md @@ -0,0 +1,23 @@ +# pspace custom-template help + +Show help for a custom-template command + +## Usage + +``` + custom-template help [command] + custom-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md new file mode 100644 index 0000000..e074c6f --- /dev/null +++ b/.assets/pspace/custom-template/help/commands.md @@ -0,0 +1,27 @@ +# pspace custom-template help commands + +List custom-template commands + +Example: +``` +$ custom-template help commands commands +``` + +## Usage + +``` + custom-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/list.md b/.assets/pspace/custom-template/list.md new file mode 100644 index 0000000..4d67c93 --- /dev/null +++ b/.assets/pspace/custom-template/list.md @@ -0,0 +1,35 @@ +# pspace custom-template list + +List custom templates in your team. + +Pick a subset of fields to display: +``` +pspace custom-template list -F name -F dtModified +``` + +## Usage + +``` + custom-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md new file mode 100644 index 0000000..ad0111f --- /dev/null +++ b/.assets/pspace/dataset.md @@ -0,0 +1,31 @@ +# pspace dataset + +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +## Usage + +``` + dataset [command] + dataset [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +- [versions](#versions) diff --git a/.assets/pspace/dataset/create.md b/.assets/pspace/dataset/create.md new file mode 100644 index 0000000..966ab9b --- /dev/null +++ b/.assets/pspace/dataset/create.md @@ -0,0 +1,26 @@ +# pspace dataset create + +Create a dataset. + +## Usage + +``` + dataset create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/delete.md b/.assets/pspace/dataset/delete.md new file mode 100644 index 0000000..8cf4617 --- /dev/null +++ b/.assets/pspace/dataset/delete.md @@ -0,0 +1,22 @@ +# pspace dataset delete + +Delete a dataset from a team. + +## Usage + +``` + dataset delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/get.md b/.assets/pspace/dataset/get.md new file mode 100644 index 0000000..46aa312 --- /dev/null +++ b/.assets/pspace/dataset/get.md @@ -0,0 +1,22 @@ +# pspace dataset get + +Get a dataset from a team. + +## Usage + +``` + dataset get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/help.md b/.assets/pspace/dataset/help.md new file mode 100644 index 0000000..12b4586 --- /dev/null +++ b/.assets/pspace/dataset/help.md @@ -0,0 +1,23 @@ +# pspace dataset help + +Show help for a dataset command + +## Usage + +``` + dataset help [command] + dataset help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md new file mode 100644 index 0000000..d848fd7 --- /dev/null +++ b/.assets/pspace/dataset/help/commands.md @@ -0,0 +1,27 @@ +# pspace dataset help commands + +List dataset commands + +Example: +``` +$ dataset help commands commands +``` + +## Usage + +``` + dataset help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/list.md b/.assets/pspace/dataset/list.md new file mode 100644 index 0000000..7242d70 --- /dev/null +++ b/.assets/pspace/dataset/list.md @@ -0,0 +1,32 @@ +# pspace dataset list + +List datasets in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset list -F name -F dtModified +``` + +## Usage + +``` + dataset list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/update.md b/.assets/pspace/dataset/update.md new file mode 100644 index 0000000..a9efa84 --- /dev/null +++ b/.assets/pspace/dataset/update.md @@ -0,0 +1,24 @@ +# pspace dataset update + +Update a dataset in a project or team. + +## Usage + +``` + dataset update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions.md b/.assets/pspace/dataset/versions.md new file mode 100644 index 0000000..9cfa3ec --- /dev/null +++ b/.assets/pspace/dataset/versions.md @@ -0,0 +1,30 @@ +# pspace dataset versions + +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +## Usage + +``` + dataset versions [command] + dataset versions [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/dataset/versions/create.md b/.assets/pspace/dataset/versions/create.md new file mode 100644 index 0000000..ed307c4 --- /dev/null +++ b/.assets/pspace/dataset/versions/create.md @@ -0,0 +1,24 @@ +# pspace dataset versions create + +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +## Usage + +``` + dataset versions create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/delete.md b/.assets/pspace/dataset/versions/delete.md new file mode 100644 index 0000000..3234bc6 --- /dev/null +++ b/.assets/pspace/dataset/versions/delete.md @@ -0,0 +1,23 @@ +# pspace dataset versions delete + +Delete a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions delete [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/get.md b/.assets/pspace/dataset/versions/get.md new file mode 100644 index 0000000..c072be6 --- /dev/null +++ b/.assets/pspace/dataset/versions/get.md @@ -0,0 +1,23 @@ +# pspace dataset versions get + +Get a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions get [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/help.md b/.assets/pspace/dataset/versions/help.md new file mode 100644 index 0000000..4cb4876 --- /dev/null +++ b/.assets/pspace/dataset/versions/help.md @@ -0,0 +1,23 @@ +# pspace dataset versions help + +Show help for a versions command + +## Usage + +``` + dataset versions help [command] + dataset versions help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md new file mode 100644 index 0000000..af2d37a --- /dev/null +++ b/.assets/pspace/dataset/versions/help/commands.md @@ -0,0 +1,27 @@ +# pspace dataset versions help commands + +List versions commands + +Example: +``` +$ dataset versions help commands commands +``` + +## Usage + +``` + dataset versions help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/list.md b/.assets/pspace/dataset/versions/list.md new file mode 100644 index 0000000..291e70d --- /dev/null +++ b/.assets/pspace/dataset/versions/list.md @@ -0,0 +1,32 @@ +# pspace dataset versions list + +List dataset versions in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset versions list -F name -F dtModified +``` + +## Usage + +``` + dataset versions list [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/update.md b/.assets/pspace/dataset/versions/update.md new file mode 100644 index 0000000..aa85218 --- /dev/null +++ b/.assets/pspace/dataset/versions/update.md @@ -0,0 +1,24 @@ +# pspace dataset versions update + +Update a dataset version in a project or team. + +## Usage + +``` + dataset versions update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md new file mode 100644 index 0000000..873960b --- /dev/null +++ b/.assets/pspace/deployment.md @@ -0,0 +1,27 @@ +# pspace deployment + +Effortlessly deploy ML apps to Paperspace. + +## Usage + +``` + deployment [command] + deployment [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [up](#up) diff --git a/.assets/pspace/deployment/delete.md b/.assets/pspace/deployment/delete.md new file mode 100644 index 0000000..7df1430 --- /dev/null +++ b/.assets/pspace/deployment/delete.md @@ -0,0 +1,26 @@ +# pspace deployment delete + +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +## Usage + +``` + deployment delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/get.md b/.assets/pspace/deployment/get.md new file mode 100644 index 0000000..492e10e --- /dev/null +++ b/.assets/pspace/deployment/get.md @@ -0,0 +1,32 @@ +# pspace deployment get + +Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +## Usage + +``` + deployment get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/help.md b/.assets/pspace/deployment/help.md new file mode 100644 index 0000000..5dc0208 --- /dev/null +++ b/.assets/pspace/deployment/help.md @@ -0,0 +1,23 @@ +# pspace deployment help + +Show help for a deployment command + +## Usage + +``` + deployment help [command] + deployment help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md new file mode 100644 index 0000000..5afdb31 --- /dev/null +++ b/.assets/pspace/deployment/help/commands.md @@ -0,0 +1,27 @@ +# pspace deployment help commands + +List deployment commands + +Example: +``` +$ deployment help commands commands +``` + +## Usage + +``` + deployment help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/list.md b/.assets/pspace/deployment/list.md new file mode 100644 index 0000000..d73e118 --- /dev/null +++ b/.assets/pspace/deployment/list.md @@ -0,0 +1,32 @@ +# pspace deployment list + +List deployments in your team. + +Pick a subset of fields to display: +``` +pspace deployment list -F id -F name +``` + +## Usage + +``` + deployment list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/up.md b/.assets/pspace/deployment/up.md new file mode 100644 index 0000000..bf886a8 --- /dev/null +++ b/.assets/pspace/deployment/up.md @@ -0,0 +1,59 @@ +# pspace deployment up + +This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. +``` +$ pspace deployment create --project-id 1234 +``` + +## Usage + +``` + deployment up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md new file mode 100644 index 0000000..a9638fe --- /dev/null +++ b/.assets/pspace/docs.md @@ -0,0 +1,26 @@ +# pspace docs + +This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` + +## Usage + +``` + docs [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md new file mode 100644 index 0000000..677a8cf --- /dev/null +++ b/.assets/pspace/help.md @@ -0,0 +1,23 @@ +# pspace help + +Show help for a pspace command + +## Usage + +``` + help [command] + help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md new file mode 100644 index 0000000..ed803ff --- /dev/null +++ b/.assets/pspace/help/commands.md @@ -0,0 +1,27 @@ +# pspace help commands + +List pspace commands + +Example: +``` +$ help commands commands +``` + +## Usage + +``` + help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md new file mode 100644 index 0000000..38e27e7 --- /dev/null +++ b/.assets/pspace/init.md @@ -0,0 +1,77 @@ +# pspace init + +Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +``` +$ pspace init +``` + +Create a new app named "my-app" relative to the current directory. +``` +$ pspace init my-app +``` + +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` +$ pspace init my-app -t Paperspace/gradio-demo +``` + +## Usage + +``` + init [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| template | t | A template to use when creating the app. This can be a URL +to a git repository or a shorthand template name. + +These templates are equivalent: +``` +user/repo +github:user/repo +git@github.com:user/repo +https://github.com/user/repo +``` + +Download from GitLab: +``` +gitlab:user/repo +git@gitlab.com:user/repo +https://gitlab.com/user/repo +``` + +Download from Bitbucket +``` +bitbucket:user/repo +git@bitbucket.org:user/repo +https://bitbucket.org/user/repo +``` + +Specify a tag or branch: +``` +user/repo#dev # branch +user/repo#v1.2.3 # release tag +user/repo#1234abcd # commit hash +``` | true | +| mode | m | The mode to use when creating the app. This can be either "git" or +"tar". If "git" is specified, the template will be downloaded as a +tarball. Note that "git" clones over SSH, so you must have a valid +SSH key configured with GitHub, Bitbucket, or GitLab. | false | +| name | n | The name of the app. Defaults to the first argument current directory name. | false | +| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md new file mode 100644 index 0000000..80217e7 --- /dev/null +++ b/.assets/pspace/login.md @@ -0,0 +1,21 @@ +# pspace login + +Log in to the CLI using your Paperspace API key or by opening the web console. + +## Usage + +``` + login [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md new file mode 100644 index 0000000..35b5296 --- /dev/null +++ b/.assets/pspace/logout.md @@ -0,0 +1,22 @@ +# pspace logout + +Log out of the CLI for the current team, a specific team, or all teams. + +## Usage + +``` + logout [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| all | a | Log out of all teams. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md new file mode 100644 index 0000000..732f134 --- /dev/null +++ b/.assets/pspace/machine-event.md @@ -0,0 +1,29 @@ +# pspace machine-event + +Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine-event [command] + machine-event [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/machine-event/get.md b/.assets/pspace/machine-event/get.md new file mode 100644 index 0000000..3452ed5 --- /dev/null +++ b/.assets/pspace/machine-event/get.md @@ -0,0 +1,22 @@ +# pspace machine-event get + +Get a machine event from a team. + +## Usage + +``` + machine-event get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event/help.md b/.assets/pspace/machine-event/help.md new file mode 100644 index 0000000..703391a --- /dev/null +++ b/.assets/pspace/machine-event/help.md @@ -0,0 +1,23 @@ +# pspace machine-event help + +Show help for a machine-event command + +## Usage + +``` + machine-event help [command] + machine-event help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md new file mode 100644 index 0000000..9bb10fd --- /dev/null +++ b/.assets/pspace/machine-event/help/commands.md @@ -0,0 +1,27 @@ +# pspace machine-event help commands + +List machine-event commands + +Example: +``` +$ machine-event help commands commands +``` + +## Usage + +``` + machine-event help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event/list.md b/.assets/pspace/machine-event/list.md new file mode 100644 index 0000000..a3d73ab --- /dev/null +++ b/.assets/pspace/machine-event/list.md @@ -0,0 +1,34 @@ +# pspace machine-event list + +List machine events in your team. + +Pick a subset of fields to display: +``` +pspace machine-event list -F name -F dtModified +``` + +## Usage + +``` + machine-event list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md new file mode 100644 index 0000000..be849f2 --- /dev/null +++ b/.assets/pspace/machine.md @@ -0,0 +1,33 @@ +# pspace machine + +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine [command] + machine [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [restart](#restart) +- [start](#start) +- [stop](#stop) +- [update](#update) diff --git a/.assets/pspace/machine/create.md b/.assets/pspace/machine/create.md new file mode 100644 index 0000000..46568ad --- /dev/null +++ b/.assets/pspace/machine/create.md @@ -0,0 +1,43 @@ +# pspace machine create + +Create a machine. + +## Usage + +``` + machine create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/delete.md b/.assets/pspace/machine/delete.md new file mode 100644 index 0000000..81770c3 --- /dev/null +++ b/.assets/pspace/machine/delete.md @@ -0,0 +1,22 @@ +# pspace machine delete + +Delete a machine from a team. + +## Usage + +``` + machine delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/get.md b/.assets/pspace/machine/get.md new file mode 100644 index 0000000..8fb70f3 --- /dev/null +++ b/.assets/pspace/machine/get.md @@ -0,0 +1,22 @@ +# pspace machine get + +Get a machine from a team. + +## Usage + +``` + machine get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/help.md b/.assets/pspace/machine/help.md new file mode 100644 index 0000000..1b773fe --- /dev/null +++ b/.assets/pspace/machine/help.md @@ -0,0 +1,23 @@ +# pspace machine help + +Show help for a machine command + +## Usage + +``` + machine help [command] + machine help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md new file mode 100644 index 0000000..5d8375b --- /dev/null +++ b/.assets/pspace/machine/help/commands.md @@ -0,0 +1,27 @@ +# pspace machine help commands + +List machine commands + +Example: +``` +$ machine help commands commands +``` + +## Usage + +``` + machine help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/machine/list.md b/.assets/pspace/machine/list.md new file mode 100644 index 0000000..c5f942c --- /dev/null +++ b/.assets/pspace/machine/list.md @@ -0,0 +1,36 @@ +# pspace machine list + +List machines in your team. + +Pick a subset of fields to display: +``` +pspace machine list -F name -F dtModified +``` + +## Usage + +``` + machine list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/restart.md b/.assets/pspace/machine/restart.md new file mode 100644 index 0000000..f0abfa5 --- /dev/null +++ b/.assets/pspace/machine/restart.md @@ -0,0 +1,22 @@ +# pspace machine restart + +Restart a machine from a team. + +## Usage + +``` + machine restart [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/start.md b/.assets/pspace/machine/start.md new file mode 100644 index 0000000..f9299be --- /dev/null +++ b/.assets/pspace/machine/start.md @@ -0,0 +1,22 @@ +# pspace machine start + +Start a machine from a team. + +## Usage + +``` + machine start [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/stop.md b/.assets/pspace/machine/stop.md new file mode 100644 index 0000000..bd02344 --- /dev/null +++ b/.assets/pspace/machine/stop.md @@ -0,0 +1,22 @@ +# pspace machine stop + +Stop a machine from a team. + +## Usage + +``` + machine stop [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/update.md b/.assets/pspace/machine/update.md new file mode 100644 index 0000000..a5bf1bc --- /dev/null +++ b/.assets/pspace/machine/update.md @@ -0,0 +1,36 @@ +# pspace machine update + +Update a machine's settings. + +## Usage + +``` + machine update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md new file mode 100644 index 0000000..361cde1 --- /dev/null +++ b/.assets/pspace/model.md @@ -0,0 +1,29 @@ +# pspace model + +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +## Usage + +``` + model [command] + model [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/model/create.md b/.assets/pspace/model/create.md new file mode 100644 index 0000000..b7f06a4 --- /dev/null +++ b/.assets/pspace/model/create.md @@ -0,0 +1,28 @@ +# pspace model create + +Create a new model. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + model create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/delete.md b/.assets/pspace/model/delete.md new file mode 100644 index 0000000..d18204b --- /dev/null +++ b/.assets/pspace/model/delete.md @@ -0,0 +1,22 @@ +# pspace model delete + +Delete a model from a team. + +## Usage + +``` + model delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/get.md b/.assets/pspace/model/get.md new file mode 100644 index 0000000..b467036 --- /dev/null +++ b/.assets/pspace/model/get.md @@ -0,0 +1,22 @@ +# pspace model get + +Get a model from a team. + +## Usage + +``` + model get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/help.md b/.assets/pspace/model/help.md new file mode 100644 index 0000000..9df28c6 --- /dev/null +++ b/.assets/pspace/model/help.md @@ -0,0 +1,23 @@ +# pspace model help + +Show help for a model command + +## Usage + +``` + model help [command] + model help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md new file mode 100644 index 0000000..be3d3c5 --- /dev/null +++ b/.assets/pspace/model/help/commands.md @@ -0,0 +1,27 @@ +# pspace model help commands + +List model commands + +Example: +``` +$ model help commands commands +``` + +## Usage + +``` + model help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/model/list.md b/.assets/pspace/model/list.md new file mode 100644 index 0000000..9202299 --- /dev/null +++ b/.assets/pspace/model/list.md @@ -0,0 +1,32 @@ +# pspace model list + +List models in your team. + +Pick a subset of fields to display: +``` +pspace model list -F name -F dtModified +``` + +## Usage + +``` + model list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md new file mode 100644 index 0000000..ffd377d --- /dev/null +++ b/.assets/pspace/os-template.md @@ -0,0 +1,27 @@ +# pspace os-template + +List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +## Usage + +``` + os-template [command] + os-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/os-template/help.md b/.assets/pspace/os-template/help.md new file mode 100644 index 0000000..c04c5ea --- /dev/null +++ b/.assets/pspace/os-template/help.md @@ -0,0 +1,23 @@ +# pspace os-template help + +Show help for a os-template command + +## Usage + +``` + os-template help [command] + os-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md new file mode 100644 index 0000000..2667495 --- /dev/null +++ b/.assets/pspace/os-template/help/commands.md @@ -0,0 +1,27 @@ +# pspace os-template help commands + +List os-template commands + +Example: +``` +$ os-template help commands commands +``` + +## Usage + +``` + os-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/os-template/list.md b/.assets/pspace/os-template/list.md new file mode 100644 index 0000000..8228eb9 --- /dev/null +++ b/.assets/pspace/os-template/list.md @@ -0,0 +1,33 @@ +# pspace os-template list + +List OS templates. + +Pick a subset of fields to display: +``` +pspace os-template list -F name +``` + +## Usage + +``` + os-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md new file mode 100644 index 0000000..34e5a57 --- /dev/null +++ b/.assets/pspace/private-network.md @@ -0,0 +1,31 @@ +# pspace private-network + +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. + +## Usage + +``` + private-network [command] + private-network [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/private-network/create.md b/.assets/pspace/private-network/create.md new file mode 100644 index 0000000..988f218 --- /dev/null +++ b/.assets/pspace/private-network/create.md @@ -0,0 +1,24 @@ +# pspace private-network create + +Create a private network. + +## Usage + +``` + private-network create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/delete.md b/.assets/pspace/private-network/delete.md new file mode 100644 index 0000000..4cbe68f --- /dev/null +++ b/.assets/pspace/private-network/delete.md @@ -0,0 +1,22 @@ +# pspace private-network delete + +Delete a private network from a team. + +## Usage + +``` + private-network delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/get.md b/.assets/pspace/private-network/get.md new file mode 100644 index 0000000..4207a19 --- /dev/null +++ b/.assets/pspace/private-network/get.md @@ -0,0 +1,22 @@ +# pspace private-network get + +Get a private network from a team. + +## Usage + +``` + private-network get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/help.md b/.assets/pspace/private-network/help.md new file mode 100644 index 0000000..35a0a7f --- /dev/null +++ b/.assets/pspace/private-network/help.md @@ -0,0 +1,23 @@ +# pspace private-network help + +Show help for a private-network command + +## Usage + +``` + private-network help [command] + private-network help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md new file mode 100644 index 0000000..1f003c5 --- /dev/null +++ b/.assets/pspace/private-network/help/commands.md @@ -0,0 +1,27 @@ +# pspace private-network help commands + +List private-network commands + +Example: +``` +$ private-network help commands commands +``` + +## Usage + +``` + private-network help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/list.md b/.assets/pspace/private-network/list.md new file mode 100644 index 0000000..928d6eb --- /dev/null +++ b/.assets/pspace/private-network/list.md @@ -0,0 +1,34 @@ +# pspace private-network list + +List private networks in your team. + +Pick a subset of fields to display: +``` +pspace private-network list -F name -F dtModified +``` + +## Usage + +``` + private-network list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md new file mode 100644 index 0000000..313e241 --- /dev/null +++ b/.assets/pspace/project.md @@ -0,0 +1,29 @@ +# pspace project + +Manage your Paperspace projects. + +## Usage + +``` + project [command] + project [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [link](#link) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/project/create.md b/.assets/pspace/project/create.md new file mode 100644 index 0000000..10e69f3 --- /dev/null +++ b/.assets/pspace/project/create.md @@ -0,0 +1,23 @@ +# pspace project create + +Create a new project. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + project create [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/delete.md b/.assets/pspace/project/delete.md new file mode 100644 index 0000000..ba58c68 --- /dev/null +++ b/.assets/pspace/project/delete.md @@ -0,0 +1,23 @@ +# pspace project delete + +Delete a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/get.md b/.assets/pspace/project/get.md new file mode 100644 index 0000000..e70d249 --- /dev/null +++ b/.assets/pspace/project/get.md @@ -0,0 +1,23 @@ +# pspace project get + +Get a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/help.md b/.assets/pspace/project/help.md new file mode 100644 index 0000000..a485416 --- /dev/null +++ b/.assets/pspace/project/help.md @@ -0,0 +1,23 @@ +# pspace project help + +Show help for a project command + +## Usage + +``` + project help [command] + project help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md new file mode 100644 index 0000000..7ed866b --- /dev/null +++ b/.assets/pspace/project/help/commands.md @@ -0,0 +1,27 @@ +# pspace project help commands + +List project commands + +Example: +``` +$ project help commands commands +``` + +## Usage + +``` + project help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/project/link.md b/.assets/pspace/project/link.md new file mode 100644 index 0000000..a200990 --- /dev/null +++ b/.assets/pspace/project/link.md @@ -0,0 +1,39 @@ +# pspace project link + +This will link a remote project to a local directory. Commands that +depend on a project ID will use the project ID of the linked project +when communicating with the Paperspace API. + +Link a project to the current directory. +``` +$ pspace link +``` + +Link a project to a different directory. +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. +``` +$ pspace link pzwf2g05ubegj +``` + +## Usage + +``` + project link [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/list.md b/.assets/pspace/project/list.md new file mode 100644 index 0000000..823bc80 --- /dev/null +++ b/.assets/pspace/project/list.md @@ -0,0 +1,32 @@ +# pspace project list + +List projects in your team. + +Pick a subset of fields to display: +``` +pspace project list -F id -F name -F dtCreated +``` + +## Usage + +``` + project list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/update.md b/.assets/pspace/project/update.md new file mode 100644 index 0000000..9ad171e --- /dev/null +++ b/.assets/pspace/project/update.md @@ -0,0 +1,28 @@ +# pspace project update + +Update an existing project. + +Example: +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +## Usage + +``` + pspace project update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md new file mode 100644 index 0000000..9722726 --- /dev/null +++ b/.assets/pspace/public-ip.md @@ -0,0 +1,29 @@ +# pspace public-ip + +Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +## Usage + +``` + public-ip [command] + public-ip [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [claim](#claim) +- [help](#help) +- [list](#list) +- [release](#release) diff --git a/.assets/pspace/public-ip/assign.md b/.assets/pspace/public-ip/assign.md new file mode 100644 index 0000000..0febe9e --- /dev/null +++ b/.assets/pspace/public-ip/assign.md @@ -0,0 +1,23 @@ +# pspace public-ip assign + +Assign a public IP to a machine. + +## Usage + +``` + public-ip assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/claim.md b/.assets/pspace/public-ip/claim.md new file mode 100644 index 0000000..0676833 --- /dev/null +++ b/.assets/pspace/public-ip/claim.md @@ -0,0 +1,23 @@ +# pspace public-ip claim + +Claim a public IP for a team. + +## Usage + +``` + public-ip claim [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/help.md b/.assets/pspace/public-ip/help.md new file mode 100644 index 0000000..6131c35 --- /dev/null +++ b/.assets/pspace/public-ip/help.md @@ -0,0 +1,23 @@ +# pspace public-ip help + +Show help for a public-ip command + +## Usage + +``` + public-ip help [command] + public-ip help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md new file mode 100644 index 0000000..62c03d5 --- /dev/null +++ b/.assets/pspace/public-ip/help/commands.md @@ -0,0 +1,27 @@ +# pspace public-ip help commands + +List public-ip commands + +Example: +``` +$ public-ip help commands commands +``` + +## Usage + +``` + public-ip help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/list.md b/.assets/pspace/public-ip/list.md new file mode 100644 index 0000000..63bd002 --- /dev/null +++ b/.assets/pspace/public-ip/list.md @@ -0,0 +1,33 @@ +# pspace public-ip list + +List public IPs in your team or project. + +Pick a subset of fields to display: +``` +pspace public-ip list -F name -F dtModified +``` + +## Usage + +``` + public-ip list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/release.md b/.assets/pspace/public-ip/release.md new file mode 100644 index 0000000..d936e8e --- /dev/null +++ b/.assets/pspace/public-ip/release.md @@ -0,0 +1,22 @@ +# pspace public-ip release + +Release a public IP from a team. This will unassign it from its assigned machine, if any. + +## Usage + +``` + public-ip release [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md new file mode 100644 index 0000000..773bd76 --- /dev/null +++ b/.assets/pspace/secret.md @@ -0,0 +1,38 @@ +# pspace secret + +Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +## Usage + +``` + secret [command] + secret [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/secret/create.md b/.assets/pspace/secret/create.md new file mode 100644 index 0000000..18e9535 --- /dev/null +++ b/.assets/pspace/secret/create.md @@ -0,0 +1,29 @@ +# pspace secret create + +Create a secret in a project or team. + +## Usage + +``` + secret create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/delete.md b/.assets/pspace/secret/delete.md new file mode 100644 index 0000000..077f756 --- /dev/null +++ b/.assets/pspace/secret/delete.md @@ -0,0 +1,29 @@ +# pspace secret delete + +Delete a secret from a project or team. + +## Usage + +``` + secret delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/get.md b/.assets/pspace/secret/get.md new file mode 100644 index 0000000..45dc488 --- /dev/null +++ b/.assets/pspace/secret/get.md @@ -0,0 +1,30 @@ +# pspace secret get + +Get a secret from a project or team. + +## Usage + +``` + secret get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/help.md b/.assets/pspace/secret/help.md new file mode 100644 index 0000000..a74ebeb --- /dev/null +++ b/.assets/pspace/secret/help.md @@ -0,0 +1,23 @@ +# pspace secret help + +Show help for a secret command + +## Usage + +``` + secret help [command] + secret help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md new file mode 100644 index 0000000..3f2baf6 --- /dev/null +++ b/.assets/pspace/secret/help/commands.md @@ -0,0 +1,27 @@ +# pspace secret help commands + +List secret commands + +Example: +``` +$ secret help commands commands +``` + +## Usage + +``` + secret help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/secret/list.md b/.assets/pspace/secret/list.md new file mode 100644 index 0000000..4208446 --- /dev/null +++ b/.assets/pspace/secret/list.md @@ -0,0 +1,40 @@ +# pspace secret list + +List secrets in your team or project. + +Pick a subset of fields to display: +``` +pspace secret list -F name -F dtModified +``` + +## Usage + +``` + secret list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/update.md b/.assets/pspace/secret/update.md new file mode 100644 index 0000000..790e50d --- /dev/null +++ b/.assets/pspace/secret/update.md @@ -0,0 +1,29 @@ +# pspace secret update + +Update a secret in a project or team. + +## Usage + +``` + secret update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md new file mode 100644 index 0000000..7849088 --- /dev/null +++ b/.assets/pspace/shared-drive.md @@ -0,0 +1,31 @@ +# pspace shared-drive + +Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +## Usage + +``` + shared-drive [command] + shared-drive [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/shared-drive/create.md b/.assets/pspace/shared-drive/create.md new file mode 100644 index 0000000..34dfd0c --- /dev/null +++ b/.assets/pspace/shared-drive/create.md @@ -0,0 +1,26 @@ +# pspace shared-drive create + +Create a shared drive. + +## Usage + +``` + shared-drive create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/delete.md b/.assets/pspace/shared-drive/delete.md new file mode 100644 index 0000000..e18f39b --- /dev/null +++ b/.assets/pspace/shared-drive/delete.md @@ -0,0 +1,22 @@ +# pspace shared-drive delete + +Delete a shared drive from a team. + +## Usage + +``` + shared-drive delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/get.md b/.assets/pspace/shared-drive/get.md new file mode 100644 index 0000000..d446156 --- /dev/null +++ b/.assets/pspace/shared-drive/get.md @@ -0,0 +1,22 @@ +# pspace shared-drive get + +Get a shared drive from a team. + +## Usage + +``` + shared-drive get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/help.md b/.assets/pspace/shared-drive/help.md new file mode 100644 index 0000000..4e1f0f4 --- /dev/null +++ b/.assets/pspace/shared-drive/help.md @@ -0,0 +1,23 @@ +# pspace shared-drive help + +Show help for a shared-drive command + +## Usage + +``` + shared-drive help [command] + shared-drive help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md new file mode 100644 index 0000000..ec6ec3e --- /dev/null +++ b/.assets/pspace/shared-drive/help/commands.md @@ -0,0 +1,27 @@ +# pspace shared-drive help commands + +List shared-drive commands + +Example: +``` +$ shared-drive help commands commands +``` + +## Usage + +``` + shared-drive help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/list.md b/.assets/pspace/shared-drive/list.md new file mode 100644 index 0000000..7359bfb --- /dev/null +++ b/.assets/pspace/shared-drive/list.md @@ -0,0 +1,34 @@ +# pspace shared-drive list + +List shared drives in your team or project. + +Pick a subset of fields to display: +``` +pspace shared-drive list -F name -F dtModified +``` + +## Usage + +``` + shared-drive list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md new file mode 100644 index 0000000..e664380 --- /dev/null +++ b/.assets/pspace/signup.md @@ -0,0 +1,21 @@ +# pspace signup + +This command opens the Paperspace signup page in your browser. + +## Usage + +``` + signup [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md new file mode 100644 index 0000000..3fe37e6 --- /dev/null +++ b/.assets/pspace/snapshot.md @@ -0,0 +1,31 @@ +# pspace snapshot + +Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +## Usage + +``` + snapshot [command] + snapshot [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [help](#help) +- [list](#list) +- [restore](#restore) diff --git a/.assets/pspace/snapshot/create.md b/.assets/pspace/snapshot/create.md new file mode 100644 index 0000000..fd1a91d --- /dev/null +++ b/.assets/pspace/snapshot/create.md @@ -0,0 +1,24 @@ +# pspace snapshot create + +Create a snapshot from a machine. + +## Usage + +``` + snapshot create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/delete.md b/.assets/pspace/snapshot/delete.md new file mode 100644 index 0000000..93663ed --- /dev/null +++ b/.assets/pspace/snapshot/delete.md @@ -0,0 +1,22 @@ +# pspace snapshot delete + +Delete a snapshot from a team. + +## Usage + +``` + snapshot delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/help.md b/.assets/pspace/snapshot/help.md new file mode 100644 index 0000000..1e48224 --- /dev/null +++ b/.assets/pspace/snapshot/help.md @@ -0,0 +1,23 @@ +# pspace snapshot help + +Show help for a snapshot command + +## Usage + +``` + snapshot help [command] + snapshot help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md new file mode 100644 index 0000000..7c5f454 --- /dev/null +++ b/.assets/pspace/snapshot/help/commands.md @@ -0,0 +1,27 @@ +# pspace snapshot help commands + +List snapshot commands + +Example: +``` +$ snapshot help commands commands +``` + +## Usage + +``` + snapshot help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/list.md b/.assets/pspace/snapshot/list.md new file mode 100644 index 0000000..59678f2 --- /dev/null +++ b/.assets/pspace/snapshot/list.md @@ -0,0 +1,34 @@ +# pspace snapshot list + +List snapshots in your team. + +Pick a subset of fields to display: +``` +pspace snapshot list -F name -F dtModified +``` + +## Usage + +``` + snapshot list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/restore.md b/.assets/pspace/snapshot/restore.md new file mode 100644 index 0000000..0cc1b84 --- /dev/null +++ b/.assets/pspace/snapshot/restore.md @@ -0,0 +1,23 @@ +# pspace snapshot restore + +Restore a machine to a snapshot. + +## Usage + +``` + snapshot restore [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md new file mode 100644 index 0000000..e2c9337 --- /dev/null +++ b/.assets/pspace/startup-script.md @@ -0,0 +1,31 @@ +# pspace startup-script + +Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. + +## Usage + +``` + startup-script [command] + startup-script [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [unassign](#unassign) +- [update](#update) diff --git a/.assets/pspace/startup-script/assign.md b/.assets/pspace/startup-script/assign.md new file mode 100644 index 0000000..f913d40 --- /dev/null +++ b/.assets/pspace/startup-script/assign.md @@ -0,0 +1,23 @@ +# pspace startup-script assign + +Assign a startup script to a machine. + +## Usage + +``` + startup-script assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/create.md b/.assets/pspace/startup-script/create.md new file mode 100644 index 0000000..688450b --- /dev/null +++ b/.assets/pspace/startup-script/create.md @@ -0,0 +1,25 @@ +# pspace startup-script create + +Create a startup script. + +## Usage + +``` + startup-script create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/delete.md b/.assets/pspace/startup-script/delete.md new file mode 100644 index 0000000..236d9f4 --- /dev/null +++ b/.assets/pspace/startup-script/delete.md @@ -0,0 +1,22 @@ +# pspace startup-script delete + +Delete a startup script from a team. + +## Usage + +``` + startup-script delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/get.md b/.assets/pspace/startup-script/get.md new file mode 100644 index 0000000..b3e49a2 --- /dev/null +++ b/.assets/pspace/startup-script/get.md @@ -0,0 +1,22 @@ +# pspace startup-script get + +Get a startup script from a team. + +## Usage + +``` + startup-script get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/help.md b/.assets/pspace/startup-script/help.md new file mode 100644 index 0000000..4e4c0b8 --- /dev/null +++ b/.assets/pspace/startup-script/help.md @@ -0,0 +1,23 @@ +# pspace startup-script help + +Show help for a startup-script command + +## Usage + +``` + startup-script help [command] + startup-script help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md new file mode 100644 index 0000000..84d6b42 --- /dev/null +++ b/.assets/pspace/startup-script/help/commands.md @@ -0,0 +1,27 @@ +# pspace startup-script help commands + +List startup-script commands + +Example: +``` +$ startup-script help commands commands +``` + +## Usage + +``` + startup-script help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/list.md b/.assets/pspace/startup-script/list.md new file mode 100644 index 0000000..cd887ae --- /dev/null +++ b/.assets/pspace/startup-script/list.md @@ -0,0 +1,33 @@ +# pspace startup-script list + +List startup scripts in your team. + +Pick a subset of fields to display: +``` +pspace startup-script list -F name -F dtCreated +``` + +## Usage + +``` + startup-script list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/unassign.md b/.assets/pspace/startup-script/unassign.md new file mode 100644 index 0000000..dfc3c28 --- /dev/null +++ b/.assets/pspace/startup-script/unassign.md @@ -0,0 +1,23 @@ +# pspace startup-script unassign + +Unassign a startup script from a machine. + +## Usage + +``` + startup-script unassign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/update.md b/.assets/pspace/startup-script/update.md new file mode 100644 index 0000000..e90c9b7 --- /dev/null +++ b/.assets/pspace/startup-script/update.md @@ -0,0 +1,26 @@ +# pspace startup-script update + +Update a startup script. + +## Usage + +``` + startup-script update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md new file mode 100644 index 0000000..cd1d679 --- /dev/null +++ b/.assets/pspace/storage-provider.md @@ -0,0 +1,30 @@ +# pspace storage-provider + +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +## Usage + +``` + storage-provider [command] + storage-provider [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/storage-provider/create.md b/.assets/pspace/storage-provider/create.md new file mode 100644 index 0000000..3ff4704 --- /dev/null +++ b/.assets/pspace/storage-provider/create.md @@ -0,0 +1,24 @@ +# pspace storage-provider create + +Create a storage provider. + +## Usage + +``` + storage-provider create [command] + storage-provider create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) diff --git a/.assets/pspace/storage-provider/create/help.md b/.assets/pspace/storage-provider/create/help.md new file mode 100644 index 0000000..8dbdea0 --- /dev/null +++ b/.assets/pspace/storage-provider/create/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider create help + +Show help for a create command + +## Usage + +``` + storage-provider create help [command] + storage-provider create help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md new file mode 100644 index 0000000..33d6790 --- /dev/null +++ b/.assets/pspace/storage-provider/create/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider create help commands + +List create commands + +Example: +``` +$ storage-provider create help commands commands +``` + +## Usage + +``` + storage-provider create help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/create/s3.md b/.assets/pspace/storage-provider/create/s3.md new file mode 100644 index 0000000..a15d5dc --- /dev/null +++ b/.assets/pspace/storage-provider/create/s3.md @@ -0,0 +1,31 @@ +# pspace storage-provider create s3 + +Create an S3 storage provider. + +## Usage + +``` + storage-provider create s3 [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/delete.md b/.assets/pspace/storage-provider/delete.md new file mode 100644 index 0000000..66dd46a --- /dev/null +++ b/.assets/pspace/storage-provider/delete.md @@ -0,0 +1,22 @@ +# pspace storage-provider delete + +Delete a storage provider from a team. + +## Usage + +``` + storage-provider delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/get.md b/.assets/pspace/storage-provider/get.md new file mode 100644 index 0000000..3b0df82 --- /dev/null +++ b/.assets/pspace/storage-provider/get.md @@ -0,0 +1,22 @@ +# pspace storage-provider get + +Get a storage provider from a team. + +## Usage + +``` + storage-provider get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/help.md b/.assets/pspace/storage-provider/help.md new file mode 100644 index 0000000..09574c1 --- /dev/null +++ b/.assets/pspace/storage-provider/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider help + +Show help for a storage-provider command + +## Usage + +``` + storage-provider help [command] + storage-provider help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md new file mode 100644 index 0000000..f53a9ef --- /dev/null +++ b/.assets/pspace/storage-provider/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider help commands + +List storage-provider commands + +Example: +``` +$ storage-provider help commands commands +``` + +## Usage + +``` + storage-provider help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/list.md b/.assets/pspace/storage-provider/list.md new file mode 100644 index 0000000..24e571b --- /dev/null +++ b/.assets/pspace/storage-provider/list.md @@ -0,0 +1,32 @@ +# pspace storage-provider list + +List storage providers in your team or project. + +Pick a subset of fields to display: +``` +pspace storage provider list -F name -F dtModified +``` + +## Usage + +``` + storage-provider list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/update.md b/.assets/pspace/storage-provider/update.md new file mode 100644 index 0000000..020100d --- /dev/null +++ b/.assets/pspace/storage-provider/update.md @@ -0,0 +1,24 @@ +# pspace storage-provider update + +Update a storage provider. + +## Usage + +``` + storage-provider update [command] + storage-provider update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) diff --git a/.assets/pspace/storage-provider/update/help.md b/.assets/pspace/storage-provider/update/help.md new file mode 100644 index 0000000..11b6715 --- /dev/null +++ b/.assets/pspace/storage-provider/update/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider update help + +Show help for a update command + +## Usage + +``` + storage-provider update help [command] + storage-provider update help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md new file mode 100644 index 0000000..e5d1c4c --- /dev/null +++ b/.assets/pspace/storage-provider/update/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider update help commands + +List update commands + +Example: +``` +$ storage-provider update help commands commands +``` + +## Usage + +``` + storage-provider update help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/update/s3.md b/.assets/pspace/storage-provider/update/s3.md new file mode 100644 index 0000000..6b3c9ca --- /dev/null +++ b/.assets/pspace/storage-provider/update/s3.md @@ -0,0 +1,31 @@ +# pspace storage-provider update s3 + +Update an S3 storage provider in a project or team. + +## Usage + +``` + storage-provider update s3 [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md new file mode 100644 index 0000000..1316caa --- /dev/null +++ b/.assets/pspace/up.md @@ -0,0 +1,54 @@ +# pspace up + +This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` +$ pspace up +``` + +Deploy the app using a config file. +``` +$ pspace up -c paperspace.json +``` + +Deploy an app in a different directory. +``` +$ pspace up --cwd ../my-app +``` + +## Usage + +``` + up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md new file mode 100644 index 0000000..96d9f8f --- /dev/null +++ b/.assets/pspace/upgrade.md @@ -0,0 +1,34 @@ +# pspace upgrade + +This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` +brew upgrade pspace +``` + +If you installed `pspace` using the install script, you can upgrade by +running: +``` +pspace upgrade +``` + +## Usage + +``` + upgrade [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md new file mode 100644 index 0000000..5a49e4c --- /dev/null +++ b/.assets/pspace/version.md @@ -0,0 +1,21 @@ +# pspace version + +Shows version information command, including version number and build date. + +## Usage + +``` + version [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index c2c5f0b..f26c833 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -1,9 +1,6 @@ import { app } from "../zcli.ts"; import { root } from "../commands/mod.ts"; -import { - zcliJson, - ZcliJsonCommand, -} from "https://deno.land/x/zcli@1.3.3/zcli-json.ts"; +import { zcliJson, ZcliJsonCommand } from "./zcli-json.ts"; // Read the markdown file adjacent to this script const json = await zcliJson(app, root); @@ -15,18 +12,15 @@ await Deno.writeTextFile( ); // Also generate markdown for the CLI -let markdown = ""; -markdown += "# Paperspace CLI\n\n"; -markdown += json.info.description + "\n\n"; - -function renderCommand(path: string[], command: ZcliJsonCommand) { - markdown += `## ${path.join(" ")}\n\n`; +async function renderCommand(path: string[], command: ZcliJsonCommand) { + let markdown = ""; + markdown += `# ${path.join(" ")}\n\n`; markdown += command.description + "\n\n"; - markdown += "### Usage\n\n"; + markdown += "## Usage\n\n"; markdown += `\`\`\`\n`; markdown += `${command.usage}\n`; markdown += "\`\`\`\n\n"; - markdown += "### Flags\n\n"; + markdown += "## Flags\n\n"; markdown += "| Name | Aliases | Description | Required |\n"; markdown += "| --- | --- | --- | --- |\n"; for (const flag of command.flags) { @@ -40,13 +34,20 @@ function renderCommand(path: string[], command: ZcliJsonCommand) { for (const subcommand of command.commands) { markdown += `- [${subcommand.name}](#${subcommand.name})\n`; } + + if (path.length >= 2) { + await Deno.mkdir(`.assets/${path.slice(0, -1).join("/")}`, { + recursive: true, + }); + } + await Deno.writeTextFile(`.assets/${path.join("/")}.md`, markdown, { + create: true, + }); for (const subcommand of command.commands) { - renderCommand([...path, subcommand.name], subcommand); + await renderCommand([...path, subcommand.name], subcommand); } } for (const command of json.commands) { - renderCommand([command.name], command); + await renderCommand([command.name], command); } - -await Deno.writeTextFile(".assets/pspace.md", markdown); diff --git a/.scripts/zcli-json.ts b/.scripts/zcli-json.ts new file mode 100644 index 0000000..6ed3695 --- /dev/null +++ b/.scripts/zcli-json.ts @@ -0,0 +1,228 @@ +// deno-lint-ignore-file no-explicit-any +import { CommandFactory } from "https://deno.land/x/zcli@1.3.3/init.ts"; +import { + flag, + flags, + getDefault, + innerType, + walkFlags, +} from "https://deno.land/x/zcli@1.3.3/flags.ts"; +import { Command } from "https://deno.land/x/zcli@1.3.3/command.ts"; +import * as intl from "https://deno.land/x/zcli@1.3.3/intl.ts"; +import { z } from "https://deno.land/x/zcli@1.3.3/z.ts"; +import zodToJsonSchema from "https://esm.sh/zod-to-json-schema@3.20.4"; +import { walkArgs } from "https://deno.land/x/zcli@1.3.3/args.ts"; + +export async function zcliJson< + Context extends { + meta: { version: string; date?: string; commit?: string }; + }, +>( + commandFactory: CommandFactory, + root: Command, +): Promise { + let json: ZcliJson; + + function zcliJsonCommand< + Context extends { + meta: { version: string; date?: string; commit?: string }; + }, + >(commandFactory: CommandFactory, options: { + /** + * Change the name of the command + * @default "zcli.json" + */ + name?: string; + /** + * Add aliases for the command + */ + aliases?: string[]; + /** + * Whether the command should be hidden from users + * @default true + */ + hidden?: boolean; + } = {}) { + const { name = "zcli.json", hidden = true, aliases } = options; + + return commandFactory.command(name, { + short: + "Prints the CLI command structure to a specification with JSONSchemas.", + long: ` + Prints the CLI command structure to a specification with JSONSchemas. This is + useful for the purposes of outputting your command structure in a documentable + format. + `, + hidden, + aliases, + flags: flags({ + all: flag( + { + aliases: ["a"], + short: "Show all commands and flags, including hidden ones.", + long: + `Show all commands and flags in the output, including hidden ones.`, + }, + ).boolean().default(false), + }), + }) + .run(function ({ args, flags, ctx }) { + ctx = { ...ctx }; + // @ts-expect-error: it's fine + ctx.root = root; + + function generateCommand( + command: Command, + path: string[], + ): ZcliJsonCommand { + const commands: ZcliJsonCommand[] = []; + + for ( + const cmd of intl.collate(command.commands, { + get(cmd) { + return cmd.name; + }, + }) + ) { + if (flags.all || !cmd.hidden) { + commands.push(generateCommand(cmd, [...path, cmd.name])); + } + } + + const context = { ...ctx, path }; + + const a: any[] = []; + const hasOptionalArgs = args instanceof z.ZodOptional || + args instanceof z.ZodDefault; + + walkArgs(command.args, (arg, { position, variadic }) => { + a.push({ + position, + summary: (arg.description ?? "").trim(), + required: !hasOptionalArgs, + variadic, + schema: zodToJsonSchema(arg as any, { strictUnions: true }), + }); + }); + + const commandFlags: any[] = []; + + walkFlags(command.flags, (flag, name) => { + if ((flag.hidden && !flags.all)) return; + const collects = flag instanceof z.ZodArray || + flag._def.innerType instanceof z.ZodArray; + const itemType = collects + ? flag instanceof z.ZodArray + ? flag._def.type + : flag._def.innerType._def.type + : flag; + const defaultValue = getDefault(flag); + + commandFlags.push({ + name, + aliases: flag.aliases, + description: flag.long(context) || flag.short(context) || "", + summary: flag.short(context) || "", + required: !(flag instanceof z.ZodOptional) && + !(flag instanceof z.ZodDefault) && name !== "help", + collects, + negatable: flag.negatable, + default: defaultValue, + global: flag.__global, + schema: zodToJsonSchema( + name === "help" + ? z.boolean().default(false) + : collects + ? itemType + : innerType(flag), + { strictUnions: true }, + ), + }); + }); + + return { + name: command.name, + description: command.long(context) || command.short(context) || "", + summary: command.short(context) ?? "", + usage: command.usage(context), + deprecated: command.deprecated, + arguments: command.args + ? { + description: command.args.long(context) ?? "", + summary: command.args.short(context) ?? "", + items: a, + } + : undefined, + flags: commandFlags, + commands: commands, + }; + } + + json = { + "zcli": "1.0.0", + info: { + name: root.name, + version: ctx?.meta.version, + commit: ctx?.meta.commit, + buildDate: ctx?.meta.date, + description: root.long(ctx) || root.short(ctx) || "", + summary: root.short(ctx) || "", + }, + commands: [generateCommand(root, [])], + }; + }); + } + + const command = zcliJsonCommand(commandFactory); + await command.execute([]); + return json!; +} + +export type ZcliJson = { + zcli: "1.0.0"; + info: { + name: string; + version: string; + commit?: string; + buildDate?: string; + description: string; + summary: string; + }; + commands: ZcliJsonCommand[]; +}; + +export type ZcliJsonCommand = { + name: string; + summary: string; + description: string; + usage: string; + deprecated?: string; + arguments: undefined | { + description: string; + summary: string; + items: ZcliJsonArgument[]; + }; + flags: ZcliJsonFlag[]; + commands: ZcliJsonCommand[]; +}; + +export type ZcliJsonArgument = { + position: number; + summary: string; + required: boolean; + variadic: boolean; + schema: any; +}; + +export type ZcliJsonFlag = { + name: string; + aliases: string[]; + description?: string; + summary?: string; + required: boolean; + collects: boolean; + negatable: boolean; + global: boolean; + default?: any; + schema: any; +}; diff --git a/deno.lock b/deno.lock index bf1f1bd..21d2682 100644 --- a/deno.lock +++ b/deno.lock @@ -1,5 +1,5 @@ { - "version": "2", + "version": "3", "remote": { "https://deno.land/std@0.179.0/_util/asserts.ts": "178dfc49a464aee693a7e285567b3d0b555dc805ff490505a8aae34f9cfb1462", "https://deno.land/std@0.179.0/_util/os.ts": "d932f56d41e4f6a6093d56044e29ce637f8dcc43c5a90af43504a889cf1775e3", @@ -60,7 +60,6 @@ "https://deno.land/std@0.179.0/encoding/jsonc.ts": "02b86115d2b812f26789481ebcf4748171e8ece6514b60243b3733e2c200876a", "https://deno.land/std@0.179.0/encoding/toml.ts": "d11fc659365218035ec1d92c1dfa206718838954a6de7cfc62d0a07ffb19f582", "https://deno.land/std@0.179.0/encoding/yaml.ts": "02571d1bbbcfd7c5647789cee872ecf9c1c470e1b1a40948ed219fb661e19d87", - "https://deno.land/std@0.179.0/flags/mod.ts": "d1cdefa18472ef69858a17df5cf7c98445ed27ac10e1460183081303b0ebc270", "https://deno.land/std@0.179.0/fmt/bytes.ts": "f3cdd34c7a5063c296e198cf9b7000774033283d469716e6b7741f4167bdaf46", "https://deno.land/std@0.179.0/fmt/colors.ts": "938c5d44d889fb82eff6c358bea8baa7e85950a16c9f6dae3ec3a7a729164471", "https://deno.land/std@0.179.0/fmt/printf.ts": "e5b426cd6ad13df5d408e9c375c025d59de30e380c5534715bd892df874ab057", @@ -106,13 +105,6 @@ "https://deno.land/std@0.179.0/streams/write_all.ts": "3b2e1ce44913f966348ce353d02fa5369e94115181037cd8b602510853ec3033", "https://deno.land/std@0.179.0/streams/writer_from_stream_writer.ts": "31126a6bf2e678c5a718011d4831dbe75dbdbd885965d3dbd5dd105e6f20f976", "https://deno.land/std@0.179.0/streams/zip_readable_streams.ts": "9eb82070d83055fe6f077192fb204dc7612695a4b330148e9aa376df1a65e708", - "https://deno.land/std@0.179.0/testing/_diff.ts": "1a3c044aedf77647d6cac86b798c6417603361b66b54c53331b312caeb447aea", - "https://deno.land/std@0.179.0/testing/_format.ts": "a69126e8a469009adf4cf2a50af889aca364c349797e63174884a52ff75cf4c7", - "https://deno.land/std@0.179.0/testing/_test_suite.ts": "30f018feeb3835f12ab198d8a518f9089b1bcb2e8c838a8b615ab10d5005465c", - "https://deno.land/std@0.179.0/testing/asserts.ts": "984ab0bfb3faeed92ffaa3a6b06536c66811185328c5dd146257c702c41b01ab", - "https://deno.land/std@0.179.0/testing/bdd.ts": "c5ca6d85940dbcc19b4d2bc3608d49ab65d81470aa91306d5efa4b0d5c945731", - "https://deno.land/std@0.179.0/testing/mock.ts": "220ed9b8151cb2cac141043d4cfea7c47673fab5d18d1c1f0943297c8afb5d13", - "https://deno.land/std@0.179.0/types.d.ts": "220ed56662a0bd393ba5d124aa6ae2ad36a00d2fcbc0e8666a65f4606aaa9784", "https://deno.land/x/ansi@1.0.1/clear.ts": "444d83749bd171a38e77a7a7d5d270bbf84fbb0ea21f0a62e60c931a11f2bfc1", "https://deno.land/x/ansi@1.0.1/constants.ts": "aa51274a1402e017e043f544542e895880eadd67cca3e424884ed228813144bb", "https://deno.land/x/ansi@1.0.1/cursor.ts": "cbba999f0f87865401490541e1bf098573491d1c6be411852eaed58f4e39716a", @@ -254,7 +246,6 @@ "https://deno.land/x/zcli@1.3.3/mod.ts": "bdf98129a4f2d5b9e4d1446e252765f3c0df64289b5094b3c7cc287b42ebee12", "https://deno.land/x/zcli@1.3.3/version.ts": "793bc7245ccefda0f924017b2d973ec4258519c6b89b75f1f2ad91c3966ce3aa", "https://deno.land/x/zcli@1.3.3/z.ts": "3ece197424db8241978f2867426ceee02c72a53dc406142cf767b3a33560ebe5", - "https://deno.land/x/zcli@1.3.3/zcli-json.ts": "bf090cbd9c6222ad331ca01382e967e669286b19ea5cd550ebfc7fd2d7384323", "https://deno.land/x/zcli@1.3.3/zod-proxy.ts": "b5cb0c33445e7170c0c021340a6ce45747df76662d0d76ba4eeb6e606ffab115", "https://deno.land/x/zod@v3.21.4/ZodError.ts": "4de18ff525e75a0315f2c12066b77b5c2ae18c7c15ef7df7e165d63536fdf2ea", "https://deno.land/x/zod@v3.21.4/errors.ts": "5285922d2be9700cc0c70c95e4858952b07ae193aa0224be3cbd5cd5567eabef", @@ -269,191 +260,9 @@ "https://deno.land/x/zod@v3.21.4/locales/en.ts": "a7a25cd23563ccb5e0eed214d9b31846305ddbcdb9c5c8f508b108943366ab4c", "https://deno.land/x/zod@v3.21.4/mod.ts": "64e55237cb4410e17d968cd08975566059f27638ebb0b86048031b987ba251c4", "https://deno.land/x/zod@v3.21.4/types.ts": "b5d061babea250de14fc63764df5b3afa24f2b088a1d797fc060ba49a0ddff28", - "https://esm.sh/v111/zod@3.21.4/deno/zod.js": "ef6535dd2aa5c37b49464e9f474f5e59252e3f50f7f03183d43e997be3f62263", - "https://esm.sh/v111/zod@3.21.4/index.d.ts": "b51c954b9557b1dcb03b2bf34cd136e710cb9aa276e686cac0e291249590a52a", - "https://esm.sh/v111/zod@3.21.4/lib/ZodError.d.ts": "1f19511459549a66526d9dcc3b2288e59fa5fd4cf42b390a945d0bdc289806df", - "https://esm.sh/v111/zod@3.21.4/lib/errors.d.ts": "5ec2790f877581637c058eb5bbb72e855a078620d0781d2a6a8f308fe1d5436f", - "https://esm.sh/v111/zod@3.21.4/lib/external.d.ts": "91cec2fe1e1fb2574812a29a57ad2c39a1e69b0fa1179547382c92649fc5c66e", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/enumUtil.d.ts": "f672c876c1a04a223cf2023b3d91e8a52bb1544c576b81bf64a8fec82be9969c", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/errorUtil.d.ts": "98a9cc18f661d28e6bd31c436e1984f3980f35e0f0aa9cf795c54f8ccb667ffe", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/parseUtil.d.ts": "d3dbfc2f2fbf2c1bdea72db72f9f5c95d2ca5b4d32c9e229764ebaba0920203c", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/partialUtil.d.ts": "be2da97df422506d54e0e1727a40f6315c7311931b65a552b3172148db734c43", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/typeAliases.d.ts": "5487b97cfa28b26b4a9ef0770f872bdbebd4c46124858de00f242c3eed7519f4", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/util.d.ts": "7a01f546ace66019156e4232a1bee2fabc2f8eabeb052473d926ee1693956265", - "https://esm.sh/v111/zod@3.21.4/lib/index.d.ts": "e6e0b04af1500398c8840582cce03d8907d6475005eb490f0e07bb33db6da66c", - "https://esm.sh/v111/zod@3.21.4/lib/locales/en.d.ts": "f8ec1611afb8d132c6c71822718805866890cf2071025153af97508eff24e4b6", - "https://esm.sh/v111/zod@3.21.4/lib/types.d.ts": "d7eecca2a9e02b2b2f51eaef95956f490a5780d03b32b9865068a63a26810f01", - "https://esm.sh/v112/zod-to-json-schema@3.20.4/deno/zod-to-json-schema.mjs": "44fabb5e833c12b2c22e5bc58227a94effd7971e29837ad9b637333c1d2981a8", - "https://esm.sh/v112/zod@3.21.4/deno/zod.mjs": "652b3e1f40b7dbb5b32d5c4d4fc7f1cbe06b0cf87c16cb7cd0c62f8ce9457406", - "https://esm.sh/zod-to-json-schema@3.20.4": "8f7f0db5c072058e1508a855afe8897189a0a177c18f72134004798c183e4c3e" - }, - "npm": { - "specifiers": { - "openapi-typescript": "openapi-typescript@6.2.0", - "openapi-typescript@6.2.0": "openapi-typescript@6.2.0" - }, - "packages": { - "@nodelib/fs.scandir@2.1.5": { - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dependencies": { - "@nodelib/fs.stat": "@nodelib/fs.stat@2.0.5", - "run-parallel": "run-parallel@1.2.0" - } - }, - "@nodelib/fs.stat@2.0.5": { - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dependencies": {} - }, - "@nodelib/fs.walk@1.2.8": { - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "dependencies": { - "@nodelib/fs.scandir": "@nodelib/fs.scandir@2.1.5", - "fastq": "fastq@1.15.0" - } - }, - "ansi-colors@4.1.3": { - "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", - "dependencies": {} - }, - "argparse@2.0.1": { - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dependencies": {} - }, - "braces@3.0.2": { - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dependencies": { - "fill-range": "fill-range@7.0.1" - } - }, - "busboy@1.6.0": { - "integrity": "sha512-8SFQbg/0hQ9xy3UNTB0YEnsNBbWfhf7RtnzpL7TkBiTBRfrQ9Fxcnz7VJsleJpyp6rVLvXiuORqjlHi5q+PYuA==", - "dependencies": { - "streamsearch": "streamsearch@1.1.0" - } - }, - "fast-glob@3.2.12": { - "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", - "dependencies": { - "@nodelib/fs.stat": "@nodelib/fs.stat@2.0.5", - "@nodelib/fs.walk": "@nodelib/fs.walk@1.2.8", - "glob-parent": "glob-parent@5.1.2", - "merge2": "merge2@1.4.1", - "micromatch": "micromatch@4.0.5" - } - }, - "fastq@1.15.0": { - "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==", - "dependencies": { - "reusify": "reusify@1.0.4" - } - }, - "fill-range@7.0.1": { - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dependencies": { - "to-regex-range": "to-regex-range@5.0.1" - } - }, - "glob-parent@5.1.2": { - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dependencies": { - "is-glob": "is-glob@4.0.3" - } - }, - "is-extglob@2.1.1": { - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dependencies": {} - }, - "is-glob@4.0.3": { - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dependencies": { - "is-extglob": "is-extglob@2.1.1" - } - }, - "is-number@7.0.0": { - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dependencies": {} - }, - "js-yaml@4.1.0": { - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dependencies": { - "argparse": "argparse@2.0.1" - } - }, - "merge2@1.4.1": { - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dependencies": {} - }, - "micromatch@4.0.5": { - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", - "dependencies": { - "braces": "braces@3.0.2", - "picomatch": "picomatch@2.3.1" - } - }, - "openapi-typescript@6.1.1": { - "integrity": "sha512-KKoe2ZfALfMRo7hbi7T7fP6hr7770l6/FbwGPNMCLwMj4gYqLIGf49bR2gnPrCDQG1XbC65M8XGCnvF/E+aI9g==", - "dependencies": { - "ansi-colors": "ansi-colors@4.1.3", - "fast-glob": "fast-glob@3.2.12", - "js-yaml": "js-yaml@4.1.0", - "supports-color": "supports-color@9.3.1", - "undici": "undici@5.20.0", - "yargs-parser": "yargs-parser@21.1.1" - } - }, - "openapi-typescript@6.2.0": { - "integrity": "sha512-d1HF70HCUnU+g9hgX5X3MJ+BMgwX16fzwD6mkyfNqdxXuOTOSkm+O+aaFqLNX13aFbCylz4m2WiVe4viAShxiQ==", - "dependencies": { - "ansi-colors": "ansi-colors@4.1.3", - "fast-glob": "fast-glob@3.2.12", - "js-yaml": "js-yaml@4.1.0", - "supports-color": "supports-color@9.3.1", - "undici": "undici@5.20.0", - "yargs-parser": "yargs-parser@21.1.1" - } - }, - "picomatch@2.3.1": { - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dependencies": {} - }, - "queue-microtask@1.2.3": { - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dependencies": {} - }, - "reusify@1.0.4": { - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dependencies": {} - }, - "run-parallel@1.2.0": { - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dependencies": { - "queue-microtask": "queue-microtask@1.2.3" - } - }, - "streamsearch@1.1.0": { - "integrity": "sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==", - "dependencies": {} - }, - "supports-color@9.3.1": { - "integrity": "sha512-knBY82pjmnIzK3NifMo3RxEIRD9E0kIzV4BKcyTZ9+9kWgLMxd4PrsTSMoFQUabgRBbF8KOLRDCyKgNV+iK44Q==", - "dependencies": {} - }, - "to-regex-range@5.0.1": { - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dependencies": { - "is-number": "is-number@7.0.0" - } - }, - "undici@5.20.0": { - "integrity": "sha512-J3j60dYzuo6Eevbawwp1sdg16k5Tf768bxYK4TUJRH7cBM4kFCbf3mOnM/0E3vQYXvpxITbbWmBafaDbxLDz3g==", - "dependencies": { - "busboy": "busboy@1.6.0" - } - }, - "yargs-parser@21.1.1": { - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "dependencies": {} - } - } + "https://esm.sh/v135/zod-to-json-schema@3.20.4/denonext/zod-to-json-schema.mjs": "069fd005ad8095b36b1e2d65359f7e9850012429126972728a565c83fcd5ad5c", + "https://esm.sh/v135/zod@3.22.4/denonext/zod.mjs": "660128af5d1e921745c4d452472d103d9f2fc5afa508bbf233b83d35a272ad67", + "https://esm.sh/v135/zod@3.23.8/denonext/zod.mjs": "b3707b03ddc01aab11b740436ab23c0fcc8d15fed072be20085c1fd611016b61", + "https://esm.sh/zod-to-json-schema@3.20.4": "6420a5b1f4ab016d902b3e552dcfe1048c1f3e92b2f5d7b171598a00d3df7e32" } } From 0b0b9cfe173f25da785024e0e83acd47ff09ebed Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 23 May 2024 15:22:27 -0400 Subject: [PATCH 05/10] docs --- .assets/pspace.json | 2 +- .assets/pspace.md | 58 - .assets/pspace/autoscaling-group.md | 191 + .assets/pspace/autoscaling-group/create.md | 31 - .assets/pspace/autoscaling-group/delete.md | 22 - .assets/pspace/autoscaling-group/get.md | 22 - .assets/pspace/autoscaling-group/help.md | 23 - .../pspace/autoscaling-group/help/commands.md | 27 - .assets/pspace/autoscaling-group/list.md | 34 - .assets/pspace/autoscaling-group/update.md | 32 - .assets/pspace/completion.md | 175 + .assets/pspace/completion/bash.md | 43 - .assets/pspace/completion/fish.md | 34 - .assets/pspace/completion/help.md | 23 - .assets/pspace/completion/help/commands.md | 27 - .assets/pspace/completion/zsh.md | 48 - .assets/pspace/config.md | 119 + .assets/pspace/config/delete.md | 21 - .assets/pspace/config/get.md | 27 - .assets/pspace/config/help.md | 23 - .assets/pspace/config/help/commands.md | 27 - .assets/pspace/config/set.md | 21 - .assets/pspace/custom-template.md | 153 + .assets/pspace/custom-template/create.md | 24 - .assets/pspace/custom-template/delete.md | 22 - .assets/pspace/custom-template/get.md | 22 - .assets/pspace/custom-template/help.md | 23 - .../pspace/custom-template/help/commands.md | 27 - .assets/pspace/custom-template/list.md | 35 - .assets/pspace/dataset.md | 382 ++ .assets/pspace/dataset/create.md | 26 - .assets/pspace/dataset/delete.md | 22 - .assets/pspace/dataset/get.md | 22 - .assets/pspace/dataset/help.md | 23 - .assets/pspace/dataset/help/commands.md | 27 - .assets/pspace/dataset/list.md | 32 - .assets/pspace/dataset/update.md | 24 - .assets/pspace/dataset/versions.md | 30 - .assets/pspace/dataset/versions/create.md | 24 - .assets/pspace/dataset/versions/delete.md | 23 - .assets/pspace/dataset/versions/get.md | 23 - .assets/pspace/dataset/versions/help.md | 23 - .../pspace/dataset/versions/help/commands.md | 27 - .assets/pspace/dataset/versions/list.md | 32 - .assets/pspace/dataset/versions/update.md | 24 - .assets/pspace/deployment.md | 199 + .assets/pspace/deployment/delete.md | 26 - .assets/pspace/deployment/get.md | 32 - .assets/pspace/deployment/help.md | 23 - .assets/pspace/deployment/help/commands.md | 27 - .assets/pspace/deployment/list.md | 32 - .assets/pspace/deployment/up.md | 59 - .assets/pspace/help.md | 27 + .assets/pspace/help/commands.md | 27 - .assets/pspace/machine-event.md | 106 + .assets/pspace/machine-event/get.md | 22 - .assets/pspace/machine-event/help.md | 23 - .assets/pspace/machine-event/help/commands.md | 27 - .assets/pspace/machine-event/list.md | 34 - .assets/pspace/machine.md | 275 ++ .assets/pspace/machine/create.md | 43 - .assets/pspace/machine/delete.md | 22 - .assets/pspace/machine/get.md | 22 - .assets/pspace/machine/help.md | 23 - .assets/pspace/machine/help/commands.md | 27 - .assets/pspace/machine/list.md | 36 - .assets/pspace/machine/restart.md | 22 - .assets/pspace/machine/start.md | 22 - .assets/pspace/machine/stop.md | 22 - .assets/pspace/machine/update.md | 36 - .assets/pspace/model.md | 154 + .assets/pspace/model/create.md | 28 - .assets/pspace/model/delete.md | 22 - .assets/pspace/model/get.md | 22 - .assets/pspace/model/help.md | 23 - .assets/pspace/model/help/commands.md | 27 - .assets/pspace/model/list.md | 32 - .assets/pspace/os-template.md | 83 + .assets/pspace/os-template/help.md | 23 - .assets/pspace/os-template/help/commands.md | 27 - .assets/pspace/os-template/list.md | 33 - .assets/pspace/private-network.md | 152 + .assets/pspace/private-network/create.md | 24 - .assets/pspace/private-network/delete.md | 22 - .assets/pspace/private-network/get.md | 22 - .assets/pspace/private-network/help.md | 23 - .../pspace/private-network/help/commands.md | 27 - .assets/pspace/private-network/list.md | 34 - .assets/pspace/project.md | 218 + .assets/pspace/project/create.md | 23 - .assets/pspace/project/delete.md | 23 - .assets/pspace/project/get.md | 23 - .assets/pspace/project/help.md | 23 - .assets/pspace/project/help/commands.md | 27 - .assets/pspace/project/link.md | 39 - .assets/pspace/project/list.md | 32 - .assets/pspace/project/update.md | 28 - .assets/pspace/pspace.md | 4386 +++++++++++++++++ .assets/pspace/public-ip.md | 151 + .assets/pspace/public-ip/assign.md | 23 - .assets/pspace/public-ip/claim.md | 23 - .assets/pspace/public-ip/help.md | 23 - .assets/pspace/public-ip/help/commands.md | 27 - .assets/pspace/public-ip/list.md | 33 - .assets/pspace/public-ip/release.md | 22 - .assets/pspace/secret.md | 207 + .assets/pspace/secret/create.md | 29 - .assets/pspace/secret/delete.md | 29 - .assets/pspace/secret/get.md | 30 - .assets/pspace/secret/help.md | 23 - .assets/pspace/secret/help/commands.md | 27 - .assets/pspace/secret/list.md | 40 - .assets/pspace/secret/update.md | 29 - .assets/pspace/shared-drive.md | 154 + .assets/pspace/shared-drive/create.md | 26 - .assets/pspace/shared-drive/delete.md | 22 - .assets/pspace/shared-drive/get.md | 22 - .assets/pspace/shared-drive/help.md | 23 - .assets/pspace/shared-drive/help/commands.md | 27 - .assets/pspace/shared-drive/list.md | 34 - .assets/pspace/snapshot.md | 153 + .assets/pspace/snapshot/create.md | 24 - .assets/pspace/snapshot/delete.md | 22 - .assets/pspace/snapshot/help.md | 23 - .assets/pspace/snapshot/help/commands.md | 27 - .assets/pspace/snapshot/list.md | 34 - .assets/pspace/snapshot/restore.md | 23 - .assets/pspace/startup-script.md | 224 + .assets/pspace/startup-script/assign.md | 23 - .assets/pspace/startup-script/create.md | 25 - .assets/pspace/startup-script/delete.md | 22 - .assets/pspace/startup-script/get.md | 22 - .assets/pspace/startup-script/help.md | 23 - .../pspace/startup-script/help/commands.md | 27 - .assets/pspace/startup-script/list.md | 33 - .assets/pspace/startup-script/unassign.md | 23 - .assets/pspace/startup-script/update.md | 26 - .assets/pspace/storage-provider.md | 336 ++ .assets/pspace/storage-provider/create.md | 24 - .../pspace/storage-provider/create/help.md | 23 - .../storage-provider/create/help/commands.md | 27 - .assets/pspace/storage-provider/create/s3.md | 31 - .assets/pspace/storage-provider/delete.md | 22 - .assets/pspace/storage-provider/get.md | 22 - .assets/pspace/storage-provider/help.md | 23 - .../pspace/storage-provider/help/commands.md | 27 - .assets/pspace/storage-provider/list.md | 32 - .assets/pspace/storage-provider/update.md | 24 - .../pspace/storage-provider/update/help.md | 23 - .../storage-provider/update/help/commands.md | 27 - .assets/pspace/storage-provider/update/s3.md | 31 - .scripts/generate-docs.ts | 34 +- 152 files changed, 7871 insertions(+), 3527 deletions(-) delete mode 100644 .assets/pspace.md delete mode 100644 .assets/pspace/autoscaling-group/create.md delete mode 100644 .assets/pspace/autoscaling-group/delete.md delete mode 100644 .assets/pspace/autoscaling-group/get.md delete mode 100644 .assets/pspace/autoscaling-group/help.md delete mode 100644 .assets/pspace/autoscaling-group/help/commands.md delete mode 100644 .assets/pspace/autoscaling-group/list.md delete mode 100644 .assets/pspace/autoscaling-group/update.md delete mode 100644 .assets/pspace/completion/bash.md delete mode 100644 .assets/pspace/completion/fish.md delete mode 100644 .assets/pspace/completion/help.md delete mode 100644 .assets/pspace/completion/help/commands.md delete mode 100644 .assets/pspace/completion/zsh.md delete mode 100644 .assets/pspace/config/delete.md delete mode 100644 .assets/pspace/config/get.md delete mode 100644 .assets/pspace/config/help.md delete mode 100644 .assets/pspace/config/help/commands.md delete mode 100644 .assets/pspace/config/set.md delete mode 100644 .assets/pspace/custom-template/create.md delete mode 100644 .assets/pspace/custom-template/delete.md delete mode 100644 .assets/pspace/custom-template/get.md delete mode 100644 .assets/pspace/custom-template/help.md delete mode 100644 .assets/pspace/custom-template/help/commands.md delete mode 100644 .assets/pspace/custom-template/list.md delete mode 100644 .assets/pspace/dataset/create.md delete mode 100644 .assets/pspace/dataset/delete.md delete mode 100644 .assets/pspace/dataset/get.md delete mode 100644 .assets/pspace/dataset/help.md delete mode 100644 .assets/pspace/dataset/help/commands.md delete mode 100644 .assets/pspace/dataset/list.md delete mode 100644 .assets/pspace/dataset/update.md delete mode 100644 .assets/pspace/dataset/versions.md delete mode 100644 .assets/pspace/dataset/versions/create.md delete mode 100644 .assets/pspace/dataset/versions/delete.md delete mode 100644 .assets/pspace/dataset/versions/get.md delete mode 100644 .assets/pspace/dataset/versions/help.md delete mode 100644 .assets/pspace/dataset/versions/help/commands.md delete mode 100644 .assets/pspace/dataset/versions/list.md delete mode 100644 .assets/pspace/dataset/versions/update.md delete mode 100644 .assets/pspace/deployment/delete.md delete mode 100644 .assets/pspace/deployment/get.md delete mode 100644 .assets/pspace/deployment/help.md delete mode 100644 .assets/pspace/deployment/help/commands.md delete mode 100644 .assets/pspace/deployment/list.md delete mode 100644 .assets/pspace/deployment/up.md delete mode 100644 .assets/pspace/help/commands.md delete mode 100644 .assets/pspace/machine-event/get.md delete mode 100644 .assets/pspace/machine-event/help.md delete mode 100644 .assets/pspace/machine-event/help/commands.md delete mode 100644 .assets/pspace/machine-event/list.md delete mode 100644 .assets/pspace/machine/create.md delete mode 100644 .assets/pspace/machine/delete.md delete mode 100644 .assets/pspace/machine/get.md delete mode 100644 .assets/pspace/machine/help.md delete mode 100644 .assets/pspace/machine/help/commands.md delete mode 100644 .assets/pspace/machine/list.md delete mode 100644 .assets/pspace/machine/restart.md delete mode 100644 .assets/pspace/machine/start.md delete mode 100644 .assets/pspace/machine/stop.md delete mode 100644 .assets/pspace/machine/update.md delete mode 100644 .assets/pspace/model/create.md delete mode 100644 .assets/pspace/model/delete.md delete mode 100644 .assets/pspace/model/get.md delete mode 100644 .assets/pspace/model/help.md delete mode 100644 .assets/pspace/model/help/commands.md delete mode 100644 .assets/pspace/model/list.md delete mode 100644 .assets/pspace/os-template/help.md delete mode 100644 .assets/pspace/os-template/help/commands.md delete mode 100644 .assets/pspace/os-template/list.md delete mode 100644 .assets/pspace/private-network/create.md delete mode 100644 .assets/pspace/private-network/delete.md delete mode 100644 .assets/pspace/private-network/get.md delete mode 100644 .assets/pspace/private-network/help.md delete mode 100644 .assets/pspace/private-network/help/commands.md delete mode 100644 .assets/pspace/private-network/list.md delete mode 100644 .assets/pspace/project/create.md delete mode 100644 .assets/pspace/project/delete.md delete mode 100644 .assets/pspace/project/get.md delete mode 100644 .assets/pspace/project/help.md delete mode 100644 .assets/pspace/project/help/commands.md delete mode 100644 .assets/pspace/project/link.md delete mode 100644 .assets/pspace/project/list.md delete mode 100644 .assets/pspace/project/update.md create mode 100644 .assets/pspace/pspace.md delete mode 100644 .assets/pspace/public-ip/assign.md delete mode 100644 .assets/pspace/public-ip/claim.md delete mode 100644 .assets/pspace/public-ip/help.md delete mode 100644 .assets/pspace/public-ip/help/commands.md delete mode 100644 .assets/pspace/public-ip/list.md delete mode 100644 .assets/pspace/public-ip/release.md delete mode 100644 .assets/pspace/secret/create.md delete mode 100644 .assets/pspace/secret/delete.md delete mode 100644 .assets/pspace/secret/get.md delete mode 100644 .assets/pspace/secret/help.md delete mode 100644 .assets/pspace/secret/help/commands.md delete mode 100644 .assets/pspace/secret/list.md delete mode 100644 .assets/pspace/secret/update.md delete mode 100644 .assets/pspace/shared-drive/create.md delete mode 100644 .assets/pspace/shared-drive/delete.md delete mode 100644 .assets/pspace/shared-drive/get.md delete mode 100644 .assets/pspace/shared-drive/help.md delete mode 100644 .assets/pspace/shared-drive/help/commands.md delete mode 100644 .assets/pspace/shared-drive/list.md delete mode 100644 .assets/pspace/snapshot/create.md delete mode 100644 .assets/pspace/snapshot/delete.md delete mode 100644 .assets/pspace/snapshot/help.md delete mode 100644 .assets/pspace/snapshot/help/commands.md delete mode 100644 .assets/pspace/snapshot/list.md delete mode 100644 .assets/pspace/snapshot/restore.md delete mode 100644 .assets/pspace/startup-script/assign.md delete mode 100644 .assets/pspace/startup-script/create.md delete mode 100644 .assets/pspace/startup-script/delete.md delete mode 100644 .assets/pspace/startup-script/get.md delete mode 100644 .assets/pspace/startup-script/help.md delete mode 100644 .assets/pspace/startup-script/help/commands.md delete mode 100644 .assets/pspace/startup-script/list.md delete mode 100644 .assets/pspace/startup-script/unassign.md delete mode 100644 .assets/pspace/startup-script/update.md delete mode 100644 .assets/pspace/storage-provider/create.md delete mode 100644 .assets/pspace/storage-provider/create/help.md delete mode 100644 .assets/pspace/storage-provider/create/help/commands.md delete mode 100644 .assets/pspace/storage-provider/create/s3.md delete mode 100644 .assets/pspace/storage-provider/delete.md delete mode 100644 .assets/pspace/storage-provider/get.md delete mode 100644 .assets/pspace/storage-provider/help.md delete mode 100644 .assets/pspace/storage-provider/help/commands.md delete mode 100644 .assets/pspace/storage-provider/list.md delete mode 100644 .assets/pspace/storage-provider/update.md delete mode 100644 .assets/pspace/storage-provider/update/help.md delete mode 100644 .assets/pspace/storage-provider/update/help/commands.md delete mode 100644 .assets/pspace/storage-provider/update/s3.md diff --git a/.assets/pspace.json b/.assets/pspace.json index 923da56..b45e4c0 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-22T15:40:50.043Z", + "buildDate": "2024-05-23T19:22:11.325Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, diff --git a/.assets/pspace.md b/.assets/pspace.md deleted file mode 100644 index 7028821..0000000 --- a/.assets/pspace.md +++ /dev/null @@ -1,58 +0,0 @@ -# pspace - -A CLI for using the Paperspace API. - -It allows you to authenticate, launch deployments, do logging, and more. - -* Deploy an ML app with the `deployment` command -* View a deployed app with the `deployment open` command -* Check the status of a deployment with the `deployment status` command - -Read the full documentation at: https://docs.paperspace.com/ - -## Usage - -``` - pspace [command] - pspace [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [autoscaling-group](#autoscaling-group) -- [completion](#completion) -- [config](#config) -- [console](#console) -- [custom-template](#custom-template) -- [dataset](#dataset) -- [deployment](#deployment) -- [docs](#docs) -- [help](#help) -- [init](#init) -- [login](#login) -- [logout](#logout) -- [machine](#machine) -- [machine-event](#machine-event) -- [model](#model) -- [os-template](#os-template) -- [private-network](#private-network) -- [project](#project) -- [public-ip](#public-ip) -- [secret](#secret) -- [shared-drive](#shared-drive) -- [signup](#signup) -- [snapshot](#snapshot) -- [startup-script](#startup-script) -- [storage-provider](#storage-provider) -- [up](#up) -- [upgrade](#upgrade) -- [version](#version) diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md index 0086595..8fc8a60 100644 --- a/.assets/pspace/autoscaling-group.md +++ b/.assets/pspace/autoscaling-group.md @@ -28,3 +28,194 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) +# pspace autoscaling-group create + +Create an autoscaling group. + +## Usage + +``` + autoscaling-group create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group delete + +Delete an autoscaling group from a team. + +## Usage + +``` + autoscaling-group delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group get + +Get an autoscaling group from a team. + +## Usage + +``` + autoscaling-group get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group help + +Show help for a autoscaling-group command + +## Usage + +``` + autoscaling-group help [command] + autoscaling-group help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace autoscaling-group help commands + +List autoscaling-group commands + +Example: +``` +$ autoscaling-group help commands commands +``` + +## Usage + +``` + autoscaling-group help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace autoscaling-group list + +List autoscaling groups in your team. + +Pick a subset of fields to display: +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +## Usage + +``` + autoscaling-group list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group update + +Update an autoscaling group. + +## Usage + +``` + autoscaling-group update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/create.md b/.assets/pspace/autoscaling-group/create.md deleted file mode 100644 index cb6a760..0000000 --- a/.assets/pspace/autoscaling-group/create.md +++ /dev/null @@ -1,31 +0,0 @@ -# pspace autoscaling-group create - -Create an autoscaling group. - -## Usage - -``` - autoscaling-group create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/autoscaling-group/delete.md b/.assets/pspace/autoscaling-group/delete.md deleted file mode 100644 index 4f332b4..0000000 --- a/.assets/pspace/autoscaling-group/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace autoscaling-group delete - -Delete an autoscaling group from a team. - -## Usage - -``` - autoscaling-group delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/autoscaling-group/get.md b/.assets/pspace/autoscaling-group/get.md deleted file mode 100644 index 3f7e032..0000000 --- a/.assets/pspace/autoscaling-group/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace autoscaling-group get - -Get an autoscaling group from a team. - -## Usage - -``` - autoscaling-group get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/autoscaling-group/help.md b/.assets/pspace/autoscaling-group/help.md deleted file mode 100644 index 3270e64..0000000 --- a/.assets/pspace/autoscaling-group/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace autoscaling-group help - -Show help for a autoscaling-group command - -## Usage - -``` - autoscaling-group help [command] - autoscaling-group help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md deleted file mode 100644 index 7c21fbb..0000000 --- a/.assets/pspace/autoscaling-group/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace autoscaling-group help commands - -List autoscaling-group commands - -Example: -``` -$ autoscaling-group help commands commands -``` - -## Usage - -``` - autoscaling-group help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/autoscaling-group/list.md b/.assets/pspace/autoscaling-group/list.md deleted file mode 100644 index f2c0eed..0000000 --- a/.assets/pspace/autoscaling-group/list.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace autoscaling-group list - -List autoscaling groups in your team. - -Pick a subset of fields to display: -``` -pspace autoscaling-group list -F name -F dtCreated -``` - -## Usage - -``` - autoscaling-group list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/autoscaling-group/update.md b/.assets/pspace/autoscaling-group/update.md deleted file mode 100644 index 46ba46a..0000000 --- a/.assets/pspace/autoscaling-group/update.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace autoscaling-group update - -Update an autoscaling group. - -## Usage - -``` - autoscaling-group update [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md index ca4ae3f..09c787b 100644 --- a/.assets/pspace/completion.md +++ b/.assets/pspace/completion.md @@ -25,3 +25,178 @@ See each sub-command's help for details on how to use the generated script. - [fish](#fish) - [help](#help) - [zsh](#zsh) +# pspace completion bash + +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: +``` +$ source <(completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: +``` +$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion bash [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace completion fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +``` +$ completion fish fish | source +``` + +To load completions for every new session, execute once: +``` +$ completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion fish [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace completion help + +Show help for a completion command + +## Usage + +``` + completion help [command] + completion help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace completion help commands + +List completion commands + +Example: +``` +$ completion help commands commands +``` + +## Usage + +``` + completion help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace completion zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: +``` +$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: +``` +$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion zsh [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion/bash.md b/.assets/pspace/completion/bash.md deleted file mode 100644 index 3534d87..0000000 --- a/.assets/pspace/completion/bash.md +++ /dev/null @@ -1,43 +0,0 @@ -# pspace completion bash - -Generate the autocompletion script for the bash shell. - -This script depends on the `bash-completion` package. -If it is not installed already, you can install it via your OS's package manager. - -To load completions in your current shell session: -``` -$ source <(completion bash bash) -``` - -To load completions for every new session, execute once: - -Linux: -``` -$ completion bash bash > /etc/bash_completion.d/pspace -``` - -macOS: -``` -$ completion bash bash > /usr/local/etc/bash_completion.d/pspace -``` - -You will need to start a new shell for this setup to take effect. - -## Usage - -``` - completion bash [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/completion/fish.md b/.assets/pspace/completion/fish.md deleted file mode 100644 index aeea101..0000000 --- a/.assets/pspace/completion/fish.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace completion fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: -``` -$ completion fish fish | source -``` - -To load completions for every new session, execute once: -``` -$ completion fish fish > ~/.config/fish/completions/pspace.fish -``` - -You will need to start a new shell for this setup to take effect. - -## Usage - -``` - completion fish [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/completion/help.md b/.assets/pspace/completion/help.md deleted file mode 100644 index 994b1d5..0000000 --- a/.assets/pspace/completion/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace completion help - -Show help for a completion command - -## Usage - -``` - completion help [command] - completion help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md deleted file mode 100644 index 642005b..0000000 --- a/.assets/pspace/completion/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace completion help commands - -List completion commands - -Example: -``` -$ completion help commands commands -``` - -## Usage - -``` - completion help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/completion/zsh.md b/.assets/pspace/completion/zsh.md deleted file mode 100644 index 45d8c01..0000000 --- a/.assets/pspace/completion/zsh.md +++ /dev/null @@ -1,48 +0,0 @@ -# pspace completion zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: - -``` -$ echo "autoload -U compinit; compinit" >> ~/.zshrc -``` - -To load completions for every new session, execute once: - -Linux: -``` -$ completion zsh zsh > "${fpath[1]}/_pspace" -``` - -macOS: -``` -$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace -``` - -Oh My Zsh: -``` -$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace -``` - -You will need to start a new shell for this setup to take effect. - -## Usage - -``` - completion zsh [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md index 8d59793..f24e496 100644 --- a/.assets/pspace/config.md +++ b/.assets/pspace/config.md @@ -33,3 +33,122 @@ pspace config set team "my-team" - [get](#get) - [help](#help) - [set](#set) +# pspace config delete + +Delete a configuration value. + +## Usage + +``` + config delete [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace config get + +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: +``` +pspace config get team +``` + +## Usage + +``` + config get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace config help + +Show help for a config command + +## Usage + +``` + config help [command] + config help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace config help commands + +List config commands + +Example: +``` +$ config help commands commands +``` + +## Usage + +``` + config help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace config set + +Set a configuration value. + +## Usage + +``` + config set [arguments] [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config/delete.md b/.assets/pspace/config/delete.md deleted file mode 100644 index 83cb5b2..0000000 --- a/.assets/pspace/config/delete.md +++ /dev/null @@ -1,21 +0,0 @@ -# pspace config delete - -Delete a configuration value. - -## Usage - -``` - config delete [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/config/get.md b/.assets/pspace/config/get.md deleted file mode 100644 index c13a592..0000000 --- a/.assets/pspace/config/get.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace config get - -This command gets a configuration value. You can pass a key to get a specific -value, or you can pass no arguments to get all configuration values. - -For example, to get the current team run: -``` -pspace config get team -``` - -## Usage - -``` - config get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/config/help.md b/.assets/pspace/config/help.md deleted file mode 100644 index 1ddb36f..0000000 --- a/.assets/pspace/config/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace config help - -Show help for a config command - -## Usage - -``` - config help [command] - config help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md deleted file mode 100644 index e749bf5..0000000 --- a/.assets/pspace/config/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace config help commands - -List config commands - -Example: -``` -$ config help commands commands -``` - -## Usage - -``` - config help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/config/set.md b/.assets/pspace/config/set.md deleted file mode 100644 index 82c69b6..0000000 --- a/.assets/pspace/config/set.md +++ /dev/null @@ -1,21 +0,0 @@ -# pspace config set - -Set a configuration value. - -## Usage - -``` - config set [arguments] [arguments...] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md index e7d12c4..36f7f87 100644 --- a/.assets/pspace/custom-template.md +++ b/.assets/pspace/custom-template.md @@ -29,3 +29,156 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. - [get](#get) - [help](#help) - [list](#list) +# pspace custom-template create + +Create a custom template from a machine. + +## Usage + +``` + custom-template create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template delete + +Delete a custom template from a team. + +## Usage + +``` + custom-template delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template get + +Get a custom template from a team. + +## Usage + +``` + custom-template get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template help + +Show help for a custom-template command + +## Usage + +``` + custom-template help [command] + custom-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace custom-template help commands + +List custom-template commands + +Example: +``` +$ custom-template help commands commands +``` + +## Usage + +``` + custom-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace custom-template list + +List custom templates in your team. + +Pick a subset of fields to display: +``` +pspace custom-template list -F name -F dtModified +``` + +## Usage + +``` + custom-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/create.md b/.assets/pspace/custom-template/create.md deleted file mode 100644 index 00b1f0d..0000000 --- a/.assets/pspace/custom-template/create.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace custom-template create - -Create a custom template from a machine. - -## Usage - -``` - custom-template create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/custom-template/delete.md b/.assets/pspace/custom-template/delete.md deleted file mode 100644 index 24b083a..0000000 --- a/.assets/pspace/custom-template/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace custom-template delete - -Delete a custom template from a team. - -## Usage - -``` - custom-template delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/custom-template/get.md b/.assets/pspace/custom-template/get.md deleted file mode 100644 index 8eb97ef..0000000 --- a/.assets/pspace/custom-template/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace custom-template get - -Get a custom template from a team. - -## Usage - -``` - custom-template get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/custom-template/help.md b/.assets/pspace/custom-template/help.md deleted file mode 100644 index 6868f7d..0000000 --- a/.assets/pspace/custom-template/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace custom-template help - -Show help for a custom-template command - -## Usage - -``` - custom-template help [command] - custom-template help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md deleted file mode 100644 index e074c6f..0000000 --- a/.assets/pspace/custom-template/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace custom-template help commands - -List custom-template commands - -Example: -``` -$ custom-template help commands commands -``` - -## Usage - -``` - custom-template help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/custom-template/list.md b/.assets/pspace/custom-template/list.md deleted file mode 100644 index 4d67c93..0000000 --- a/.assets/pspace/custom-template/list.md +++ /dev/null @@ -1,35 +0,0 @@ -# pspace custom-template list - -List custom templates in your team. - -Pick a subset of fields to display: -``` -pspace custom-template list -F name -F dtModified -``` - -## Usage - -``` - custom-template list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md index ad0111f..e4df5ad 100644 --- a/.assets/pspace/dataset.md +++ b/.assets/pspace/dataset.md @@ -29,3 +29,385 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) +# pspace dataset create + +Create a dataset. + +## Usage + +``` + dataset create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset delete + +Delete a dataset from a team. + +## Usage + +``` + dataset delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset get + +Get a dataset from a team. + +## Usage + +``` + dataset get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset help + +Show help for a dataset command + +## Usage + +``` + dataset help [command] + dataset help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace dataset help commands + +List dataset commands + +Example: +``` +$ dataset help commands commands +``` + +## Usage + +``` + dataset help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace dataset list + +List datasets in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset list -F name -F dtModified +``` + +## Usage + +``` + dataset list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset update + +Update a dataset in a project or team. + +## Usage + +``` + dataset update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions + +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +## Usage + +``` + dataset versions [command] + dataset versions [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +# pspace dataset versions create + +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +## Usage + +``` + dataset versions create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions delete + +Delete a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions delete [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions get + +Get a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions get [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions help + +Show help for a versions command + +## Usage + +``` + dataset versions help [command] + dataset versions help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace dataset versions help commands + +List versions commands + +Example: +``` +$ dataset versions help commands commands +``` + +## Usage + +``` + dataset versions help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace dataset versions list + +List dataset versions in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset versions list -F name -F dtModified +``` + +## Usage + +``` + dataset versions list [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions update + +Update a dataset version in a project or team. + +## Usage + +``` + dataset versions update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/create.md b/.assets/pspace/dataset/create.md deleted file mode 100644 index 966ab9b..0000000 --- a/.assets/pspace/dataset/create.md +++ /dev/null @@ -1,26 +0,0 @@ -# pspace dataset create - -Create a dataset. - -## Usage - -``` - dataset create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/delete.md b/.assets/pspace/dataset/delete.md deleted file mode 100644 index 8cf4617..0000000 --- a/.assets/pspace/dataset/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace dataset delete - -Delete a dataset from a team. - -## Usage - -``` - dataset delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/get.md b/.assets/pspace/dataset/get.md deleted file mode 100644 index 46aa312..0000000 --- a/.assets/pspace/dataset/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace dataset get - -Get a dataset from a team. - -## Usage - -``` - dataset get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/help.md b/.assets/pspace/dataset/help.md deleted file mode 100644 index 12b4586..0000000 --- a/.assets/pspace/dataset/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace dataset help - -Show help for a dataset command - -## Usage - -``` - dataset help [command] - dataset help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md deleted file mode 100644 index d848fd7..0000000 --- a/.assets/pspace/dataset/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace dataset help commands - -List dataset commands - -Example: -``` -$ dataset help commands commands -``` - -## Usage - -``` - dataset help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/list.md b/.assets/pspace/dataset/list.md deleted file mode 100644 index 7242d70..0000000 --- a/.assets/pspace/dataset/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace dataset list - -List datasets in your team or project. - -Pick a subset of fields to display: -``` -pspace dataset list -F name -F dtModified -``` - -## Usage - -``` - dataset list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/update.md b/.assets/pspace/dataset/update.md deleted file mode 100644 index a9efa84..0000000 --- a/.assets/pspace/dataset/update.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace dataset update - -Update a dataset in a project or team. - -## Usage - -``` - dataset update [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions.md b/.assets/pspace/dataset/versions.md deleted file mode 100644 index 9cfa3ec..0000000 --- a/.assets/pspace/dataset/versions.md +++ /dev/null @@ -1,30 +0,0 @@ -# pspace dataset versions - -Manage your dataset versions. - -For more information, see https://docs.paperspace.com/storage/datasetVersions. - -## Usage - -``` - dataset versions [command] - dataset versions [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) diff --git a/.assets/pspace/dataset/versions/create.md b/.assets/pspace/dataset/versions/create.md deleted file mode 100644 index ed307c4..0000000 --- a/.assets/pspace/dataset/versions/create.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace dataset versions create - -Create a dataset version. This command will prompt you for an ID if you don't -provide one. - -## Usage - -``` - dataset versions create [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions/delete.md b/.assets/pspace/dataset/versions/delete.md deleted file mode 100644 index 3234bc6..0000000 --- a/.assets/pspace/dataset/versions/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace dataset versions delete - -Delete a dataset version from a team. This command will prompt you for an ID -if you don't provide one. - -## Usage - -``` - dataset versions delete [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions/get.md b/.assets/pspace/dataset/versions/get.md deleted file mode 100644 index c072be6..0000000 --- a/.assets/pspace/dataset/versions/get.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace dataset versions get - -Get a dataset version from a team. This command will prompt you for an ID -if you don't provide one. - -## Usage - -``` - dataset versions get [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions/help.md b/.assets/pspace/dataset/versions/help.md deleted file mode 100644 index 4cb4876..0000000 --- a/.assets/pspace/dataset/versions/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace dataset versions help - -Show help for a versions command - -## Usage - -``` - dataset versions help [command] - dataset versions help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md deleted file mode 100644 index af2d37a..0000000 --- a/.assets/pspace/dataset/versions/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace dataset versions help commands - -List versions commands - -Example: -``` -$ dataset versions help commands commands -``` - -## Usage - -``` - dataset versions help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions/list.md b/.assets/pspace/dataset/versions/list.md deleted file mode 100644 index 291e70d..0000000 --- a/.assets/pspace/dataset/versions/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace dataset versions list - -List dataset versions in your team or project. - -Pick a subset of fields to display: -``` -pspace dataset versions list -F name -F dtModified -``` - -## Usage - -``` - dataset versions list [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/dataset/versions/update.md b/.assets/pspace/dataset/versions/update.md deleted file mode 100644 index aa85218..0000000 --- a/.assets/pspace/dataset/versions/update.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace dataset versions update - -Update a dataset version in a project or team. - -## Usage - -``` - dataset versions update [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md index 873960b..112991b 100644 --- a/.assets/pspace/deployment.md +++ b/.assets/pspace/deployment.md @@ -25,3 +25,202 @@ Effortlessly deploy ML apps to Paperspace. - [help](#help) - [list](#list) - [up](#up) +# pspace deployment delete + +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +## Usage + +``` + deployment delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment get + +Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +## Usage + +``` + deployment get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment help + +Show help for a deployment command + +## Usage + +``` + deployment help [command] + deployment help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace deployment help commands + +List deployment commands + +Example: +``` +$ deployment help commands commands +``` + +## Usage + +``` + deployment help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace deployment list + +List deployments in your team. + +Pick a subset of fields to display: +``` +pspace deployment list -F id -F name +``` + +## Usage + +``` + deployment list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment up + +This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. +``` +$ pspace deployment create --project-id 1234 +``` + +## Usage + +``` + deployment up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/delete.md b/.assets/pspace/deployment/delete.md deleted file mode 100644 index 7df1430..0000000 --- a/.assets/pspace/deployment/delete.md +++ /dev/null @@ -1,26 +0,0 @@ -# pspace deployment delete - -Delete a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 -``` - -## Usage - -``` - deployment delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/deployment/get.md b/.assets/pspace/deployment/get.md deleted file mode 100644 index 492e10e..0000000 --- a/.assets/pspace/deployment/get.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace deployment get - -Get a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -``` - -Pick a subset of fields to display: -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name -``` - -## Usage - -``` - deployment get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/deployment/help.md b/.assets/pspace/deployment/help.md deleted file mode 100644 index 5dc0208..0000000 --- a/.assets/pspace/deployment/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace deployment help - -Show help for a deployment command - -## Usage - -``` - deployment help [command] - deployment help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md deleted file mode 100644 index 5afdb31..0000000 --- a/.assets/pspace/deployment/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace deployment help commands - -List deployment commands - -Example: -``` -$ deployment help commands commands -``` - -## Usage - -``` - deployment help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/deployment/list.md b/.assets/pspace/deployment/list.md deleted file mode 100644 index d73e118..0000000 --- a/.assets/pspace/deployment/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace deployment list - -List deployments in your team. - -Pick a subset of fields to display: -``` -pspace deployment list -F id -F name -``` - -## Usage - -``` - deployment list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/deployment/up.md b/.assets/pspace/deployment/up.md deleted file mode 100644 index bf886a8..0000000 --- a/.assets/pspace/deployment/up.md +++ /dev/null @@ -1,59 +0,0 @@ -# pspace deployment up - -This will create a new deployment for your app or update it if it already exists. -You can optionally specify a path to a config file. If no config file is specified, -the default config file paths will be tried. - -Create a new deployment for the app in the current directory. -``` -$ pspace deployment create -``` - -Create a new deployment using a config file. -``` -$ pspace deployment create -c paperspace.json -``` - -Create a new deployment for an app in a different directory. -``` -$ pspace deployment create --cwd ../my-app -``` - -Create a new deployment for an app in a specific project. -``` -$ pspace deployment create --project-id 1234 -``` - -## Usage - -``` - deployment up [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md index 677a8cf..e3c02cf 100644 --- a/.assets/pspace/help.md +++ b/.assets/pspace/help.md @@ -21,3 +21,30 @@ Show help for a pspace command ### Subcommands - [commands](#commands) +# pspace help commands + +List pspace commands + +Example: +``` +$ help commands commands +``` + +## Usage + +``` + help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md deleted file mode 100644 index ed803ff..0000000 --- a/.assets/pspace/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace help commands - -List pspace commands - -Example: -``` -$ help commands commands -``` - -## Usage - -``` - help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md index 732f134..e31573b 100644 --- a/.assets/pspace/machine-event.md +++ b/.assets/pspace/machine-event.md @@ -27,3 +27,109 @@ For more information, see https://docs.paperspace.com/machines. - [get](#get) - [help](#help) - [list](#list) +# pspace machine-event get + +Get a machine event from a team. + +## Usage + +``` + machine-event get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine-event help + +Show help for a machine-event command + +## Usage + +``` + machine-event help [command] + machine-event help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace machine-event help commands + +List machine-event commands + +Example: +``` +$ machine-event help commands commands +``` + +## Usage + +``` + machine-event help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace machine-event list + +List machine events in your team. + +Pick a subset of fields to display: +``` +pspace machine-event list -F name -F dtModified +``` + +## Usage + +``` + machine-event list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event/get.md b/.assets/pspace/machine-event/get.md deleted file mode 100644 index 3452ed5..0000000 --- a/.assets/pspace/machine-event/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine-event get - -Get a machine event from a team. - -## Usage - -``` - machine-event get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine-event/help.md b/.assets/pspace/machine-event/help.md deleted file mode 100644 index 703391a..0000000 --- a/.assets/pspace/machine-event/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace machine-event help - -Show help for a machine-event command - -## Usage - -``` - machine-event help [command] - machine-event help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md deleted file mode 100644 index 9bb10fd..0000000 --- a/.assets/pspace/machine-event/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace machine-event help commands - -List machine-event commands - -Example: -``` -$ machine-event help commands commands -``` - -## Usage - -``` - machine-event help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/machine-event/list.md b/.assets/pspace/machine-event/list.md deleted file mode 100644 index a3d73ab..0000000 --- a/.assets/pspace/machine-event/list.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace machine-event list - -List machine events in your team. - -Pick a subset of fields to display: -``` -pspace machine-event list -F name -F dtModified -``` - -## Usage - -``` - machine-event list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md index be849f2..9fd1422 100644 --- a/.assets/pspace/machine.md +++ b/.assets/pspace/machine.md @@ -31,3 +31,278 @@ For more information, see https://docs.paperspace.com/machines. - [start](#start) - [stop](#stop) - [update](#update) +# pspace machine create + +Create a machine. + +## Usage + +``` + machine create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine delete + +Delete a machine from a team. + +## Usage + +``` + machine delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine get + +Get a machine from a team. + +## Usage + +``` + machine get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine help + +Show help for a machine command + +## Usage + +``` + machine help [command] + machine help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace machine help commands + +List machine commands + +Example: +``` +$ machine help commands commands +``` + +## Usage + +``` + machine help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace machine list + +List machines in your team. + +Pick a subset of fields to display: +``` +pspace machine list -F name -F dtModified +``` + +## Usage + +``` + machine list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine restart + +Restart a machine from a team. + +## Usage + +``` + machine restart [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine start + +Start a machine from a team. + +## Usage + +``` + machine start [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine stop + +Stop a machine from a team. + +## Usage + +``` + machine stop [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine update + +Update a machine's settings. + +## Usage + +``` + machine update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/create.md b/.assets/pspace/machine/create.md deleted file mode 100644 index 46568ad..0000000 --- a/.assets/pspace/machine/create.md +++ /dev/null @@ -1,43 +0,0 @@ -# pspace machine create - -Create a machine. - -## Usage - -``` - machine create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/delete.md b/.assets/pspace/machine/delete.md deleted file mode 100644 index 81770c3..0000000 --- a/.assets/pspace/machine/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine delete - -Delete a machine from a team. - -## Usage - -``` - machine delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/get.md b/.assets/pspace/machine/get.md deleted file mode 100644 index 8fb70f3..0000000 --- a/.assets/pspace/machine/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine get - -Get a machine from a team. - -## Usage - -``` - machine get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/help.md b/.assets/pspace/machine/help.md deleted file mode 100644 index 1b773fe..0000000 --- a/.assets/pspace/machine/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace machine help - -Show help for a machine command - -## Usage - -``` - machine help [command] - machine help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md deleted file mode 100644 index 5d8375b..0000000 --- a/.assets/pspace/machine/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace machine help commands - -List machine commands - -Example: -``` -$ machine help commands commands -``` - -## Usage - -``` - machine help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/machine/list.md b/.assets/pspace/machine/list.md deleted file mode 100644 index c5f942c..0000000 --- a/.assets/pspace/machine/list.md +++ /dev/null @@ -1,36 +0,0 @@ -# pspace machine list - -List machines in your team. - -Pick a subset of fields to display: -``` -pspace machine list -F name -F dtModified -``` - -## Usage - -``` - machine list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/restart.md b/.assets/pspace/machine/restart.md deleted file mode 100644 index f0abfa5..0000000 --- a/.assets/pspace/machine/restart.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine restart - -Restart a machine from a team. - -## Usage - -``` - machine restart [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/start.md b/.assets/pspace/machine/start.md deleted file mode 100644 index f9299be..0000000 --- a/.assets/pspace/machine/start.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine start - -Start a machine from a team. - -## Usage - -``` - machine start [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/stop.md b/.assets/pspace/machine/stop.md deleted file mode 100644 index bd02344..0000000 --- a/.assets/pspace/machine/stop.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace machine stop - -Stop a machine from a team. - -## Usage - -``` - machine stop [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/machine/update.md b/.assets/pspace/machine/update.md deleted file mode 100644 index a5bf1bc..0000000 --- a/.assets/pspace/machine/update.md +++ /dev/null @@ -1,36 +0,0 @@ -# pspace machine update - -Update a machine's settings. - -## Usage - -``` - machine update [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md index 361cde1..0e24693 100644 --- a/.assets/pspace/model.md +++ b/.assets/pspace/model.md @@ -27,3 +27,157 @@ For more information, see https://docs.paperspace.com/deploying/models. - [get](#get) - [help](#help) - [list](#list) +# pspace model create + +Create a new model. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + model create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model delete + +Delete a model from a team. + +## Usage + +``` + model delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model get + +Get a model from a team. + +## Usage + +``` + model get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model help + +Show help for a model command + +## Usage + +``` + model help [command] + model help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace model help commands + +List model commands + +Example: +``` +$ model help commands commands +``` + +## Usage + +``` + model help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace model list + +List models in your team. + +Pick a subset of fields to display: +``` +pspace model list -F name -F dtModified +``` + +## Usage + +``` + model list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/create.md b/.assets/pspace/model/create.md deleted file mode 100644 index b7f06a4..0000000 --- a/.assets/pspace/model/create.md +++ /dev/null @@ -1,28 +0,0 @@ -# pspace model create - -Create a new model. This command will prompt you for a name if you don't -provide one. - -## Usage - -``` - model create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/model/delete.md b/.assets/pspace/model/delete.md deleted file mode 100644 index d18204b..0000000 --- a/.assets/pspace/model/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace model delete - -Delete a model from a team. - -## Usage - -``` - model delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/model/get.md b/.assets/pspace/model/get.md deleted file mode 100644 index b467036..0000000 --- a/.assets/pspace/model/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace model get - -Get a model from a team. - -## Usage - -``` - model get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/model/help.md b/.assets/pspace/model/help.md deleted file mode 100644 index 9df28c6..0000000 --- a/.assets/pspace/model/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace model help - -Show help for a model command - -## Usage - -``` - model help [command] - model help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md deleted file mode 100644 index be3d3c5..0000000 --- a/.assets/pspace/model/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace model help commands - -List model commands - -Example: -``` -$ model help commands commands -``` - -## Usage - -``` - model help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/model/list.md b/.assets/pspace/model/list.md deleted file mode 100644 index 9202299..0000000 --- a/.assets/pspace/model/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace model list - -List models in your team. - -Pick a subset of fields to display: -``` -pspace model list -F name -F dtModified -``` - -## Usage - -``` - model list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md index ffd377d..2794b08 100644 --- a/.assets/pspace/os-template.md +++ b/.assets/pspace/os-template.md @@ -25,3 +25,86 @@ For more information, see https://docs.paperspace.com/compute/os-templates. - [help](#help) - [list](#list) +# pspace os-template help + +Show help for a os-template command + +## Usage + +``` + os-template help [command] + os-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace os-template help commands + +List os-template commands + +Example: +``` +$ os-template help commands commands +``` + +## Usage + +``` + os-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace os-template list + +List OS templates. + +Pick a subset of fields to display: +``` +pspace os-template list -F name +``` + +## Usage + +``` + os-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/os-template/help.md b/.assets/pspace/os-template/help.md deleted file mode 100644 index c04c5ea..0000000 --- a/.assets/pspace/os-template/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace os-template help - -Show help for a os-template command - -## Usage - -``` - os-template help [command] - os-template help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md deleted file mode 100644 index 2667495..0000000 --- a/.assets/pspace/os-template/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace os-template help commands - -List os-template commands - -Example: -``` -$ os-template help commands commands -``` - -## Usage - -``` - os-template help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/os-template/list.md b/.assets/pspace/os-template/list.md deleted file mode 100644 index 8228eb9..0000000 --- a/.assets/pspace/os-template/list.md +++ /dev/null @@ -1,33 +0,0 @@ -# pspace os-template list - -List OS templates. - -Pick a subset of fields to display: -``` -pspace os-template list -F name -``` - -## Usage - -``` - os-template list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md index 34e5a57..664df28 100644 --- a/.assets/pspace/private-network.md +++ b/.assets/pspace/private-network.md @@ -29,3 +29,155 @@ For more information, see https://docs.paperspace.com/networking/private-network - [get](#get) - [help](#help) - [list](#list) +# pspace private-network create + +Create a private network. + +## Usage + +``` + private-network create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network delete + +Delete a private network from a team. + +## Usage + +``` + private-network delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network get + +Get a private network from a team. + +## Usage + +``` + private-network get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network help + +Show help for a private-network command + +## Usage + +``` + private-network help [command] + private-network help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace private-network help commands + +List private-network commands + +Example: +``` +$ private-network help commands commands +``` + +## Usage + +``` + private-network help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace private-network list + +List private networks in your team. + +Pick a subset of fields to display: +``` +pspace private-network list -F name -F dtModified +``` + +## Usage + +``` + private-network list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/create.md b/.assets/pspace/private-network/create.md deleted file mode 100644 index 988f218..0000000 --- a/.assets/pspace/private-network/create.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace private-network create - -Create a private network. - -## Usage - -``` - private-network create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/private-network/delete.md b/.assets/pspace/private-network/delete.md deleted file mode 100644 index 4cbe68f..0000000 --- a/.assets/pspace/private-network/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace private-network delete - -Delete a private network from a team. - -## Usage - -``` - private-network delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/private-network/get.md b/.assets/pspace/private-network/get.md deleted file mode 100644 index 4207a19..0000000 --- a/.assets/pspace/private-network/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace private-network get - -Get a private network from a team. - -## Usage - -``` - private-network get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/private-network/help.md b/.assets/pspace/private-network/help.md deleted file mode 100644 index 35a0a7f..0000000 --- a/.assets/pspace/private-network/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace private-network help - -Show help for a private-network command - -## Usage - -``` - private-network help [command] - private-network help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md deleted file mode 100644 index 1f003c5..0000000 --- a/.assets/pspace/private-network/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace private-network help commands - -List private-network commands - -Example: -``` -$ private-network help commands commands -``` - -## Usage - -``` - private-network help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/private-network/list.md b/.assets/pspace/private-network/list.md deleted file mode 100644 index 928d6eb..0000000 --- a/.assets/pspace/private-network/list.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace private-network list - -List private networks in your team. - -Pick a subset of fields to display: -``` -pspace private-network list -F name -F dtModified -``` - -## Usage - -``` - private-network list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md index 313e241..64bd150 100644 --- a/.assets/pspace/project.md +++ b/.assets/pspace/project.md @@ -27,3 +27,221 @@ Manage your Paperspace projects. - [link](#link) - [list](#list) - [update](#update) +# pspace project create + +Create a new project. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + project create [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project delete + +Delete a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project get + +Get a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project help + +Show help for a project command + +## Usage + +``` + project help [command] + project help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace project help commands + +List project commands + +Example: +``` +$ project help commands commands +``` + +## Usage + +``` + project help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace project link + +This will link a remote project to a local directory. Commands that +depend on a project ID will use the project ID of the linked project +when communicating with the Paperspace API. + +Link a project to the current directory. +``` +$ pspace link +``` + +Link a project to a different directory. +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. +``` +$ pspace link pzwf2g05ubegj +``` + +## Usage + +``` + project link [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project list + +List projects in your team. + +Pick a subset of fields to display: +``` +pspace project list -F id -F name -F dtCreated +``` + +## Usage + +``` + project list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project update + +Update an existing project. + +Example: +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +## Usage + +``` + pspace project update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/create.md b/.assets/pspace/project/create.md deleted file mode 100644 index 10e69f3..0000000 --- a/.assets/pspace/project/create.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace project create - -Create a new project. This command will prompt you for a name if you don't -provide one. - -## Usage - -``` - project create [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project/delete.md b/.assets/pspace/project/delete.md deleted file mode 100644 index ba58c68..0000000 --- a/.assets/pspace/project/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace project delete - -Delete a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -## Usage - -``` - project delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project/get.md b/.assets/pspace/project/get.md deleted file mode 100644 index e70d249..0000000 --- a/.assets/pspace/project/get.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace project get - -Get a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -## Usage - -``` - project get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project/help.md b/.assets/pspace/project/help.md deleted file mode 100644 index a485416..0000000 --- a/.assets/pspace/project/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace project help - -Show help for a project command - -## Usage - -``` - project help [command] - project help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md deleted file mode 100644 index 7ed866b..0000000 --- a/.assets/pspace/project/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace project help commands - -List project commands - -Example: -``` -$ project help commands commands -``` - -## Usage - -``` - project help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/project/link.md b/.assets/pspace/project/link.md deleted file mode 100644 index a200990..0000000 --- a/.assets/pspace/project/link.md +++ /dev/null @@ -1,39 +0,0 @@ -# pspace project link - -This will link a remote project to a local directory. Commands that -depend on a project ID will use the project ID of the linked project -when communicating with the Paperspace API. - -Link a project to the current directory. -``` -$ pspace link -``` - -Link a project to a different directory. -``` -$ pspace link --cwd ../my-app -``` - -Link a project and specify a project ID. -``` -$ pspace link pzwf2g05ubegj -``` - -## Usage - -``` - project link [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project/list.md b/.assets/pspace/project/list.md deleted file mode 100644 index 823bc80..0000000 --- a/.assets/pspace/project/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace project list - -List projects in your team. - -Pick a subset of fields to display: -``` -pspace project list -F id -F name -F dtCreated -``` - -## Usage - -``` - project list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/project/update.md b/.assets/pspace/project/update.md deleted file mode 100644 index 9ad171e..0000000 --- a/.assets/pspace/project/update.md +++ /dev/null @@ -1,28 +0,0 @@ -# pspace project update - -Update an existing project. - -Example: -``` -pspace project update psukfyemho7 --name my-cool-project -``` - -## Usage - -``` - pspace project update [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md new file mode 100644 index 0000000..a420565 --- /dev/null +++ b/.assets/pspace/pspace.md @@ -0,0 +1,4386 @@ +# pspace + +A CLI for using the Paperspace API. + +It allows you to authenticate, launch deployments, do logging, and more. + +* Deploy an ML app with the `deployment` command +* View a deployed app with the `deployment open` command +* Check the status of a deployment with the `deployment status` command + +Read the full documentation at: https://docs.paperspace.com/ + +## Usage + +``` + pspace [command] + pspace [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [autoscaling-group](#autoscaling-group) +- [completion](#completion) +- [config](#config) +- [console](#console) +- [custom-template](#custom-template) +- [dataset](#dataset) +- [deployment](#deployment) +- [docs](#docs) +- [help](#help) +- [init](#init) +- [login](#login) +- [logout](#logout) +- [machine](#machine) +- [machine-event](#machine-event) +- [model](#model) +- [os-template](#os-template) +- [private-network](#private-network) +- [project](#project) +- [public-ip](#public-ip) +- [secret](#secret) +- [shared-drive](#shared-drive) +- [signup](#signup) +- [snapshot](#snapshot) +- [startup-script](#startup-script) +- [storage-provider](#storage-provider) +- [up](#up) +- [upgrade](#upgrade) +- [version](#version) +# pspace autoscaling-group + +Manage your autoscaling groups. Autoscaling groups enable using +the Kubernetes cluster-autoscaler to automatically scale your cluster. +You can also autoscaling groups as a primitive for your own autoscaler. + +## Usage + +``` + autoscaling-group [command] + autoscaling-group [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +# pspace autoscaling-group create + +Create an autoscaling group. + +## Usage + +``` + autoscaling-group create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group delete + +Delete an autoscaling group from a team. + +## Usage + +``` + autoscaling-group delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group get + +Get an autoscaling group from a team. + +## Usage + +``` + autoscaling-group get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group help + +Show help for a autoscaling-group command + +## Usage + +``` + autoscaling-group help [command] + autoscaling-group help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace autoscaling-group help commands + +List autoscaling-group commands + +Example: +``` +$ autoscaling-group help commands commands +``` + +## Usage + +``` + autoscaling-group help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace autoscaling-group list + +List autoscaling groups in your team. + +Pick a subset of fields to display: +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +## Usage + +``` + autoscaling-group list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace autoscaling-group update + +Update an autoscaling group. + +## Usage + +``` + autoscaling-group update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace completion + +Generate an autocompletion script for pspace in the specified shell. +See each sub-command's help for details on how to use the generated script. + +## Usage + +``` + completion [command] + completion [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [bash](#bash) +- [fish](#fish) +- [help](#help) +- [zsh](#zsh) +# pspace completion bash + +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: +``` +$ source <(completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: +``` +$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion bash [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace completion fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +``` +$ completion fish fish | source +``` + +To load completions for every new session, execute once: +``` +$ completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion fish [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace completion help + +Show help for a completion command + +## Usage + +``` + completion help [command] + completion help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace completion help commands + +List completion commands + +Example: +``` +$ completion help commands commands +``` + +## Usage + +``` + completion help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace completion zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: +``` +$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: +``` +$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion zsh [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace config + +This command manages your Paperspace configuration. You can use it to set, get, and +delete configuration values. Running this command without any subcommands will print +your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: +``` +pspace config set team "my-team" +``` + +## Usage + +``` + config [command] + config [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [set](#set) +# pspace config delete + +Delete a configuration value. + +## Usage + +``` + config delete [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace config get + +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: +``` +pspace config get team +``` + +## Usage + +``` + config get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace config help + +Show help for a config command + +## Usage + +``` + config help [command] + config help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace config help commands + +List config commands + +Example: +``` +$ config help commands commands +``` + +## Usage + +``` + config help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace config set + +Set a configuration value. + +## Usage + +``` + config set [arguments] [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace console + +This command opens the Paperspace web console in your browser. + +## Usage + +``` + console [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template + +Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +## Usage + +``` + custom-template [command] + custom-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +# pspace custom-template create + +Create a custom template from a machine. + +## Usage + +``` + custom-template create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template delete + +Delete a custom template from a team. + +## Usage + +``` + custom-template delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template get + +Get a custom template from a team. + +## Usage + +``` + custom-template get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace custom-template help + +Show help for a custom-template command + +## Usage + +``` + custom-template help [command] + custom-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace custom-template help commands + +List custom-template commands + +Example: +``` +$ custom-template help commands commands +``` + +## Usage + +``` + custom-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace custom-template list + +List custom templates in your team. + +Pick a subset of fields to display: +``` +pspace custom-template list -F name -F dtModified +``` + +## Usage + +``` + custom-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset + +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +## Usage + +``` + dataset [command] + dataset [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +- [versions](#versions) +# pspace dataset create + +Create a dataset. + +## Usage + +``` + dataset create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset delete + +Delete a dataset from a team. + +## Usage + +``` + dataset delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset get + +Get a dataset from a team. + +## Usage + +``` + dataset get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset help + +Show help for a dataset command + +## Usage + +``` + dataset help [command] + dataset help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace dataset help commands + +List dataset commands + +Example: +``` +$ dataset help commands commands +``` + +## Usage + +``` + dataset help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace dataset list + +List datasets in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset list -F name -F dtModified +``` + +## Usage + +``` + dataset list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset update + +Update a dataset in a project or team. + +## Usage + +``` + dataset update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions + +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +## Usage + +``` + dataset versions [command] + dataset versions [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +# pspace dataset versions create + +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +## Usage + +``` + dataset versions create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions delete + +Delete a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions delete [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions get + +Get a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions get [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions help + +Show help for a versions command + +## Usage + +``` + dataset versions help [command] + dataset versions help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace dataset versions help commands + +List versions commands + +Example: +``` +$ dataset versions help commands commands +``` + +## Usage + +``` + dataset versions help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace dataset versions list + +List dataset versions in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset versions list -F name -F dtModified +``` + +## Usage + +``` + dataset versions list [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace dataset versions update + +Update a dataset version in a project or team. + +## Usage + +``` + dataset versions update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment + +Effortlessly deploy ML apps to Paperspace. + +## Usage + +``` + deployment [command] + deployment [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [up](#up) +# pspace deployment delete + +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +## Usage + +``` + deployment delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment get + +Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +## Usage + +``` + deployment get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment help + +Show help for a deployment command + +## Usage + +``` + deployment help [command] + deployment help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace deployment help commands + +List deployment commands + +Example: +``` +$ deployment help commands commands +``` + +## Usage + +``` + deployment help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace deployment list + +List deployments in your team. + +Pick a subset of fields to display: +``` +pspace deployment list -F id -F name +``` + +## Usage + +``` + deployment list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace deployment up + +This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. +``` +$ pspace deployment create --project-id 1234 +``` + +## Usage + +``` + deployment up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace docs + +This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` + +## Usage + +``` + docs [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace help + +Show help for a pspace command + +## Usage + +``` + help [command] + help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace help commands + +List pspace commands + +Example: +``` +$ help commands commands +``` + +## Usage + +``` + help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace init + +Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +``` +$ pspace init +``` + +Create a new app named "my-app" relative to the current directory. +``` +$ pspace init my-app +``` + +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` +$ pspace init my-app -t Paperspace/gradio-demo +``` + +## Usage + +``` + init [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| template | t | A template to use when creating the app. This can be a URL +to a git repository or a shorthand template name. + +These templates are equivalent: +``` +user/repo +github:user/repo +git@github.com:user/repo +https://github.com/user/repo +``` + +Download from GitLab: +``` +gitlab:user/repo +git@gitlab.com:user/repo +https://gitlab.com/user/repo +``` + +Download from Bitbucket +``` +bitbucket:user/repo +git@bitbucket.org:user/repo +https://bitbucket.org/user/repo +``` + +Specify a tag or branch: +``` +user/repo#dev # branch +user/repo#v1.2.3 # release tag +user/repo#1234abcd # commit hash +``` | true | +| mode | m | The mode to use when creating the app. This can be either "git" or +"tar". If "git" is specified, the template will be downloaded as a +tarball. Note that "git" clones over SSH, so you must have a valid +SSH key configured with GitHub, Bitbucket, or GitLab. | false | +| name | n | The name of the app. Defaults to the first argument current directory name. | false | +| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace login + +Log in to the CLI using your Paperspace API key or by opening the web console. + +## Usage + +``` + login [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace logout + +Log out of the CLI for the current team, a specific team, or all teams. + +## Usage + +``` + logout [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| all | a | Log out of all teams. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine + +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine [command] + machine [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [restart](#restart) +- [start](#start) +- [stop](#stop) +- [update](#update) +# pspace machine create + +Create a machine. + +## Usage + +``` + machine create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine delete + +Delete a machine from a team. + +## Usage + +``` + machine delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine get + +Get a machine from a team. + +## Usage + +``` + machine get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine help + +Show help for a machine command + +## Usage + +``` + machine help [command] + machine help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace machine help commands + +List machine commands + +Example: +``` +$ machine help commands commands +``` + +## Usage + +``` + machine help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace machine list + +List machines in your team. + +Pick a subset of fields to display: +``` +pspace machine list -F name -F dtModified +``` + +## Usage + +``` + machine list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine restart + +Restart a machine from a team. + +## Usage + +``` + machine restart [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine start + +Start a machine from a team. + +## Usage + +``` + machine start [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine stop + +Stop a machine from a team. + +## Usage + +``` + machine stop [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine update + +Update a machine's settings. + +## Usage + +``` + machine update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine-event + +Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine-event [command] + machine-event [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [get](#get) +- [help](#help) +- [list](#list) +# pspace machine-event get + +Get a machine event from a team. + +## Usage + +``` + machine-event get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace machine-event help + +Show help for a machine-event command + +## Usage + +``` + machine-event help [command] + machine-event help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace machine-event help commands + +List machine-event commands + +Example: +``` +$ machine-event help commands commands +``` + +## Usage + +``` + machine-event help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace machine-event list + +List machine events in your team. + +Pick a subset of fields to display: +``` +pspace machine-event list -F name -F dtModified +``` + +## Usage + +``` + machine-event list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model + +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +## Usage + +``` + model [command] + model [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +# pspace model create + +Create a new model. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + model create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model delete + +Delete a model from a team. + +## Usage + +``` + model delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model get + +Get a model from a team. + +## Usage + +``` + model get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace model help + +Show help for a model command + +## Usage + +``` + model help [command] + model help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace model help commands + +List model commands + +Example: +``` +$ model help commands commands +``` + +## Usage + +``` + model help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace model list + +List models in your team. + +Pick a subset of fields to display: +``` +pspace model list -F name -F dtModified +``` + +## Usage + +``` + model list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace os-template + +List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +## Usage + +``` + os-template [command] + os-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [list](#list) +# pspace os-template help + +Show help for a os-template command + +## Usage + +``` + os-template help [command] + os-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace os-template help commands + +List os-template commands + +Example: +``` +$ os-template help commands commands +``` + +## Usage + +``` + os-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace os-template list + +List OS templates. + +Pick a subset of fields to display: +``` +pspace os-template list -F name +``` + +## Usage + +``` + os-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network + +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. + +## Usage + +``` + private-network [command] + private-network [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +# pspace private-network create + +Create a private network. + +## Usage + +``` + private-network create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network delete + +Delete a private network from a team. + +## Usage + +``` + private-network delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network get + +Get a private network from a team. + +## Usage + +``` + private-network get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace private-network help + +Show help for a private-network command + +## Usage + +``` + private-network help [command] + private-network help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace private-network help commands + +List private-network commands + +Example: +``` +$ private-network help commands commands +``` + +## Usage + +``` + private-network help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace private-network list + +List private networks in your team. + +Pick a subset of fields to display: +``` +pspace private-network list -F name -F dtModified +``` + +## Usage + +``` + private-network list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project + +Manage your Paperspace projects. + +## Usage + +``` + project [command] + project [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [link](#link) +- [list](#list) +- [update](#update) +# pspace project create + +Create a new project. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + project create [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project delete + +Delete a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project get + +Get a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project help + +Show help for a project command + +## Usage + +``` + project help [command] + project help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace project help commands + +List project commands + +Example: +``` +$ project help commands commands +``` + +## Usage + +``` + project help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace project link + +This will link a remote project to a local directory. Commands that +depend on a project ID will use the project ID of the linked project +when communicating with the Paperspace API. + +Link a project to the current directory. +``` +$ pspace link +``` + +Link a project to a different directory. +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. +``` +$ pspace link pzwf2g05ubegj +``` + +## Usage + +``` + project link [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project list + +List projects in your team. + +Pick a subset of fields to display: +``` +pspace project list -F id -F name -F dtCreated +``` + +## Usage + +``` + project list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace project update + +Update an existing project. + +Example: +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +## Usage + +``` + pspace project update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip + +Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +## Usage + +``` + public-ip [command] + public-ip [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [claim](#claim) +- [help](#help) +- [list](#list) +- [release](#release) +# pspace public-ip assign + +Assign a public IP to a machine. + +## Usage + +``` + public-ip assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip claim + +Claim a public IP for a team. + +## Usage + +``` + public-ip claim [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip help + +Show help for a public-ip command + +## Usage + +``` + public-ip help [command] + public-ip help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace public-ip help commands + +List public-ip commands + +Example: +``` +$ public-ip help commands commands +``` + +## Usage + +``` + public-ip help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace public-ip list + +List public IPs in your team or project. + +Pick a subset of fields to display: +``` +pspace public-ip list -F name -F dtModified +``` + +## Usage + +``` + public-ip list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip release + +Release a public IP from a team. This will unassign it from its assigned machine, if any. + +## Usage + +``` + public-ip release [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret + +Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +## Usage + +``` + secret [command] + secret [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +# pspace secret create + +Create a secret in a project or team. + +## Usage + +``` + secret create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret delete + +Delete a secret from a project or team. + +## Usage + +``` + secret delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret get + +Get a secret from a project or team. + +## Usage + +``` + secret get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret help + +Show help for a secret command + +## Usage + +``` + secret help [command] + secret help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace secret help commands + +List secret commands + +Example: +``` +$ secret help commands commands +``` + +## Usage + +``` + secret help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace secret list + +List secrets in your team or project. + +Pick a subset of fields to display: +``` +pspace secret list -F name -F dtModified +``` + +## Usage + +``` + secret list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret update + +Update a secret in a project or team. + +## Usage + +``` + secret update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive + +Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +## Usage + +``` + shared-drive [command] + shared-drive [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +# pspace shared-drive create + +Create a shared drive. + +## Usage + +``` + shared-drive create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive delete + +Delete a shared drive from a team. + +## Usage + +``` + shared-drive delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive get + +Get a shared drive from a team. + +## Usage + +``` + shared-drive get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive help + +Show help for a shared-drive command + +## Usage + +``` + shared-drive help [command] + shared-drive help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace shared-drive help commands + +List shared-drive commands + +Example: +``` +$ shared-drive help commands commands +``` + +## Usage + +``` + shared-drive help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace shared-drive list + +List shared drives in your team or project. + +Pick a subset of fields to display: +``` +pspace shared-drive list -F name -F dtModified +``` + +## Usage + +``` + shared-drive list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace signup + +This command opens the Paperspace signup page in your browser. + +## Usage + +``` + signup [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot + +Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +## Usage + +``` + snapshot [command] + snapshot [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [help](#help) +- [list](#list) +- [restore](#restore) +# pspace snapshot create + +Create a snapshot from a machine. + +## Usage + +``` + snapshot create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot delete + +Delete a snapshot from a team. + +## Usage + +``` + snapshot delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot help + +Show help for a snapshot command + +## Usage + +``` + snapshot help [command] + snapshot help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace snapshot help commands + +List snapshot commands + +Example: +``` +$ snapshot help commands commands +``` + +## Usage + +``` + snapshot help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace snapshot list + +List snapshots in your team. + +Pick a subset of fields to display: +``` +pspace snapshot list -F name -F dtModified +``` + +## Usage + +``` + snapshot list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot restore + +Restore a machine to a snapshot. + +## Usage + +``` + snapshot restore [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script + +Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. + +## Usage + +``` + startup-script [command] + startup-script [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [unassign](#unassign) +- [update](#update) +# pspace startup-script assign + +Assign a startup script to a machine. + +## Usage + +``` + startup-script assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script create + +Create a startup script. + +## Usage + +``` + startup-script create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script delete + +Delete a startup script from a team. + +## Usage + +``` + startup-script delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script get + +Get a startup script from a team. + +## Usage + +``` + startup-script get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script help + +Show help for a startup-script command + +## Usage + +``` + startup-script help [command] + startup-script help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace startup-script help commands + +List startup-script commands + +Example: +``` +$ startup-script help commands commands +``` + +## Usage + +``` + startup-script help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace startup-script list + +List startup scripts in your team. + +Pick a subset of fields to display: +``` +pspace startup-script list -F name -F dtCreated +``` + +## Usage + +``` + startup-script list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script unassign + +Unassign a startup script from a machine. + +## Usage + +``` + startup-script unassign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script update + +Update a startup script. + +## Usage + +``` + startup-script update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider + +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +## Usage + +``` + storage-provider [command] + storage-provider [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +# pspace storage-provider create + +Create a storage provider. + +## Usage + +``` + storage-provider create [command] + storage-provider create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +# pspace storage-provider create help + +Show help for a create command + +## Usage + +``` + storage-provider create help [command] + storage-provider create help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider create help commands + +List create commands + +Example: +``` +$ storage-provider create help commands commands +``` + +## Usage + +``` + storage-provider create help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider create s3 + +Create an S3 storage provider. + +## Usage + +``` + storage-provider create s3 [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider delete + +Delete a storage provider from a team. + +## Usage + +``` + storage-provider delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider get + +Get a storage provider from a team. + +## Usage + +``` + storage-provider get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider help + +Show help for a storage-provider command + +## Usage + +``` + storage-provider help [command] + storage-provider help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider help commands + +List storage-provider commands + +Example: +``` +$ storage-provider help commands commands +``` + +## Usage + +``` + storage-provider help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider list + +List storage providers in your team or project. + +Pick a subset of fields to display: +``` +pspace storage provider list -F name -F dtModified +``` + +## Usage + +``` + storage-provider list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider update + +Update a storage provider. + +## Usage + +``` + storage-provider update [command] + storage-provider update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +# pspace storage-provider update help + +Show help for a update command + +## Usage + +``` + storage-provider update help [command] + storage-provider update help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider update help commands + +List update commands + +Example: +``` +$ storage-provider update help commands commands +``` + +## Usage + +``` + storage-provider update help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider update s3 + +Update an S3 storage provider in a project or team. + +## Usage + +``` + storage-provider update s3 [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace up + +This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` +$ pspace up +``` + +Deploy the app using a config file. +``` +$ pspace up -c paperspace.json +``` + +Deploy an app in a different directory. +``` +$ pspace up --cwd ../my-app +``` + +## Usage + +``` + up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace upgrade + +This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` +brew upgrade pspace +``` + +If you installed `pspace` using the install script, you can upgrade by +running: +``` +pspace upgrade +``` + +## Usage + +``` + upgrade [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace version + +Shows version information command, including version number and build date. + +## Usage + +``` + version [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md index 9722726..bd16bc5 100644 --- a/.assets/pspace/public-ip.md +++ b/.assets/pspace/public-ip.md @@ -27,3 +27,154 @@ For more information, see https://docs.paperspace.com/networking/public-ips. - [help](#help) - [list](#list) - [release](#release) +# pspace public-ip assign + +Assign a public IP to a machine. + +## Usage + +``` + public-ip assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip claim + +Claim a public IP for a team. + +## Usage + +``` + public-ip claim [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip help + +Show help for a public-ip command + +## Usage + +``` + public-ip help [command] + public-ip help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace public-ip help commands + +List public-ip commands + +Example: +``` +$ public-ip help commands commands +``` + +## Usage + +``` + public-ip help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace public-ip list + +List public IPs in your team or project. + +Pick a subset of fields to display: +``` +pspace public-ip list -F name -F dtModified +``` + +## Usage + +``` + public-ip list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace public-ip release + +Release a public IP from a team. This will unassign it from its assigned machine, if any. + +## Usage + +``` + public-ip release [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/assign.md b/.assets/pspace/public-ip/assign.md deleted file mode 100644 index 0febe9e..0000000 --- a/.assets/pspace/public-ip/assign.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace public-ip assign - -Assign a public IP to a machine. - -## Usage - -``` - public-ip assign [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/public-ip/claim.md b/.assets/pspace/public-ip/claim.md deleted file mode 100644 index 0676833..0000000 --- a/.assets/pspace/public-ip/claim.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace public-ip claim - -Claim a public IP for a team. - -## Usage - -``` - public-ip claim [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/public-ip/help.md b/.assets/pspace/public-ip/help.md deleted file mode 100644 index 6131c35..0000000 --- a/.assets/pspace/public-ip/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace public-ip help - -Show help for a public-ip command - -## Usage - -``` - public-ip help [command] - public-ip help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md deleted file mode 100644 index 62c03d5..0000000 --- a/.assets/pspace/public-ip/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace public-ip help commands - -List public-ip commands - -Example: -``` -$ public-ip help commands commands -``` - -## Usage - -``` - public-ip help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/public-ip/list.md b/.assets/pspace/public-ip/list.md deleted file mode 100644 index 63bd002..0000000 --- a/.assets/pspace/public-ip/list.md +++ /dev/null @@ -1,33 +0,0 @@ -# pspace public-ip list - -List public IPs in your team or project. - -Pick a subset of fields to display: -``` -pspace public-ip list -F name -F dtModified -``` - -## Usage - -``` - public-ip list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/public-ip/release.md b/.assets/pspace/public-ip/release.md deleted file mode 100644 index d936e8e..0000000 --- a/.assets/pspace/public-ip/release.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace public-ip release - -Release a public IP from a team. This will unassign it from its assigned machine, if any. - -## Usage - -``` - public-ip release [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md index 773bd76..a5a9cce 100644 --- a/.assets/pspace/secret.md +++ b/.assets/pspace/secret.md @@ -36,3 +36,210 @@ For more information, see https://docs.paperspace.com/secrets. - [help](#help) - [list](#list) - [update](#update) +# pspace secret create + +Create a secret in a project or team. + +## Usage + +``` + secret create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret delete + +Delete a secret from a project or team. + +## Usage + +``` + secret delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret get + +Get a secret from a project or team. + +## Usage + +``` + secret get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret help + +Show help for a secret command + +## Usage + +``` + secret help [command] + secret help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace secret help commands + +List secret commands + +Example: +``` +$ secret help commands commands +``` + +## Usage + +``` + secret help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace secret list + +List secrets in your team or project. + +Pick a subset of fields to display: +``` +pspace secret list -F name -F dtModified +``` + +## Usage + +``` + secret list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace secret update + +Update a secret in a project or team. + +## Usage + +``` + secret update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/create.md b/.assets/pspace/secret/create.md deleted file mode 100644 index 18e9535..0000000 --- a/.assets/pspace/secret/create.md +++ /dev/null @@ -1,29 +0,0 @@ -# pspace secret create - -Create a secret in a project or team. - -## Usage - -``` - secret create [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/secret/delete.md b/.assets/pspace/secret/delete.md deleted file mode 100644 index 077f756..0000000 --- a/.assets/pspace/secret/delete.md +++ /dev/null @@ -1,29 +0,0 @@ -# pspace secret delete - -Delete a secret from a project or team. - -## Usage - -``` - secret delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/secret/get.md b/.assets/pspace/secret/get.md deleted file mode 100644 index 45dc488..0000000 --- a/.assets/pspace/secret/get.md +++ /dev/null @@ -1,30 +0,0 @@ -# pspace secret get - -Get a secret from a project or team. - -## Usage - -``` - secret get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/secret/help.md b/.assets/pspace/secret/help.md deleted file mode 100644 index a74ebeb..0000000 --- a/.assets/pspace/secret/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace secret help - -Show help for a secret command - -## Usage - -``` - secret help [command] - secret help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md deleted file mode 100644 index 3f2baf6..0000000 --- a/.assets/pspace/secret/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace secret help commands - -List secret commands - -Example: -``` -$ secret help commands commands -``` - -## Usage - -``` - secret help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/secret/list.md b/.assets/pspace/secret/list.md deleted file mode 100644 index 4208446..0000000 --- a/.assets/pspace/secret/list.md +++ /dev/null @@ -1,40 +0,0 @@ -# pspace secret list - -List secrets in your team or project. - -Pick a subset of fields to display: -``` -pspace secret list -F name -F dtModified -``` - -## Usage - -``` - secret list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/secret/update.md b/.assets/pspace/secret/update.md deleted file mode 100644 index 790e50d..0000000 --- a/.assets/pspace/secret/update.md +++ /dev/null @@ -1,29 +0,0 @@ -# pspace secret update - -Update a secret in a project or team. - -## Usage - -``` - secret update [arguments] [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md index 7849088..c8b152c 100644 --- a/.assets/pspace/shared-drive.md +++ b/.assets/pspace/shared-drive.md @@ -29,3 +29,157 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. - [get](#get) - [help](#help) - [list](#list) +# pspace shared-drive create + +Create a shared drive. + +## Usage + +``` + shared-drive create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive delete + +Delete a shared drive from a team. + +## Usage + +``` + shared-drive delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive get + +Get a shared drive from a team. + +## Usage + +``` + shared-drive get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace shared-drive help + +Show help for a shared-drive command + +## Usage + +``` + shared-drive help [command] + shared-drive help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace shared-drive help commands + +List shared-drive commands + +Example: +``` +$ shared-drive help commands commands +``` + +## Usage + +``` + shared-drive help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace shared-drive list + +List shared drives in your team or project. + +Pick a subset of fields to display: +``` +pspace shared-drive list -F name -F dtModified +``` + +## Usage + +``` + shared-drive list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/create.md b/.assets/pspace/shared-drive/create.md deleted file mode 100644 index 34dfd0c..0000000 --- a/.assets/pspace/shared-drive/create.md +++ /dev/null @@ -1,26 +0,0 @@ -# pspace shared-drive create - -Create a shared drive. - -## Usage - -``` - shared-drive create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/shared-drive/delete.md b/.assets/pspace/shared-drive/delete.md deleted file mode 100644 index e18f39b..0000000 --- a/.assets/pspace/shared-drive/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace shared-drive delete - -Delete a shared drive from a team. - -## Usage - -``` - shared-drive delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/shared-drive/get.md b/.assets/pspace/shared-drive/get.md deleted file mode 100644 index d446156..0000000 --- a/.assets/pspace/shared-drive/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace shared-drive get - -Get a shared drive from a team. - -## Usage - -``` - shared-drive get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/shared-drive/help.md b/.assets/pspace/shared-drive/help.md deleted file mode 100644 index 4e1f0f4..0000000 --- a/.assets/pspace/shared-drive/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace shared-drive help - -Show help for a shared-drive command - -## Usage - -``` - shared-drive help [command] - shared-drive help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md deleted file mode 100644 index ec6ec3e..0000000 --- a/.assets/pspace/shared-drive/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace shared-drive help commands - -List shared-drive commands - -Example: -``` -$ shared-drive help commands commands -``` - -## Usage - -``` - shared-drive help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/shared-drive/list.md b/.assets/pspace/shared-drive/list.md deleted file mode 100644 index 7359bfb..0000000 --- a/.assets/pspace/shared-drive/list.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace shared-drive list - -List shared drives in your team or project. - -Pick a subset of fields to display: -``` -pspace shared-drive list -F name -F dtModified -``` - -## Usage - -``` - shared-drive list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md index 3fe37e6..4642eee 100644 --- a/.assets/pspace/snapshot.md +++ b/.assets/pspace/snapshot.md @@ -29,3 +29,156 @@ For more information, see https://docs.paperspace.com/storage/snapshots. - [help](#help) - [list](#list) - [restore](#restore) +# pspace snapshot create + +Create a snapshot from a machine. + +## Usage + +``` + snapshot create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot delete + +Delete a snapshot from a team. + +## Usage + +``` + snapshot delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot help + +Show help for a snapshot command + +## Usage + +``` + snapshot help [command] + snapshot help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace snapshot help commands + +List snapshot commands + +Example: +``` +$ snapshot help commands commands +``` + +## Usage + +``` + snapshot help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace snapshot list + +List snapshots in your team. + +Pick a subset of fields to display: +``` +pspace snapshot list -F name -F dtModified +``` + +## Usage + +``` + snapshot list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace snapshot restore + +Restore a machine to a snapshot. + +## Usage + +``` + snapshot restore [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/create.md b/.assets/pspace/snapshot/create.md deleted file mode 100644 index fd1a91d..0000000 --- a/.assets/pspace/snapshot/create.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace snapshot create - -Create a snapshot from a machine. - -## Usage - -``` - snapshot create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/snapshot/delete.md b/.assets/pspace/snapshot/delete.md deleted file mode 100644 index 93663ed..0000000 --- a/.assets/pspace/snapshot/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace snapshot delete - -Delete a snapshot from a team. - -## Usage - -``` - snapshot delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/snapshot/help.md b/.assets/pspace/snapshot/help.md deleted file mode 100644 index 1e48224..0000000 --- a/.assets/pspace/snapshot/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace snapshot help - -Show help for a snapshot command - -## Usage - -``` - snapshot help [command] - snapshot help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md deleted file mode 100644 index 7c5f454..0000000 --- a/.assets/pspace/snapshot/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace snapshot help commands - -List snapshot commands - -Example: -``` -$ snapshot help commands commands -``` - -## Usage - -``` - snapshot help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/snapshot/list.md b/.assets/pspace/snapshot/list.md deleted file mode 100644 index 59678f2..0000000 --- a/.assets/pspace/snapshot/list.md +++ /dev/null @@ -1,34 +0,0 @@ -# pspace snapshot list - -List snapshots in your team. - -Pick a subset of fields to display: -``` -pspace snapshot list -F name -F dtModified -``` - -## Usage - -``` - snapshot list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/snapshot/restore.md b/.assets/pspace/snapshot/restore.md deleted file mode 100644 index 0cc1b84..0000000 --- a/.assets/pspace/snapshot/restore.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace snapshot restore - -Restore a machine to a snapshot. - -## Usage - -``` - snapshot restore [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md index e2c9337..34a38aa 100644 --- a/.assets/pspace/startup-script.md +++ b/.assets/pspace/startup-script.md @@ -29,3 +29,227 @@ on first boot or on every boot. - [list](#list) - [unassign](#unassign) - [update](#update) +# pspace startup-script assign + +Assign a startup script to a machine. + +## Usage + +``` + startup-script assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script create + +Create a startup script. + +## Usage + +``` + startup-script create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script delete + +Delete a startup script from a team. + +## Usage + +``` + startup-script delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script get + +Get a startup script from a team. + +## Usage + +``` + startup-script get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script help + +Show help for a startup-script command + +## Usage + +``` + startup-script help [command] + startup-script help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace startup-script help commands + +List startup-script commands + +Example: +``` +$ startup-script help commands commands +``` + +## Usage + +``` + startup-script help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace startup-script list + +List startup scripts in your team. + +Pick a subset of fields to display: +``` +pspace startup-script list -F name -F dtCreated +``` + +## Usage + +``` + startup-script list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script unassign + +Unassign a startup script from a machine. + +## Usage + +``` + startup-script unassign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace startup-script update + +Update a startup script. + +## Usage + +``` + startup-script update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/assign.md b/.assets/pspace/startup-script/assign.md deleted file mode 100644 index f913d40..0000000 --- a/.assets/pspace/startup-script/assign.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace startup-script assign - -Assign a startup script to a machine. - -## Usage - -``` - startup-script assign [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/create.md b/.assets/pspace/startup-script/create.md deleted file mode 100644 index 688450b..0000000 --- a/.assets/pspace/startup-script/create.md +++ /dev/null @@ -1,25 +0,0 @@ -# pspace startup-script create - -Create a startup script. - -## Usage - -``` - startup-script create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/delete.md b/.assets/pspace/startup-script/delete.md deleted file mode 100644 index 236d9f4..0000000 --- a/.assets/pspace/startup-script/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace startup-script delete - -Delete a startup script from a team. - -## Usage - -``` - startup-script delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/get.md b/.assets/pspace/startup-script/get.md deleted file mode 100644 index b3e49a2..0000000 --- a/.assets/pspace/startup-script/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace startup-script get - -Get a startup script from a team. - -## Usage - -``` - startup-script get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/help.md b/.assets/pspace/startup-script/help.md deleted file mode 100644 index 4e4c0b8..0000000 --- a/.assets/pspace/startup-script/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace startup-script help - -Show help for a startup-script command - -## Usage - -``` - startup-script help [command] - startup-script help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md deleted file mode 100644 index 84d6b42..0000000 --- a/.assets/pspace/startup-script/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace startup-script help commands - -List startup-script commands - -Example: -``` -$ startup-script help commands commands -``` - -## Usage - -``` - startup-script help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/list.md b/.assets/pspace/startup-script/list.md deleted file mode 100644 index cd887ae..0000000 --- a/.assets/pspace/startup-script/list.md +++ /dev/null @@ -1,33 +0,0 @@ -# pspace startup-script list - -List startup scripts in your team. - -Pick a subset of fields to display: -``` -pspace startup-script list -F name -F dtCreated -``` - -## Usage - -``` - startup-script list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/unassign.md b/.assets/pspace/startup-script/unassign.md deleted file mode 100644 index dfc3c28..0000000 --- a/.assets/pspace/startup-script/unassign.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace startup-script unassign - -Unassign a startup script from a machine. - -## Usage - -``` - startup-script unassign [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/startup-script/update.md b/.assets/pspace/startup-script/update.md deleted file mode 100644 index e90c9b7..0000000 --- a/.assets/pspace/startup-script/update.md +++ /dev/null @@ -1,26 +0,0 @@ -# pspace startup-script update - -Update a startup script. - -## Usage - -``` - startup-script update [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md index cd1d679..7809ca3 100644 --- a/.assets/pspace/storage-provider.md +++ b/.assets/pspace/storage-provider.md @@ -28,3 +28,339 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. - [help](#help) - [list](#list) - [update](#update) +# pspace storage-provider create + +Create a storage provider. + +## Usage + +``` + storage-provider create [command] + storage-provider create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +# pspace storage-provider create help + +Show help for a create command + +## Usage + +``` + storage-provider create help [command] + storage-provider create help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider create help commands + +List create commands + +Example: +``` +$ storage-provider create help commands commands +``` + +## Usage + +``` + storage-provider create help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider create s3 + +Create an S3 storage provider. + +## Usage + +``` + storage-provider create s3 [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider delete + +Delete a storage provider from a team. + +## Usage + +``` + storage-provider delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider get + +Get a storage provider from a team. + +## Usage + +``` + storage-provider get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider help + +Show help for a storage-provider command + +## Usage + +``` + storage-provider help [command] + storage-provider help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider help commands + +List storage-provider commands + +Example: +``` +$ storage-provider help commands commands +``` + +## Usage + +``` + storage-provider help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider list + +List storage providers in your team or project. + +Pick a subset of fields to display: +``` +pspace storage provider list -F name -F dtModified +``` + +## Usage + +``` + storage-provider list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +# pspace storage-provider update + +Update a storage provider. + +## Usage + +``` + storage-provider update [command] + storage-provider update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) +# pspace storage-provider update help + +Show help for a update command + +## Usage + +``` + storage-provider update help [command] + storage-provider update help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) +# pspace storage-provider update help commands + +List update commands + +Example: +``` +$ storage-provider update help commands commands +``` + +## Usage + +``` + storage-provider update help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + +# pspace storage-provider update s3 + +Update an S3 storage provider in a project or team. + +## Usage + +``` + storage-provider update s3 [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/create.md b/.assets/pspace/storage-provider/create.md deleted file mode 100644 index 3ff4704..0000000 --- a/.assets/pspace/storage-provider/create.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace storage-provider create - -Create a storage provider. - -## Usage - -``` - storage-provider create [command] - storage-provider create [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) diff --git a/.assets/pspace/storage-provider/create/help.md b/.assets/pspace/storage-provider/create/help.md deleted file mode 100644 index 8dbdea0..0000000 --- a/.assets/pspace/storage-provider/create/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace storage-provider create help - -Show help for a create command - -## Usage - -``` - storage-provider create help [command] - storage-provider create help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md deleted file mode 100644 index 33d6790..0000000 --- a/.assets/pspace/storage-provider/create/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace storage-provider create help commands - -List create commands - -Example: -``` -$ storage-provider create help commands commands -``` - -## Usage - -``` - storage-provider create help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/create/s3.md b/.assets/pspace/storage-provider/create/s3.md deleted file mode 100644 index a15d5dc..0000000 --- a/.assets/pspace/storage-provider/create/s3.md +++ /dev/null @@ -1,31 +0,0 @@ -# pspace storage-provider create s3 - -Create an S3 storage provider. - -## Usage - -``` - storage-provider create s3 [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/delete.md b/.assets/pspace/storage-provider/delete.md deleted file mode 100644 index 66dd46a..0000000 --- a/.assets/pspace/storage-provider/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace storage-provider delete - -Delete a storage provider from a team. - -## Usage - -``` - storage-provider delete [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/get.md b/.assets/pspace/storage-provider/get.md deleted file mode 100644 index 3b0df82..0000000 --- a/.assets/pspace/storage-provider/get.md +++ /dev/null @@ -1,22 +0,0 @@ -# pspace storage-provider get - -Get a storage provider from a team. - -## Usage - -``` - storage-provider get [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/help.md b/.assets/pspace/storage-provider/help.md deleted file mode 100644 index 09574c1..0000000 --- a/.assets/pspace/storage-provider/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace storage-provider help - -Show help for a storage-provider command - -## Usage - -``` - storage-provider help [command] - storage-provider help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md deleted file mode 100644 index f53a9ef..0000000 --- a/.assets/pspace/storage-provider/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace storage-provider help commands - -List storage-provider commands - -Example: -``` -$ storage-provider help commands commands -``` - -## Usage - -``` - storage-provider help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/list.md b/.assets/pspace/storage-provider/list.md deleted file mode 100644 index 24e571b..0000000 --- a/.assets/pspace/storage-provider/list.md +++ /dev/null @@ -1,32 +0,0 @@ -# pspace storage-provider list - -List storage providers in your team or project. - -Pick a subset of fields to display: -``` -pspace storage provider list -F name -F dtModified -``` - -## Usage - -``` - storage-provider list [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/update.md b/.assets/pspace/storage-provider/update.md deleted file mode 100644 index 020100d..0000000 --- a/.assets/pspace/storage-provider/update.md +++ /dev/null @@ -1,24 +0,0 @@ -# pspace storage-provider update - -Update a storage provider. - -## Usage - -``` - storage-provider update [command] - storage-provider update [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) diff --git a/.assets/pspace/storage-provider/update/help.md b/.assets/pspace/storage-provider/update/help.md deleted file mode 100644 index 11b6715..0000000 --- a/.assets/pspace/storage-provider/update/help.md +++ /dev/null @@ -1,23 +0,0 @@ -# pspace storage-provider update help - -Show help for a update command - -## Usage - -``` - storage-provider update help [command] - storage-provider update help [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md deleted file mode 100644 index e5d1c4c..0000000 --- a/.assets/pspace/storage-provider/update/help/commands.md +++ /dev/null @@ -1,27 +0,0 @@ -# pspace storage-provider update help commands - -List update commands - -Example: -``` -$ storage-provider update help commands commands -``` - -## Usage - -``` - storage-provider update help commands [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - diff --git a/.assets/pspace/storage-provider/update/s3.md b/.assets/pspace/storage-provider/update/s3.md deleted file mode 100644 index 6b3c9ca..0000000 --- a/.assets/pspace/storage-provider/update/s3.md +++ /dev/null @@ -1,31 +0,0 @@ -# pspace storage-provider update s3 - -Update an S3 storage provider in a project or team. - -## Usage - -``` - storage-provider update s3 [arguments] [flags] -``` - -## Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index f26c833..6e09d8d 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -11,9 +11,10 @@ await Deno.writeTextFile( JSON.stringify(json, null, 2), ); +let markdown = ""; + // Also generate markdown for the CLI async function renderCommand(path: string[], command: ZcliJsonCommand) { - let markdown = ""; markdown += `# ${path.join(" ")}\n\n`; markdown += command.description + "\n\n"; markdown += "## Usage\n\n"; @@ -35,19 +36,34 @@ async function renderCommand(path: string[], command: ZcliJsonCommand) { markdown += `- [${subcommand.name}](#${subcommand.name})\n`; } - if (path.length >= 2) { - await Deno.mkdir(`.assets/${path.slice(0, -1).join("/")}`, { - recursive: true, - }); - } - await Deno.writeTextFile(`.assets/${path.join("/")}.md`, markdown, { - create: true, - }); for (const subcommand of command.commands) { await renderCommand([...path, subcommand.name], subcommand); } } for (const command of json.commands) { + await Deno.mkdir(`.assets/${command.name}`, { + recursive: true, + }); + for (const subcommand of command.commands) { + markdown = ""; + await renderCommand([command.name, subcommand.name], subcommand); + await Deno.writeTextFile( + `.assets/${command.name}/${subcommand.name}.md`, + markdown, + { + create: true, + }, + ); + } + markdown = ""; await renderCommand([command.name], command); + await Deno.writeTextFile( + // edge case, put pspace in pspace/pspace.md + `.assets/${command.name}/${command.name}.md`, + markdown, + { + create: true, + }, + ); } From e1c14d5261fdfa011226c79b0ac2439c1adbf2e1 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 23 May 2024 15:43:06 -0400 Subject: [PATCH 06/10] asdf --- .assets/pspace.json | 2 +- .assets/pspace/autoscaling-group.md | 64 +- .assets/pspace/completion.md | 48 +- .assets/pspace/config.md | 48 +- .assets/pspace/console.md | 8 +- .assets/pspace/custom-template.md | 56 +- .assets/pspace/dataset.md | 128 +-- .assets/pspace/deployment.md | 56 +- .assets/pspace/docs.md | 8 +- .assets/pspace/help.md | 16 +- .assets/pspace/init.md | 8 +- .assets/pspace/login.md | 8 +- .assets/pspace/logout.md | 8 +- .assets/pspace/machine-event.md | 40 +- .assets/pspace/machine.md | 88 +- .assets/pspace/model.md | 56 +- .assets/pspace/os-template.md | 32 +- .assets/pspace/private-network.md | 56 +- .assets/pspace/project.md | 72 +- .assets/pspace/pspace.md | 1264 +++++++++++++-------------- .assets/pspace/public-ip.md | 56 +- .assets/pspace/secret.md | 64 +- .assets/pspace/shared-drive.md | 56 +- .assets/pspace/signup.md | 8 +- .assets/pspace/snapshot.md | 56 +- .assets/pspace/startup-script.md | 80 +- .assets/pspace/storage-provider.md | 112 +-- .assets/pspace/up.md | 8 +- .assets/pspace/upgrade.md | 8 +- .assets/pspace/version.md | 8 +- .scripts/generate-docs.ts | 8 +- 31 files changed, 1265 insertions(+), 1265 deletions(-) diff --git a/.assets/pspace.json b/.assets/pspace.json index b45e4c0..71aee2a 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-23T19:22:11.325Z", + "buildDate": "2024-05-23T19:42:58.057Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md index 8fc8a60..e0a7ece 100644 --- a/.assets/pspace/autoscaling-group.md +++ b/.assets/pspace/autoscaling-group.md @@ -1,17 +1,17 @@ -# pspace autoscaling-group +## pspace autoscaling-group Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes cluster-autoscaler to automatically scale your cluster. You can also autoscaling groups as a primitive for your own autoscaler. -## Usage +### Usage ``` autoscaling-group [command] autoscaling-group [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,7 +20,7 @@ You can also autoscaling groups as a primitive for your own autoscaler. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -28,17 +28,17 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) -# pspace autoscaling-group create +## pspace autoscaling-group create Create an autoscaling group. -## Usage +### Usage ``` autoscaling-group create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -57,19 +57,19 @@ Create an autoscaling group. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group delete +## pspace autoscaling-group delete Delete an autoscaling group from a team. -## Usage +### Usage ``` autoscaling-group delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -79,19 +79,19 @@ Delete an autoscaling group from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group get +## pspace autoscaling-group get Get an autoscaling group from a team. -## Usage +### Usage ``` autoscaling-group get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -101,20 +101,20 @@ Get an autoscaling group from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group help +## pspace autoscaling-group help Show help for a autoscaling-group command -## Usage +### Usage ``` autoscaling-group help [command] autoscaling-group help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -123,10 +123,10 @@ Show help for a autoscaling-group command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace autoscaling-group help commands +## pspace autoscaling-group help commands List autoscaling-group commands @@ -135,13 +135,13 @@ Example: $ autoscaling-group help commands commands ``` -## Usage +### Usage ``` autoscaling-group help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -151,9 +151,9 @@ $ autoscaling-group help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group list +## pspace autoscaling-group list List autoscaling groups in your team. @@ -162,13 +162,13 @@ Pick a subset of fields to display: pspace autoscaling-group list -F name -F dtCreated ``` -## Usage +### Usage ``` autoscaling-group list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -185,19 +185,19 @@ pspace autoscaling-group list -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group update +## pspace autoscaling-group update Update an autoscaling group. -## Usage +### Usage ``` autoscaling-group update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -217,5 +217,5 @@ Update an autoscaling group. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md index 09c787b..f2655ec 100644 --- a/.assets/pspace/completion.md +++ b/.assets/pspace/completion.md @@ -1,16 +1,16 @@ -# pspace completion +## pspace completion Generate an autocompletion script for pspace in the specified shell. See each sub-command's help for details on how to use the generated script. -## Usage +### Usage ``` completion [command] completion [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -19,13 +19,13 @@ See each sub-command's help for details on how to use the generated script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [bash](#bash) - [fish](#fish) - [help](#help) - [zsh](#zsh) -# pspace completion bash +## pspace completion bash Generate the autocompletion script for the bash shell. @@ -51,13 +51,13 @@ $ completion bash bash > /usr/local/etc/bash_completion.d/pspace You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion bash [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -66,9 +66,9 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace completion fish +## pspace completion fish Generate the autocompletion script for the fish shell. @@ -84,13 +84,13 @@ $ completion fish fish > ~/.config/fish/completions/pspace.fish You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion fish [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -100,20 +100,20 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace completion help +## pspace completion help Show help for a completion command -## Usage +### Usage ``` completion help [command] completion help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -122,10 +122,10 @@ Show help for a completion command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace completion help commands +## pspace completion help commands List completion commands @@ -134,13 +134,13 @@ Example: $ completion help commands commands ``` -## Usage +### Usage ``` completion help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -150,9 +150,9 @@ $ completion help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace completion zsh +## pspace completion zsh Generate the autocompletion script for the zsh shell. @@ -182,13 +182,13 @@ $ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion zsh [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -198,5 +198,5 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md index f24e496..49c8f6d 100644 --- a/.assets/pspace/config.md +++ b/.assets/pspace/config.md @@ -1,4 +1,4 @@ -# pspace config +## pspace config This command manages your Paperspace configuration. You can use it to set, get, and delete configuration values. Running this command without any subcommands will print @@ -11,14 +11,14 @@ For example, to set the current team, run: pspace config set team "my-team" ``` -## Usage +### Usage ``` config [command] config [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -27,23 +27,23 @@ pspace config set team "my-team" | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [delete](#delete) - [get](#get) - [help](#help) - [set](#set) -# pspace config delete +## pspace config delete Delete a configuration value. -## Usage +### Usage ``` config delete [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -52,9 +52,9 @@ Delete a configuration value. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace config get +## pspace config get This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values. @@ -64,13 +64,13 @@ For example, to get the current team run: pspace config get team ``` -## Usage +### Usage ``` config get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -79,20 +79,20 @@ pspace config get team | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace config help +## pspace config help Show help for a config command -## Usage +### Usage ``` config help [command] config help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -101,10 +101,10 @@ Show help for a config command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace config help commands +## pspace config help commands List config commands @@ -113,13 +113,13 @@ Example: $ config help commands commands ``` -## Usage +### Usage ``` config help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -129,19 +129,19 @@ $ config help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace config set +## pspace config set Set a configuration value. -## Usage +### Usage ``` config set [arguments] [arguments...] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -150,5 +150,5 @@ Set a configuration value. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md index 973c9e2..ff754d6 100644 --- a/.assets/pspace/console.md +++ b/.assets/pspace/console.md @@ -1,14 +1,14 @@ -# pspace console +## pspace console This command opens the Paperspace web console in your browser. -## Usage +### Usage ``` console [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -17,5 +17,5 @@ This command opens the Paperspace web console in your browser. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md index 36f7f87..86f00c4 100644 --- a/.assets/pspace/custom-template.md +++ b/.assets/pspace/custom-template.md @@ -1,4 +1,4 @@ -# pspace custom-template +## pspace custom-template Manage your custom templates. Custom templates are a backup of your machine's disk. They can be used to create additional machines. You @@ -6,14 +6,14 @@ can use them to prepopulate a machine with your desired software stack. For more information, see https://docs.paperspace.com/compute/custom-templates. -## Usage +### Usage ``` custom-template [command] custom-template [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,24 +22,24 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace custom-template create +## pspace custom-template create Create a custom template from a machine. -## Usage +### Usage ``` custom-template create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -51,19 +51,19 @@ Create a custom template from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template delete +## pspace custom-template delete Delete a custom template from a team. -## Usage +### Usage ``` custom-template delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -73,19 +73,19 @@ Delete a custom template from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template get +## pspace custom-template get Get a custom template from a team. -## Usage +### Usage ``` custom-template get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -95,20 +95,20 @@ Get a custom template from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template help +## pspace custom-template help Show help for a custom-template command -## Usage +### Usage ``` custom-template help [command] custom-template help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -117,10 +117,10 @@ Show help for a custom-template command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace custom-template help commands +## pspace custom-template help commands List custom-template commands @@ -129,13 +129,13 @@ Example: $ custom-template help commands commands ``` -## Usage +### Usage ``` custom-template help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -145,9 +145,9 @@ $ custom-template help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace custom-template list +## pspace custom-template list List custom templates in your team. @@ -156,13 +156,13 @@ Pick a subset of fields to display: pspace custom-template list -F name -F dtModified ``` -## Usage +### Usage ``` custom-template list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -180,5 +180,5 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md index e4df5ad..bdeff57 100644 --- a/.assets/pspace/dataset.md +++ b/.assets/pspace/dataset.md @@ -1,17 +1,17 @@ -# pspace dataset +## pspace dataset Manage your datasets. For more information, see https://docs.paperspace.com/storage/datasets. -## Usage +### Usage ``` dataset [command] dataset [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,7 +20,7 @@ For more information, see https://docs.paperspace.com/storage/datasets. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -29,17 +29,17 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) -# pspace dataset create +## pspace dataset create Create a dataset. -## Usage +### Usage ``` dataset create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -53,19 +53,19 @@ Create a dataset. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset delete +## pspace dataset delete Delete a dataset from a team. -## Usage +### Usage ``` dataset delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -75,19 +75,19 @@ Delete a dataset from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset get +## pspace dataset get Get a dataset from a team. -## Usage +### Usage ``` dataset get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -97,20 +97,20 @@ Get a dataset from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset help +## pspace dataset help Show help for a dataset command -## Usage +### Usage ``` dataset help [command] dataset help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -119,10 +119,10 @@ Show help for a dataset command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace dataset help commands +## pspace dataset help commands List dataset commands @@ -131,13 +131,13 @@ Example: $ dataset help commands commands ``` -## Usage +### Usage ``` dataset help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -147,9 +147,9 @@ $ dataset help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace dataset list +## pspace dataset list List datasets in your team or project. @@ -158,13 +158,13 @@ Pick a subset of fields to display: pspace dataset list -F name -F dtModified ``` -## Usage +### Usage ``` dataset list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -179,19 +179,19 @@ pspace dataset list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset update +## pspace dataset update Update a dataset in a project or team. -## Usage +### Usage ``` dataset update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -203,22 +203,22 @@ Update a dataset in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions +## pspace dataset versions Manage your dataset versions. For more information, see https://docs.paperspace.com/storage/datasetVersions. -## Usage +### Usage ``` dataset versions [command] dataset versions [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -227,7 +227,7 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -235,18 +235,18 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. - [help](#help) - [list](#list) - [update](#update) -# pspace dataset versions create +## pspace dataset versions create Create a dataset version. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions create [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -257,20 +257,20 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions delete +## pspace dataset versions delete Delete a dataset version from a team. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions delete [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -280,20 +280,20 @@ if you don't provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions get +## pspace dataset versions get Get a dataset version from a team. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions get [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -303,20 +303,20 @@ if you don't provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions help +## pspace dataset versions help Show help for a versions command -## Usage +### Usage ``` dataset versions help [command] dataset versions help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -325,10 +325,10 @@ Show help for a versions command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace dataset versions help commands +## pspace dataset versions help commands List versions commands @@ -337,13 +337,13 @@ Example: $ dataset versions help commands commands ``` -## Usage +### Usage ``` dataset versions help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -353,9 +353,9 @@ $ dataset versions help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace dataset versions list +## pspace dataset versions list List dataset versions in your team or project. @@ -364,13 +364,13 @@ Pick a subset of fields to display: pspace dataset versions list -F name -F dtModified ``` -## Usage +### Usage ``` dataset versions list [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -385,19 +385,19 @@ pspace dataset versions list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions update +## pspace dataset versions update Update a dataset version in a project or team. -## Usage +### Usage ``` dataset versions update [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -409,5 +409,5 @@ Update a dataset version in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md index 112991b..43fd736 100644 --- a/.assets/pspace/deployment.md +++ b/.assets/pspace/deployment.md @@ -1,15 +1,15 @@ -# pspace deployment +## pspace deployment Effortlessly deploy ML apps to Paperspace. -## Usage +### Usage ``` deployment [command] deployment [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -18,14 +18,14 @@ Effortlessly deploy ML apps to Paperspace. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) - [up](#up) -# pspace deployment delete +## pspace deployment delete Delete a deployment by its ID. If you don't provide an ID, this command will prompt you for one based on the deployments you have access to. @@ -34,13 +34,13 @@ prompt you for one based on the deployments you have access to. pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ``` -## Usage +### Usage ``` deployment delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -49,9 +49,9 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment get +## pspace deployment get Get a deployment by its ID. If you don't provide an ID, this command will prompt you for one based on the deployments you have access to. @@ -65,13 +65,13 @@ Pick a subset of fields to display: pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ``` -## Usage +### Usage ``` deployment get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -81,20 +81,20 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment help +## pspace deployment help Show help for a deployment command -## Usage +### Usage ``` deployment help [command] deployment help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -103,10 +103,10 @@ Show help for a deployment command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace deployment help commands +## pspace deployment help commands List deployment commands @@ -115,13 +115,13 @@ Example: $ deployment help commands commands ``` -## Usage +### Usage ``` deployment help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -131,9 +131,9 @@ $ deployment help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace deployment list +## pspace deployment list List deployments in your team. @@ -142,13 +142,13 @@ Pick a subset of fields to display: pspace deployment list -F id -F name ``` -## Usage +### Usage ``` deployment list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -163,9 +163,9 @@ pspace deployment list -F id -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment up +## pspace deployment up This will create a new deployment for your app or update it if it already exists. You can optionally specify a path to a config file. If no config file is specified, @@ -191,13 +191,13 @@ Create a new deployment for an app in a specific project. $ pspace deployment create --project-id 1234 ``` -## Usage +### Usage ``` deployment up [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -222,5 +222,5 @@ The default config file paths are in order of precedence: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md index a9638fe..9fc6307 100644 --- a/.assets/pspace/docs.md +++ b/.assets/pspace/docs.md @@ -1,4 +1,4 @@ -# pspace docs +## pspace docs This command opens the Paperspace documentation in your browser. You can optionally pass an argument that will take you to a specific @@ -7,13 +7,13 @@ docs page. Valid pages are: - `d`, `deployment` -## Usage +### Usage ``` docs [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,5 +22,5 @@ Valid pages are: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md index e3c02cf..ab64c90 100644 --- a/.assets/pspace/help.md +++ b/.assets/pspace/help.md @@ -1,15 +1,15 @@ -# pspace help +## pspace help Show help for a pspace command -## Usage +### Usage ``` help [command] help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -18,10 +18,10 @@ Show help for a pspace command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace help commands +## pspace help commands List pspace commands @@ -30,13 +30,13 @@ Example: $ help commands commands ``` -## Usage +### Usage ``` help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -46,5 +46,5 @@ $ help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md index 38e27e7..d2a2e36 100644 --- a/.assets/pspace/init.md +++ b/.assets/pspace/init.md @@ -1,4 +1,4 @@ -# pspace init +## pspace init Create a new Paperspace app. This will create a new directory with a default app structure. You can optionally specify a name for the app @@ -21,13 +21,13 @@ a template from the Paperspace GitHub organization. $ pspace init my-app -t Paperspace/gradio-demo ``` -## Usage +### Usage ``` init [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -73,5 +73,5 @@ SSH key configured with GitHub, Bitbucket, or GitLab. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md index 80217e7..91aa8fd 100644 --- a/.assets/pspace/login.md +++ b/.assets/pspace/login.md @@ -1,14 +1,14 @@ -# pspace login +## pspace login Log in to the CLI using your Paperspace API key or by opening the web console. -## Usage +### Usage ``` login [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -17,5 +17,5 @@ Log in to the CLI using your Paperspace API key or by opening the web console. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md index 35b5296..c2bb7b8 100644 --- a/.assets/pspace/logout.md +++ b/.assets/pspace/logout.md @@ -1,14 +1,14 @@ -# pspace logout +## pspace logout Log out of the CLI for the current team, a specific team, or all teams. -## Usage +### Usage ``` logout [arguments...] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -18,5 +18,5 @@ Log out of the CLI for the current team, a specific team, or all teams. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md index e31573b..8e7a553 100644 --- a/.assets/pspace/machine-event.md +++ b/.assets/pspace/machine-event.md @@ -1,4 +1,4 @@ -# pspace machine-event +## pspace machine-event Manage your machine events. Events are asynchronous tasks performed by our system on your machines. Not all machine commands are asynchronous. For those that are, a machine event will be returned @@ -6,14 +6,14 @@ which can be tracked using this command. For more information, see https://docs.paperspace.com/machines. -## Usage +### Usage ``` machine-event [command] machine-event [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,22 +22,22 @@ For more information, see https://docs.paperspace.com/machines. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [get](#get) - [help](#help) - [list](#list) -# pspace machine-event get +## pspace machine-event get Get a machine event from a team. -## Usage +### Usage ``` machine-event get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -47,20 +47,20 @@ Get a machine event from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine-event help +## pspace machine-event help Show help for a machine-event command -## Usage +### Usage ``` machine-event help [command] machine-event help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -69,10 +69,10 @@ Show help for a machine-event command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace machine-event help commands +## pspace machine-event help commands List machine-event commands @@ -81,13 +81,13 @@ Example: $ machine-event help commands commands ``` -## Usage +### Usage ``` machine-event help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -97,9 +97,9 @@ $ machine-event help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace machine-event list +## pspace machine-event list List machine events in your team. @@ -108,13 +108,13 @@ Pick a subset of fields to display: pspace machine-event list -F name -F dtModified ``` -## Usage +### Usage ``` machine-event list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -131,5 +131,5 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md index 9fd1422..ab3840a 100644 --- a/.assets/pspace/machine.md +++ b/.assets/pspace/machine.md @@ -1,17 +1,17 @@ -# pspace machine +## pspace machine Manage your Paperspace machines. For more information, see https://docs.paperspace.com/machines. -## Usage +### Usage ``` machine [command] machine [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,7 +20,7 @@ For more information, see https://docs.paperspace.com/machines. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -31,17 +31,17 @@ For more information, see https://docs.paperspace.com/machines. - [start](#start) - [stop](#stop) - [update](#update) -# pspace machine create +## pspace machine create Create a machine. -## Usage +### Usage ``` machine create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -72,19 +72,19 @@ Create a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine delete +## pspace machine delete Delete a machine from a team. -## Usage +### Usage ``` machine delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -94,19 +94,19 @@ Delete a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine get +## pspace machine get Get a machine from a team. -## Usage +### Usage ``` machine get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -116,20 +116,20 @@ Get a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine help +## pspace machine help Show help for a machine command -## Usage +### Usage ``` machine help [command] machine help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -138,10 +138,10 @@ Show help for a machine command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace machine help commands +## pspace machine help commands List machine commands @@ -150,13 +150,13 @@ Example: $ machine help commands commands ``` -## Usage +### Usage ``` machine help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -166,9 +166,9 @@ $ machine help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace machine list +## pspace machine list List machines in your team. @@ -177,13 +177,13 @@ Pick a subset of fields to display: pspace machine list -F name -F dtModified ``` -## Usage +### Usage ``` machine list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -202,19 +202,19 @@ pspace machine list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine restart +## pspace machine restart Restart a machine from a team. -## Usage +### Usage ``` machine restart [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -224,19 +224,19 @@ Restart a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine start +## pspace machine start Start a machine from a team. -## Usage +### Usage ``` machine start [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -246,19 +246,19 @@ Start a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine stop +## pspace machine stop Stop a machine from a team. -## Usage +### Usage ``` machine stop [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -268,19 +268,19 @@ Stop a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine update +## pspace machine update Update a machine's settings. -## Usage +### Usage ``` machine update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -304,5 +304,5 @@ Update a machine's settings. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md index 0e24693..6f50a26 100644 --- a/.assets/pspace/model.md +++ b/.assets/pspace/model.md @@ -1,17 +1,17 @@ -# pspace model +## pspace model Manage your Paperspace models. For more information, see https://docs.paperspace.com/deploying/models. -## Usage +### Usage ``` model [command] model [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,25 +20,25 @@ For more information, see https://docs.paperspace.com/deploying/models. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace model create +## pspace model create Create a new model. This command will prompt you for a name if you don't provide one. -## Usage +### Usage ``` model create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -53,19 +53,19 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model delete +## pspace model delete Delete a model from a team. -## Usage +### Usage ``` model delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -75,19 +75,19 @@ Delete a model from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model get +## pspace model get Get a model from a team. -## Usage +### Usage ``` model get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -97,20 +97,20 @@ Get a model from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model help +## pspace model help Show help for a model command -## Usage +### Usage ``` model help [command] model help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -119,10 +119,10 @@ Show help for a model command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace model help commands +## pspace model help commands List model commands @@ -131,13 +131,13 @@ Example: $ model help commands commands ``` -## Usage +### Usage ``` model help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -147,9 +147,9 @@ $ model help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace model list +## pspace model list List models in your team. @@ -158,13 +158,13 @@ Pick a subset of fields to display: pspace model list -F name -F dtModified ``` -## Usage +### Usage ``` model list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -179,5 +179,5 @@ pspace model list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md index 2794b08..fca33b0 100644 --- a/.assets/pspace/os-template.md +++ b/.assets/pspace/os-template.md @@ -1,18 +1,18 @@ -# pspace os-template +## pspace os-template List OS templates. OS templates are pre-configured virtual machines that you can use to create a new machine. For more information, see https://docs.paperspace.com/compute/os-templates. -## Usage +### Usage ``` os-template [command] os-template [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -21,22 +21,22 @@ For more information, see https://docs.paperspace.com/compute/os-templates. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [list](#list) -# pspace os-template help +## pspace os-template help Show help for a os-template command -## Usage +### Usage ``` os-template help [command] os-template help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -45,10 +45,10 @@ Show help for a os-template command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace os-template help commands +## pspace os-template help commands List os-template commands @@ -57,13 +57,13 @@ Example: $ os-template help commands commands ``` -## Usage +### Usage ``` os-template help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -73,9 +73,9 @@ $ os-template help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace os-template list +## pspace os-template list List OS templates. @@ -84,13 +84,13 @@ Pick a subset of fields to display: pspace os-template list -F name ``` -## Usage +### Usage ``` os-template list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -106,5 +106,5 @@ pspace os-template list -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md index 664df28..b37f679 100644 --- a/.assets/pspace/private-network.md +++ b/.assets/pspace/private-network.md @@ -1,4 +1,4 @@ -# pspace private-network +## pspace private-network Manage your private networks. Private networks are logically isolated networks for your machines and shared drives. They can also be used for site-to-site VPNs @@ -6,14 +6,14 @@ and direct connections to your on-premise network. For more information, see https://docs.paperspace.com/networking/private-networks. -## Usage +### Usage ``` private-network [command] private-network [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,24 +22,24 @@ For more information, see https://docs.paperspace.com/networking/private-network | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace private-network create +## pspace private-network create Create a private network. -## Usage +### Usage ``` private-network create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -51,19 +51,19 @@ Create a private network. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network delete +## pspace private-network delete Delete a private network from a team. -## Usage +### Usage ``` private-network delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -73,19 +73,19 @@ Delete a private network from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network get +## pspace private-network get Get a private network from a team. -## Usage +### Usage ``` private-network get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -95,20 +95,20 @@ Get a private network from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network help +## pspace private-network help Show help for a private-network command -## Usage +### Usage ``` private-network help [command] private-network help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -117,10 +117,10 @@ Show help for a private-network command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace private-network help commands +## pspace private-network help commands List private-network commands @@ -129,13 +129,13 @@ Example: $ private-network help commands commands ``` -## Usage +### Usage ``` private-network help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -145,9 +145,9 @@ $ private-network help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace private-network list +## pspace private-network list List private networks in your team. @@ -156,13 +156,13 @@ Pick a subset of fields to display: pspace private-network list -F name -F dtModified ``` -## Usage +### Usage ``` private-network list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -179,5 +179,5 @@ pspace private-network list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md index 64bd150..8b654c4 100644 --- a/.assets/pspace/project.md +++ b/.assets/pspace/project.md @@ -1,15 +1,15 @@ -# pspace project +## pspace project Manage your Paperspace projects. -## Usage +### Usage ``` project [command] project [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -18,7 +18,7 @@ Manage your Paperspace projects. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -27,18 +27,18 @@ Manage your Paperspace projects. - [link](#link) - [list](#list) - [update](#update) -# pspace project create +## pspace project create Create a new project. This command will prompt you for a name if you don't provide one. -## Usage +### Usage ``` project create [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -48,20 +48,20 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project delete +## pspace project delete Delete a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. -## Usage +### Usage ``` project delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -71,20 +71,20 @@ prompt you for one based on the projects you have access to. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project get +## pspace project get Get a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. -## Usage +### Usage ``` project get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -94,20 +94,20 @@ prompt you for one based on the projects you have access to. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project help +## pspace project help Show help for a project command -## Usage +### Usage ``` project help [command] project help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -116,10 +116,10 @@ Show help for a project command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace project help commands +## pspace project help commands List project commands @@ -128,13 +128,13 @@ Example: $ project help commands commands ``` -## Usage +### Usage ``` project help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -144,9 +144,9 @@ $ project help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace project link +## pspace project link This will link a remote project to a local directory. Commands that depend on a project ID will use the project ID of the linked project @@ -167,13 +167,13 @@ Link a project and specify a project ID. $ pspace link pzwf2g05ubegj ``` -## Usage +### Usage ``` project link [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -183,9 +183,9 @@ $ pspace link pzwf2g05ubegj | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project list +## pspace project list List projects in your team. @@ -194,13 +194,13 @@ Pick a subset of fields to display: pspace project list -F id -F name -F dtCreated ``` -## Usage +### Usage ``` project list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -215,9 +215,9 @@ pspace project list -F id -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project update +## pspace project update Update an existing project. @@ -226,13 +226,13 @@ Example: pspace project update psukfyemho7 --name my-cool-project ``` -## Usage +### Usage ``` pspace project update [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -243,5 +243,5 @@ pspace project update psukfyemho7 --name my-cool-project | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md index a420565..3fbafe3 100644 --- a/.assets/pspace/pspace.md +++ b/.assets/pspace/pspace.md @@ -1,4 +1,4 @@ -# pspace +## pspace A CLI for using the Paperspace API. @@ -10,14 +10,14 @@ It allows you to authenticate, launch deployments, do logging, and more. Read the full documentation at: https://docs.paperspace.com/ -## Usage +### Usage ``` pspace [command] pspace [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -26,7 +26,7 @@ Read the full documentation at: https://docs.paperspace.com/ | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [autoscaling-group](#autoscaling-group) - [completion](#completion) @@ -56,20 +56,20 @@ Read the full documentation at: https://docs.paperspace.com/ - [up](#up) - [upgrade](#upgrade) - [version](#version) -# pspace autoscaling-group +## pspace autoscaling-group Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes cluster-autoscaler to automatically scale your cluster. You can also autoscaling groups as a primitive for your own autoscaler. -## Usage +### Usage ``` autoscaling-group [command] autoscaling-group [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -78,7 +78,7 @@ You can also autoscaling groups as a primitive for your own autoscaler. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -86,17 +86,17 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) -# pspace autoscaling-group create +## pspace autoscaling-group create Create an autoscaling group. -## Usage +### Usage ``` autoscaling-group create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -115,19 +115,19 @@ Create an autoscaling group. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group delete +## pspace autoscaling-group delete Delete an autoscaling group from a team. -## Usage +### Usage ``` autoscaling-group delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -137,19 +137,19 @@ Delete an autoscaling group from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group get +## pspace autoscaling-group get Get an autoscaling group from a team. -## Usage +### Usage ``` autoscaling-group get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -159,20 +159,20 @@ Get an autoscaling group from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group help +## pspace autoscaling-group help Show help for a autoscaling-group command -## Usage +### Usage ``` autoscaling-group help [command] autoscaling-group help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -181,10 +181,10 @@ Show help for a autoscaling-group command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace autoscaling-group help commands +## pspace autoscaling-group help commands List autoscaling-group commands @@ -193,13 +193,13 @@ Example: $ autoscaling-group help commands commands ``` -## Usage +### Usage ``` autoscaling-group help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -209,9 +209,9 @@ $ autoscaling-group help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group list +## pspace autoscaling-group list List autoscaling groups in your team. @@ -220,13 +220,13 @@ Pick a subset of fields to display: pspace autoscaling-group list -F name -F dtCreated ``` -## Usage +### Usage ``` autoscaling-group list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -243,19 +243,19 @@ pspace autoscaling-group list -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace autoscaling-group update +## pspace autoscaling-group update Update an autoscaling group. -## Usage +### Usage ``` autoscaling-group update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -275,21 +275,21 @@ Update an autoscaling group. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace completion +## pspace completion Generate an autocompletion script for pspace in the specified shell. See each sub-command's help for details on how to use the generated script. -## Usage +### Usage ``` completion [command] completion [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -298,13 +298,13 @@ See each sub-command's help for details on how to use the generated script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [bash](#bash) - [fish](#fish) - [help](#help) - [zsh](#zsh) -# pspace completion bash +## pspace completion bash Generate the autocompletion script for the bash shell. @@ -330,13 +330,13 @@ $ completion bash bash > /usr/local/etc/bash_completion.d/pspace You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion bash [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -345,9 +345,9 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace completion fish +## pspace completion fish Generate the autocompletion script for the fish shell. @@ -363,13 +363,13 @@ $ completion fish fish > ~/.config/fish/completions/pspace.fish You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion fish [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -379,20 +379,20 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace completion help +## pspace completion help Show help for a completion command -## Usage +### Usage ``` completion help [command] completion help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -401,10 +401,10 @@ Show help for a completion command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace completion help commands +## pspace completion help commands List completion commands @@ -413,13 +413,13 @@ Example: $ completion help commands commands ``` -## Usage +### Usage ``` completion help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -429,9 +429,9 @@ $ completion help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace completion zsh +## pspace completion zsh Generate the autocompletion script for the zsh shell. @@ -461,13 +461,13 @@ $ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace You will need to start a new shell for this setup to take effect. -## Usage +### Usage ``` completion zsh [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -477,9 +477,9 @@ You will need to start a new shell for this setup to take effect. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace config +## pspace config This command manages your Paperspace configuration. You can use it to set, get, and delete configuration values. Running this command without any subcommands will print @@ -492,14 +492,14 @@ For example, to set the current team, run: pspace config set team "my-team" ``` -## Usage +### Usage ``` config [command] config [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -508,23 +508,23 @@ pspace config set team "my-team" | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [delete](#delete) - [get](#get) - [help](#help) - [set](#set) -# pspace config delete +## pspace config delete Delete a configuration value. -## Usage +### Usage ``` config delete [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -533,9 +533,9 @@ Delete a configuration value. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace config get +## pspace config get This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values. @@ -545,13 +545,13 @@ For example, to get the current team run: pspace config get team ``` -## Usage +### Usage ``` config get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -560,20 +560,20 @@ pspace config get team | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace config help +## pspace config help Show help for a config command -## Usage +### Usage ``` config help [command] config help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -582,10 +582,10 @@ Show help for a config command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace config help commands +## pspace config help commands List config commands @@ -594,13 +594,13 @@ Example: $ config help commands commands ``` -## Usage +### Usage ``` config help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -610,19 +610,19 @@ $ config help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace config set +## pspace config set Set a configuration value. -## Usage +### Usage ``` config set [arguments] [arguments...] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -631,19 +631,19 @@ Set a configuration value. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace console +## pspace console This command opens the Paperspace web console in your browser. -## Usage +### Usage ``` console [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -652,9 +652,9 @@ This command opens the Paperspace web console in your browser. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template +## pspace custom-template Manage your custom templates. Custom templates are a backup of your machine's disk. They can be used to create additional machines. You @@ -662,14 +662,14 @@ can use them to prepopulate a machine with your desired software stack. For more information, see https://docs.paperspace.com/compute/custom-templates. -## Usage +### Usage ``` custom-template [command] custom-template [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -678,24 +678,24 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace custom-template create +## pspace custom-template create Create a custom template from a machine. -## Usage +### Usage ``` custom-template create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -707,19 +707,19 @@ Create a custom template from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template delete +## pspace custom-template delete Delete a custom template from a team. -## Usage +### Usage ``` custom-template delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -729,19 +729,19 @@ Delete a custom template from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template get +## pspace custom-template get Get a custom template from a team. -## Usage +### Usage ``` custom-template get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -751,20 +751,20 @@ Get a custom template from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace custom-template help +## pspace custom-template help Show help for a custom-template command -## Usage +### Usage ``` custom-template help [command] custom-template help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -773,10 +773,10 @@ Show help for a custom-template command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace custom-template help commands +## pspace custom-template help commands List custom-template commands @@ -785,13 +785,13 @@ Example: $ custom-template help commands commands ``` -## Usage +### Usage ``` custom-template help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -801,9 +801,9 @@ $ custom-template help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace custom-template list +## pspace custom-template list List custom templates in your team. @@ -812,13 +812,13 @@ Pick a subset of fields to display: pspace custom-template list -F name -F dtModified ``` -## Usage +### Usage ``` custom-template list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -836,22 +836,22 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset +## pspace dataset Manage your datasets. For more information, see https://docs.paperspace.com/storage/datasets. -## Usage +### Usage ``` dataset [command] dataset [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -860,7 +860,7 @@ For more information, see https://docs.paperspace.com/storage/datasets. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -869,17 +869,17 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) -# pspace dataset create +## pspace dataset create Create a dataset. -## Usage +### Usage ``` dataset create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -893,19 +893,19 @@ Create a dataset. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset delete +## pspace dataset delete Delete a dataset from a team. -## Usage +### Usage ``` dataset delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -915,19 +915,19 @@ Delete a dataset from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset get +## pspace dataset get Get a dataset from a team. -## Usage +### Usage ``` dataset get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -937,20 +937,20 @@ Get a dataset from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset help +## pspace dataset help Show help for a dataset command -## Usage +### Usage ``` dataset help [command] dataset help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -959,10 +959,10 @@ Show help for a dataset command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace dataset help commands +## pspace dataset help commands List dataset commands @@ -971,13 +971,13 @@ Example: $ dataset help commands commands ``` -## Usage +### Usage ``` dataset help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -987,9 +987,9 @@ $ dataset help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace dataset list +## pspace dataset list List datasets in your team or project. @@ -998,13 +998,13 @@ Pick a subset of fields to display: pspace dataset list -F name -F dtModified ``` -## Usage +### Usage ``` dataset list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1019,19 +1019,19 @@ pspace dataset list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset update +## pspace dataset update Update a dataset in a project or team. -## Usage +### Usage ``` dataset update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1043,22 +1043,22 @@ Update a dataset in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions +## pspace dataset versions Manage your dataset versions. For more information, see https://docs.paperspace.com/storage/datasetVersions. -## Usage +### Usage ``` dataset versions [command] dataset versions [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1067,7 +1067,7 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -1075,18 +1075,18 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. - [help](#help) - [list](#list) - [update](#update) -# pspace dataset versions create +## pspace dataset versions create Create a dataset version. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions create [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1097,20 +1097,20 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions delete +## pspace dataset versions delete Delete a dataset version from a team. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions delete [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1120,20 +1120,20 @@ if you don't provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions get +## pspace dataset versions get Get a dataset version from a team. This command will prompt you for an ID if you don't provide one. -## Usage +### Usage ``` dataset versions get [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1143,20 +1143,20 @@ if you don't provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions help +## pspace dataset versions help Show help for a versions command -## Usage +### Usage ``` dataset versions help [command] dataset versions help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1165,10 +1165,10 @@ Show help for a versions command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace dataset versions help commands +## pspace dataset versions help commands List versions commands @@ -1177,13 +1177,13 @@ Example: $ dataset versions help commands commands ``` -## Usage +### Usage ``` dataset versions help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1193,9 +1193,9 @@ $ dataset versions help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace dataset versions list +## pspace dataset versions list List dataset versions in your team or project. @@ -1204,13 +1204,13 @@ Pick a subset of fields to display: pspace dataset versions list -F name -F dtModified ``` -## Usage +### Usage ``` dataset versions list [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1225,19 +1225,19 @@ pspace dataset versions list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace dataset versions update +## pspace dataset versions update Update a dataset version in a project or team. -## Usage +### Usage ``` dataset versions update [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1249,20 +1249,20 @@ Update a dataset version in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment +## pspace deployment Effortlessly deploy ML apps to Paperspace. -## Usage +### Usage ``` deployment [command] deployment [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1271,14 +1271,14 @@ Effortlessly deploy ML apps to Paperspace. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) - [up](#up) -# pspace deployment delete +## pspace deployment delete Delete a deployment by its ID. If you don't provide an ID, this command will prompt you for one based on the deployments you have access to. @@ -1287,13 +1287,13 @@ prompt you for one based on the deployments you have access to. pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ``` -## Usage +### Usage ``` deployment delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1302,9 +1302,9 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment get +## pspace deployment get Get a deployment by its ID. If you don't provide an ID, this command will prompt you for one based on the deployments you have access to. @@ -1318,13 +1318,13 @@ Pick a subset of fields to display: pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ``` -## Usage +### Usage ``` deployment get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1334,20 +1334,20 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment help +## pspace deployment help Show help for a deployment command -## Usage +### Usage ``` deployment help [command] deployment help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1356,10 +1356,10 @@ Show help for a deployment command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace deployment help commands +## pspace deployment help commands List deployment commands @@ -1368,13 +1368,13 @@ Example: $ deployment help commands commands ``` -## Usage +### Usage ``` deployment help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1384,9 +1384,9 @@ $ deployment help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace deployment list +## pspace deployment list List deployments in your team. @@ -1395,13 +1395,13 @@ Pick a subset of fields to display: pspace deployment list -F id -F name ``` -## Usage +### Usage ``` deployment list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1416,9 +1416,9 @@ pspace deployment list -F id -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace deployment up +## pspace deployment up This will create a new deployment for your app or update it if it already exists. You can optionally specify a path to a config file. If no config file is specified, @@ -1444,13 +1444,13 @@ Create a new deployment for an app in a specific project. $ pspace deployment create --project-id 1234 ``` -## Usage +### Usage ``` deployment up [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1475,9 +1475,9 @@ The default config file paths are in order of precedence: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace docs +## pspace docs This command opens the Paperspace documentation in your browser. You can optionally pass an argument that will take you to a specific @@ -1486,13 +1486,13 @@ docs page. Valid pages are: - `d`, `deployment` -## Usage +### Usage ``` docs [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1501,20 +1501,20 @@ Valid pages are: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace help +## pspace help Show help for a pspace command -## Usage +### Usage ``` help [command] help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1523,10 +1523,10 @@ Show help for a pspace command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace help commands +## pspace help commands List pspace commands @@ -1535,13 +1535,13 @@ Example: $ help commands commands ``` -## Usage +### Usage ``` help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1551,9 +1551,9 @@ $ help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace init +## pspace init Create a new Paperspace app. This will create a new directory with a default app structure. You can optionally specify a name for the app @@ -1576,13 +1576,13 @@ a template from the Paperspace GitHub organization. $ pspace init my-app -t Paperspace/gradio-demo ``` -## Usage +### Usage ``` init [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1628,19 +1628,19 @@ SSH key configured with GitHub, Bitbucket, or GitLab. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace login +## pspace login Log in to the CLI using your Paperspace API key or by opening the web console. -## Usage +### Usage ``` login [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1649,19 +1649,19 @@ Log in to the CLI using your Paperspace API key or by opening the web console. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace logout +## pspace logout Log out of the CLI for the current team, a specific team, or all teams. -## Usage +### Usage ``` logout [arguments...] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1671,22 +1671,22 @@ Log out of the CLI for the current team, a specific team, or all teams. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine +## pspace machine Manage your Paperspace machines. For more information, see https://docs.paperspace.com/machines. -## Usage +### Usage ``` machine [command] machine [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1695,7 +1695,7 @@ For more information, see https://docs.paperspace.com/machines. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -1706,17 +1706,17 @@ For more information, see https://docs.paperspace.com/machines. - [start](#start) - [stop](#stop) - [update](#update) -# pspace machine create +## pspace machine create Create a machine. -## Usage +### Usage ``` machine create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1747,19 +1747,19 @@ Create a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine delete +## pspace machine delete Delete a machine from a team. -## Usage +### Usage ``` machine delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1769,19 +1769,19 @@ Delete a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine get +## pspace machine get Get a machine from a team. -## Usage +### Usage ``` machine get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1791,20 +1791,20 @@ Get a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine help +## pspace machine help Show help for a machine command -## Usage +### Usage ``` machine help [command] machine help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1813,10 +1813,10 @@ Show help for a machine command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace machine help commands +## pspace machine help commands List machine commands @@ -1825,13 +1825,13 @@ Example: $ machine help commands commands ``` -## Usage +### Usage ``` machine help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1841,9 +1841,9 @@ $ machine help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace machine list +## pspace machine list List machines in your team. @@ -1852,13 +1852,13 @@ Pick a subset of fields to display: pspace machine list -F name -F dtModified ``` -## Usage +### Usage ``` machine list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1877,19 +1877,19 @@ pspace machine list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine restart +## pspace machine restart Restart a machine from a team. -## Usage +### Usage ``` machine restart [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1899,19 +1899,19 @@ Restart a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine start +## pspace machine start Start a machine from a team. -## Usage +### Usage ``` machine start [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1921,19 +1921,19 @@ Start a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine stop +## pspace machine stop Stop a machine from a team. -## Usage +### Usage ``` machine stop [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1943,19 +1943,19 @@ Stop a machine from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine update +## pspace machine update Update a machine's settings. -## Usage +### Usage ``` machine update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -1979,9 +1979,9 @@ Update a machine's settings. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine-event +## pspace machine-event Manage your machine events. Events are asynchronous tasks performed by our system on your machines. Not all machine commands are asynchronous. For those that are, a machine event will be returned @@ -1989,14 +1989,14 @@ which can be tracked using this command. For more information, see https://docs.paperspace.com/machines. -## Usage +### Usage ``` machine-event [command] machine-event [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2005,22 +2005,22 @@ For more information, see https://docs.paperspace.com/machines. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [get](#get) - [help](#help) - [list](#list) -# pspace machine-event get +## pspace machine-event get Get a machine event from a team. -## Usage +### Usage ``` machine-event get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2030,20 +2030,20 @@ Get a machine event from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace machine-event help +## pspace machine-event help Show help for a machine-event command -## Usage +### Usage ``` machine-event help [command] machine-event help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2052,10 +2052,10 @@ Show help for a machine-event command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace machine-event help commands +## pspace machine-event help commands List machine-event commands @@ -2064,13 +2064,13 @@ Example: $ machine-event help commands commands ``` -## Usage +### Usage ``` machine-event help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2080,9 +2080,9 @@ $ machine-event help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace machine-event list +## pspace machine-event list List machine events in your team. @@ -2091,13 +2091,13 @@ Pick a subset of fields to display: pspace machine-event list -F name -F dtModified ``` -## Usage +### Usage ``` machine-event list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2114,22 +2114,22 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model +## pspace model Manage your Paperspace models. For more information, see https://docs.paperspace.com/deploying/models. -## Usage +### Usage ``` model [command] model [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2138,25 +2138,25 @@ For more information, see https://docs.paperspace.com/deploying/models. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace model create +## pspace model create Create a new model. This command will prompt you for a name if you don't provide one. -## Usage +### Usage ``` model create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2171,19 +2171,19 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model delete +## pspace model delete Delete a model from a team. -## Usage +### Usage ``` model delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2193,19 +2193,19 @@ Delete a model from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model get +## pspace model get Get a model from a team. -## Usage +### Usage ``` model get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2215,20 +2215,20 @@ Get a model from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace model help +## pspace model help Show help for a model command -## Usage +### Usage ``` model help [command] model help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2237,10 +2237,10 @@ Show help for a model command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace model help commands +## pspace model help commands List model commands @@ -2249,13 +2249,13 @@ Example: $ model help commands commands ``` -## Usage +### Usage ``` model help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2265,9 +2265,9 @@ $ model help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace model list +## pspace model list List models in your team. @@ -2276,13 +2276,13 @@ Pick a subset of fields to display: pspace model list -F name -F dtModified ``` -## Usage +### Usage ``` model list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2297,23 +2297,23 @@ pspace model list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace os-template +## pspace os-template List OS templates. OS templates are pre-configured virtual machines that you can use to create a new machine. For more information, see https://docs.paperspace.com/compute/os-templates. -## Usage +### Usage ``` os-template [command] os-template [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2322,22 +2322,22 @@ For more information, see https://docs.paperspace.com/compute/os-templates. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [list](#list) -# pspace os-template help +## pspace os-template help Show help for a os-template command -## Usage +### Usage ``` os-template help [command] os-template help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2346,10 +2346,10 @@ Show help for a os-template command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace os-template help commands +## pspace os-template help commands List os-template commands @@ -2358,13 +2358,13 @@ Example: $ os-template help commands commands ``` -## Usage +### Usage ``` os-template help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2374,9 +2374,9 @@ $ os-template help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace os-template list +## pspace os-template list List OS templates. @@ -2385,13 +2385,13 @@ Pick a subset of fields to display: pspace os-template list -F name ``` -## Usage +### Usage ``` os-template list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2407,9 +2407,9 @@ pspace os-template list -F name | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network +## pspace private-network Manage your private networks. Private networks are logically isolated networks for your machines and shared drives. They can also be used for site-to-site VPNs @@ -2417,14 +2417,14 @@ and direct connections to your on-premise network. For more information, see https://docs.paperspace.com/networking/private-networks. -## Usage +### Usage ``` private-network [command] private-network [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2433,24 +2433,24 @@ For more information, see https://docs.paperspace.com/networking/private-network | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace private-network create +## pspace private-network create Create a private network. -## Usage +### Usage ``` private-network create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2462,19 +2462,19 @@ Create a private network. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network delete +## pspace private-network delete Delete a private network from a team. -## Usage +### Usage ``` private-network delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2484,19 +2484,19 @@ Delete a private network from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network get +## pspace private-network get Get a private network from a team. -## Usage +### Usage ``` private-network get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2506,20 +2506,20 @@ Get a private network from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace private-network help +## pspace private-network help Show help for a private-network command -## Usage +### Usage ``` private-network help [command] private-network help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2528,10 +2528,10 @@ Show help for a private-network command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace private-network help commands +## pspace private-network help commands List private-network commands @@ -2540,13 +2540,13 @@ Example: $ private-network help commands commands ``` -## Usage +### Usage ``` private-network help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2556,9 +2556,9 @@ $ private-network help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace private-network list +## pspace private-network list List private networks in your team. @@ -2567,13 +2567,13 @@ Pick a subset of fields to display: pspace private-network list -F name -F dtModified ``` -## Usage +### Usage ``` private-network list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2590,20 +2590,20 @@ pspace private-network list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project +## pspace project Manage your Paperspace projects. -## Usage +### Usage ``` project [command] project [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2612,7 +2612,7 @@ Manage your Paperspace projects. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -2621,18 +2621,18 @@ Manage your Paperspace projects. - [link](#link) - [list](#list) - [update](#update) -# pspace project create +## pspace project create Create a new project. This command will prompt you for a name if you don't provide one. -## Usage +### Usage ``` project create [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2642,20 +2642,20 @@ provide one. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project delete +## pspace project delete Delete a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. -## Usage +### Usage ``` project delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2665,20 +2665,20 @@ prompt you for one based on the projects you have access to. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project get +## pspace project get Get a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. -## Usage +### Usage ``` project get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2688,20 +2688,20 @@ prompt you for one based on the projects you have access to. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project help +## pspace project help Show help for a project command -## Usage +### Usage ``` project help [command] project help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2710,10 +2710,10 @@ Show help for a project command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace project help commands +## pspace project help commands List project commands @@ -2722,13 +2722,13 @@ Example: $ project help commands commands ``` -## Usage +### Usage ``` project help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2738,9 +2738,9 @@ $ project help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace project link +## pspace project link This will link a remote project to a local directory. Commands that depend on a project ID will use the project ID of the linked project @@ -2761,13 +2761,13 @@ Link a project and specify a project ID. $ pspace link pzwf2g05ubegj ``` -## Usage +### Usage ``` project link [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2777,9 +2777,9 @@ $ pspace link pzwf2g05ubegj | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project list +## pspace project list List projects in your team. @@ -2788,13 +2788,13 @@ Pick a subset of fields to display: pspace project list -F id -F name -F dtCreated ``` -## Usage +### Usage ``` project list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2809,9 +2809,9 @@ pspace project list -F id -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace project update +## pspace project update Update an existing project. @@ -2820,13 +2820,13 @@ Example: pspace project update psukfyemho7 --name my-cool-project ``` -## Usage +### Usage ``` pspace project update [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2837,22 +2837,22 @@ pspace project update psukfyemho7 --name my-cool-project | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip +## pspace public-ip Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. For more information, see https://docs.paperspace.com/networking/public-ips. -## Usage +### Usage ``` public-ip [command] public-ip [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2861,24 +2861,24 @@ For more information, see https://docs.paperspace.com/networking/public-ips. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [assign](#assign) - [claim](#claim) - [help](#help) - [list](#list) - [release](#release) -# pspace public-ip assign +## pspace public-ip assign Assign a public IP to a machine. -## Usage +### Usage ``` public-ip assign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2889,19 +2889,19 @@ Assign a public IP to a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip claim +## pspace public-ip claim Claim a public IP for a team. -## Usage +### Usage ``` public-ip claim [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2912,20 +2912,20 @@ Claim a public IP for a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip help +## pspace public-ip help Show help for a public-ip command -## Usage +### Usage ``` public-ip help [command] public-ip help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2934,10 +2934,10 @@ Show help for a public-ip command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace public-ip help commands +## pspace public-ip help commands List public-ip commands @@ -2946,13 +2946,13 @@ Example: $ public-ip help commands commands ``` -## Usage +### Usage ``` public-ip help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2962,9 +2962,9 @@ $ public-ip help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace public-ip list +## pspace public-ip list List public IPs in your team or project. @@ -2973,13 +2973,13 @@ Pick a subset of fields to display: pspace public-ip list -F name -F dtModified ``` -## Usage +### Usage ``` public-ip list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -2995,19 +2995,19 @@ pspace public-ip list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip release +## pspace public-ip release Release a public IP from a team. This will unassign it from its assigned machine, if any. -## Usage +### Usage ``` public-ip release [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3017,9 +3017,9 @@ Release a public IP from a team. This will unassign it from its assigned machine | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret +## pspace secret Manage your Paperspace secrets. Secrets are used to store sensitive information such as API keys, passwords, and other credentials. Secrets @@ -3033,14 +3033,14 @@ Secrets can be created at the following levels: For more information, see https://docs.paperspace.com/secrets. -## Usage +### Usage ``` secret [command] secret [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3049,7 +3049,7 @@ For more information, see https://docs.paperspace.com/secrets. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -3057,17 +3057,17 @@ For more information, see https://docs.paperspace.com/secrets. - [help](#help) - [list](#list) - [update](#update) -# pspace secret create +## pspace secret create Create a secret in a project or team. -## Usage +### Usage ``` secret create [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3084,19 +3084,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret delete +## pspace secret delete Delete a secret from a project or team. -## Usage +### Usage ``` secret delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3113,19 +3113,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret get +## pspace secret get Get a secret from a project or team. -## Usage +### Usage ``` secret get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3143,20 +3143,20 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret help +## pspace secret help Show help for a secret command -## Usage +### Usage ``` secret help [command] secret help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3165,10 +3165,10 @@ Show help for a secret command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace secret help commands +## pspace secret help commands List secret commands @@ -3177,13 +3177,13 @@ Example: $ secret help commands commands ``` -## Usage +### Usage ``` secret help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3193,9 +3193,9 @@ $ secret help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace secret list +## pspace secret list List secrets in your team or project. @@ -3204,13 +3204,13 @@ Pick a subset of fields to display: pspace secret list -F name -F dtModified ``` -## Usage +### Usage ``` secret list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3233,19 +3233,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret update +## pspace secret update Update a secret in a project or team. -## Usage +### Usage ``` secret update [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3262,9 +3262,9 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive +## pspace shared-drive Manage your shared drives. Shared drives are used to centralize data used by your team. Shared drives can be mounted on any Paperspace machine @@ -3272,14 +3272,14 @@ in the same private network. For more information, see https://docs.paperspace.com/storage/shared-drives. -## Usage +### Usage ``` shared-drive [command] shared-drive [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3288,24 +3288,24 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace shared-drive create +## pspace shared-drive create Create a shared drive. -## Usage +### Usage ``` shared-drive create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3319,19 +3319,19 @@ Create a shared drive. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive delete +## pspace shared-drive delete Delete a shared drive from a team. -## Usage +### Usage ``` shared-drive delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3341,19 +3341,19 @@ Delete a shared drive from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive get +## pspace shared-drive get Get a shared drive from a team. -## Usage +### Usage ``` shared-drive get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3363,20 +3363,20 @@ Get a shared drive from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive help +## pspace shared-drive help Show help for a shared-drive command -## Usage +### Usage ``` shared-drive help [command] shared-drive help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3385,10 +3385,10 @@ Show help for a shared-drive command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace shared-drive help commands +## pspace shared-drive help commands List shared-drive commands @@ -3397,13 +3397,13 @@ Example: $ shared-drive help commands commands ``` -## Usage +### Usage ``` shared-drive help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3413,9 +3413,9 @@ $ shared-drive help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace shared-drive list +## pspace shared-drive list List shared drives in your team or project. @@ -3424,13 +3424,13 @@ Pick a subset of fields to display: pspace shared-drive list -F name -F dtModified ``` -## Usage +### Usage ``` shared-drive list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3447,19 +3447,19 @@ pspace shared-drive list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace signup +## pspace signup This command opens the Paperspace signup page in your browser. -## Usage +### Usage ``` signup [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3468,9 +3468,9 @@ This command opens the Paperspace signup page in your browser. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot +## pspace snapshot Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. They can be used to restore the machine to its previous state. Using snapshots is recommended @@ -3478,14 +3478,14 @@ before taking any action that could affect the usability of the machine or its n For more information, see https://docs.paperspace.com/storage/snapshots. -## Usage +### Usage ``` snapshot [command] snapshot [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3494,24 +3494,24 @@ For more information, see https://docs.paperspace.com/storage/snapshots. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [help](#help) - [list](#list) - [restore](#restore) -# pspace snapshot create +## pspace snapshot create Create a snapshot from a machine. -## Usage +### Usage ``` snapshot create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3523,19 +3523,19 @@ Create a snapshot from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot delete +## pspace snapshot delete Delete a snapshot from a team. -## Usage +### Usage ``` snapshot delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3545,20 +3545,20 @@ Delete a snapshot from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot help +## pspace snapshot help Show help for a snapshot command -## Usage +### Usage ``` snapshot help [command] snapshot help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3567,10 +3567,10 @@ Show help for a snapshot command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace snapshot help commands +## pspace snapshot help commands List snapshot commands @@ -3579,13 +3579,13 @@ Example: $ snapshot help commands commands ``` -## Usage +### Usage ``` snapshot help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3595,9 +3595,9 @@ $ snapshot help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace snapshot list +## pspace snapshot list List snapshots in your team. @@ -3606,13 +3606,13 @@ Pick a subset of fields to display: pspace snapshot list -F name -F dtModified ``` -## Usage +### Usage ``` snapshot list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3629,19 +3629,19 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot restore +## pspace snapshot restore Restore a machine to a snapshot. -## Usage +### Usage ``` snapshot restore [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3652,21 +3652,21 @@ Restore a machine to a snapshot. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script +## pspace startup-script Manage your startup scripts. Startup scripts allow you to configure a machine on first boot or on every boot. -## Usage +### Usage ``` startup-script [command] startup-script [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3675,7 +3675,7 @@ on first boot or on every boot. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [assign](#assign) - [create](#create) @@ -3685,17 +3685,17 @@ on first boot or on every boot. - [list](#list) - [unassign](#unassign) - [update](#update) -# pspace startup-script assign +## pspace startup-script assign Assign a startup script to a machine. -## Usage +### Usage ``` startup-script assign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3706,19 +3706,19 @@ Assign a startup script to a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script create +## pspace startup-script create Create a startup script. -## Usage +### Usage ``` startup-script create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3731,19 +3731,19 @@ Create a startup script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script delete +## pspace startup-script delete Delete a startup script from a team. -## Usage +### Usage ``` startup-script delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3753,19 +3753,19 @@ Delete a startup script from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script get +## pspace startup-script get Get a startup script from a team. -## Usage +### Usage ``` startup-script get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3775,20 +3775,20 @@ Get a startup script from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script help +## pspace startup-script help Show help for a startup-script command -## Usage +### Usage ``` startup-script help [command] startup-script help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3797,10 +3797,10 @@ Show help for a startup-script command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace startup-script help commands +## pspace startup-script help commands List startup-script commands @@ -3809,13 +3809,13 @@ Example: $ startup-script help commands commands ``` -## Usage +### Usage ``` startup-script help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3825,9 +3825,9 @@ $ startup-script help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace startup-script list +## pspace startup-script list List startup scripts in your team. @@ -3836,13 +3836,13 @@ Pick a subset of fields to display: pspace startup-script list -F name -F dtCreated ``` -## Usage +### Usage ``` startup-script list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3858,19 +3858,19 @@ pspace startup-script list -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script unassign +## pspace startup-script unassign Unassign a startup script from a machine. -## Usage +### Usage ``` startup-script unassign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3881,19 +3881,19 @@ Unassign a startup script from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script update +## pspace startup-script update Update a startup script. -## Usage +### Usage ``` startup-script update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3907,22 +3907,22 @@ Update a startup script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider +## pspace storage-provider Manage your storage providers. For more information, see https://docs.paperspace.com/storage/storageProviders. -## Usage +### Usage ``` storage-provider [command] storage-provider [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3931,7 +3931,7 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -3939,18 +3939,18 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. - [help](#help) - [list](#list) - [update](#update) -# pspace storage-provider create +## pspace storage-provider create Create a storage provider. -## Usage +### Usage ``` storage-provider create [command] storage-provider create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3959,22 +3959,22 @@ Create a storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [s3](#s3) -# pspace storage-provider create help +## pspace storage-provider create help Show help for a create command -## Usage +### Usage ``` storage-provider create help [command] storage-provider create help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -3983,10 +3983,10 @@ Show help for a create command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider create help commands +## pspace storage-provider create help commands List create commands @@ -3995,13 +3995,13 @@ Example: $ storage-provider create help commands commands ``` -## Usage +### Usage ``` storage-provider create help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4011,19 +4011,19 @@ $ storage-provider create help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider create s3 +## pspace storage-provider create s3 Create an S3 storage provider. -## Usage +### Usage ``` storage-provider create s3 [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4042,19 +4042,19 @@ Create an S3 storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider delete +## pspace storage-provider delete Delete a storage provider from a team. -## Usage +### Usage ``` storage-provider delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4064,19 +4064,19 @@ Delete a storage provider from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider get +## pspace storage-provider get Get a storage provider from a team. -## Usage +### Usage ``` storage-provider get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4086,20 +4086,20 @@ Get a storage provider from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider help +## pspace storage-provider help Show help for a storage-provider command -## Usage +### Usage ``` storage-provider help [command] storage-provider help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4108,10 +4108,10 @@ Show help for a storage-provider command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider help commands +## pspace storage-provider help commands List storage-provider commands @@ -4120,13 +4120,13 @@ Example: $ storage-provider help commands commands ``` -## Usage +### Usage ``` storage-provider help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4136,9 +4136,9 @@ $ storage-provider help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider list +## pspace storage-provider list List storage providers in your team or project. @@ -4147,13 +4147,13 @@ Pick a subset of fields to display: pspace storage provider list -F name -F dtModified ``` -## Usage +### Usage ``` storage-provider list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4168,20 +4168,20 @@ pspace storage provider list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider update +## pspace storage-provider update Update a storage provider. -## Usage +### Usage ``` storage-provider update [command] storage-provider update [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4190,22 +4190,22 @@ Update a storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [s3](#s3) -# pspace storage-provider update help +## pspace storage-provider update help Show help for a update command -## Usage +### Usage ``` storage-provider update help [command] storage-provider update help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4214,10 +4214,10 @@ Show help for a update command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider update help commands +## pspace storage-provider update help commands List update commands @@ -4226,13 +4226,13 @@ Example: $ storage-provider update help commands commands ``` -## Usage +### Usage ``` storage-provider update help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4242,19 +4242,19 @@ $ storage-provider update help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider update s3 +## pspace storage-provider update s3 Update an S3 storage provider in a project or team. -## Usage +### Usage ``` storage-provider update s3 [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4273,9 +4273,9 @@ Update an S3 storage provider in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace up +## pspace up This will upsert an app config and deploy your app to Paperspace. You can optionally specify a path to a config file. If no config file is specified, the default @@ -4296,13 +4296,13 @@ Deploy an app in a different directory. $ pspace up --cwd ../my-app ``` -## Usage +### Usage ``` up [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4327,9 +4327,9 @@ The default config file paths are in order of precedence: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace upgrade +## pspace upgrade This command upgrades pspace to the latest version. @@ -4346,13 +4346,13 @@ running: pspace upgrade ``` -## Usage +### Usage ``` upgrade [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4361,19 +4361,19 @@ pspace upgrade | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace version +## pspace version Shows version information command, including version number and build date. -## Usage +### Usage ``` version [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -4382,5 +4382,5 @@ Shows version information command, including version number and build date. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md index bd16bc5..7590bae 100644 --- a/.assets/pspace/public-ip.md +++ b/.assets/pspace/public-ip.md @@ -1,17 +1,17 @@ -# pspace public-ip +## pspace public-ip Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. For more information, see https://docs.paperspace.com/networking/public-ips. -## Usage +### Usage ``` public-ip [command] public-ip [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,24 +20,24 @@ For more information, see https://docs.paperspace.com/networking/public-ips. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [assign](#assign) - [claim](#claim) - [help](#help) - [list](#list) - [release](#release) -# pspace public-ip assign +## pspace public-ip assign Assign a public IP to a machine. -## Usage +### Usage ``` public-ip assign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -48,19 +48,19 @@ Assign a public IP to a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip claim +## pspace public-ip claim Claim a public IP for a team. -## Usage +### Usage ``` public-ip claim [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -71,20 +71,20 @@ Claim a public IP for a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip help +## pspace public-ip help Show help for a public-ip command -## Usage +### Usage ``` public-ip help [command] public-ip help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -93,10 +93,10 @@ Show help for a public-ip command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace public-ip help commands +## pspace public-ip help commands List public-ip commands @@ -105,13 +105,13 @@ Example: $ public-ip help commands commands ``` -## Usage +### Usage ``` public-ip help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -121,9 +121,9 @@ $ public-ip help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace public-ip list +## pspace public-ip list List public IPs in your team or project. @@ -132,13 +132,13 @@ Pick a subset of fields to display: pspace public-ip list -F name -F dtModified ``` -## Usage +### Usage ``` public-ip list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -154,19 +154,19 @@ pspace public-ip list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace public-ip release +## pspace public-ip release Release a public IP from a team. This will unassign it from its assigned machine, if any. -## Usage +### Usage ``` public-ip release [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -176,5 +176,5 @@ Release a public IP from a team. This will unassign it from its assigned machine | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md index a5a9cce..c8a0039 100644 --- a/.assets/pspace/secret.md +++ b/.assets/pspace/secret.md @@ -1,4 +1,4 @@ -# pspace secret +## pspace secret Manage your Paperspace secrets. Secrets are used to store sensitive information such as API keys, passwords, and other credentials. Secrets @@ -12,14 +12,14 @@ Secrets can be created at the following levels: For more information, see https://docs.paperspace.com/secrets. -## Usage +### Usage ``` secret [command] secret [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -28,7 +28,7 @@ For more information, see https://docs.paperspace.com/secrets. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -36,17 +36,17 @@ For more information, see https://docs.paperspace.com/secrets. - [help](#help) - [list](#list) - [update](#update) -# pspace secret create +## pspace secret create Create a secret in a project or team. -## Usage +### Usage ``` secret create [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -63,19 +63,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret delete +## pspace secret delete Delete a secret from a project or team. -## Usage +### Usage ``` secret delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -92,19 +92,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret get +## pspace secret get Get a secret from a project or team. -## Usage +### Usage ``` secret get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -122,20 +122,20 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret help +## pspace secret help Show help for a secret command -## Usage +### Usage ``` secret help [command] secret help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -144,10 +144,10 @@ Show help for a secret command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace secret help commands +## pspace secret help commands List secret commands @@ -156,13 +156,13 @@ Example: $ secret help commands commands ``` -## Usage +### Usage ``` secret help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -172,9 +172,9 @@ $ secret help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace secret list +## pspace secret list List secrets in your team or project. @@ -183,13 +183,13 @@ Pick a subset of fields to display: pspace secret list -F name -F dtModified ``` -## Usage +### Usage ``` secret list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -212,19 +212,19 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace secret update +## pspace secret update Update a secret in a project or team. -## Usage +### Usage ``` secret update [arguments] [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -241,5 +241,5 @@ a project. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md index c8b152c..9dab486 100644 --- a/.assets/pspace/shared-drive.md +++ b/.assets/pspace/shared-drive.md @@ -1,4 +1,4 @@ -# pspace shared-drive +## pspace shared-drive Manage your shared drives. Shared drives are used to centralize data used by your team. Shared drives can be mounted on any Paperspace machine @@ -6,14 +6,14 @@ in the same private network. For more information, see https://docs.paperspace.com/storage/shared-drives. -## Usage +### Usage ``` shared-drive [command] shared-drive [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,24 +22,24 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [get](#get) - [help](#help) - [list](#list) -# pspace shared-drive create +## pspace shared-drive create Create a shared drive. -## Usage +### Usage ``` shared-drive create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -53,19 +53,19 @@ Create a shared drive. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive delete +## pspace shared-drive delete Delete a shared drive from a team. -## Usage +### Usage ``` shared-drive delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -75,19 +75,19 @@ Delete a shared drive from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive get +## pspace shared-drive get Get a shared drive from a team. -## Usage +### Usage ``` shared-drive get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -97,20 +97,20 @@ Get a shared drive from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace shared-drive help +## pspace shared-drive help Show help for a shared-drive command -## Usage +### Usage ``` shared-drive help [command] shared-drive help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -119,10 +119,10 @@ Show help for a shared-drive command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace shared-drive help commands +## pspace shared-drive help commands List shared-drive commands @@ -131,13 +131,13 @@ Example: $ shared-drive help commands commands ``` -## Usage +### Usage ``` shared-drive help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -147,9 +147,9 @@ $ shared-drive help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace shared-drive list +## pspace shared-drive list List shared drives in your team or project. @@ -158,13 +158,13 @@ Pick a subset of fields to display: pspace shared-drive list -F name -F dtModified ``` -## Usage +### Usage ``` shared-drive list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -181,5 +181,5 @@ pspace shared-drive list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md index e664380..5cf0144 100644 --- a/.assets/pspace/signup.md +++ b/.assets/pspace/signup.md @@ -1,14 +1,14 @@ -# pspace signup +## pspace signup This command opens the Paperspace signup page in your browser. -## Usage +### Usage ``` signup [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -17,5 +17,5 @@ This command opens the Paperspace signup page in your browser. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md index 4642eee..89cc951 100644 --- a/.assets/pspace/snapshot.md +++ b/.assets/pspace/snapshot.md @@ -1,4 +1,4 @@ -# pspace snapshot +## pspace snapshot Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. They can be used to restore the machine to its previous state. Using snapshots is recommended @@ -6,14 +6,14 @@ before taking any action that could affect the usability of the machine or its n For more information, see https://docs.paperspace.com/storage/snapshots. -## Usage +### Usage ``` snapshot [command] snapshot [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -22,24 +22,24 @@ For more information, see https://docs.paperspace.com/storage/snapshots. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) - [help](#help) - [list](#list) - [restore](#restore) -# pspace snapshot create +## pspace snapshot create Create a snapshot from a machine. -## Usage +### Usage ``` snapshot create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -51,19 +51,19 @@ Create a snapshot from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot delete +## pspace snapshot delete Delete a snapshot from a team. -## Usage +### Usage ``` snapshot delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -73,20 +73,20 @@ Delete a snapshot from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot help +## pspace snapshot help Show help for a snapshot command -## Usage +### Usage ``` snapshot help [command] snapshot help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -95,10 +95,10 @@ Show help for a snapshot command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace snapshot help commands +## pspace snapshot help commands List snapshot commands @@ -107,13 +107,13 @@ Example: $ snapshot help commands commands ``` -## Usage +### Usage ``` snapshot help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -123,9 +123,9 @@ $ snapshot help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace snapshot list +## pspace snapshot list List snapshots in your team. @@ -134,13 +134,13 @@ Pick a subset of fields to display: pspace snapshot list -F name -F dtModified ``` -## Usage +### Usage ``` snapshot list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -157,19 +157,19 @@ will be returned. | false | | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace snapshot restore +## pspace snapshot restore Restore a machine to a snapshot. -## Usage +### Usage ``` snapshot restore [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -180,5 +180,5 @@ Restore a machine to a snapshot. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md index 34a38aa..4ff5148 100644 --- a/.assets/pspace/startup-script.md +++ b/.assets/pspace/startup-script.md @@ -1,16 +1,16 @@ -# pspace startup-script +## pspace startup-script Manage your startup scripts. Startup scripts allow you to configure a machine on first boot or on every boot. -## Usage +### Usage ``` startup-script [command] startup-script [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -19,7 +19,7 @@ on first boot or on every boot. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [assign](#assign) - [create](#create) @@ -29,17 +29,17 @@ on first boot or on every boot. - [list](#list) - [unassign](#unassign) - [update](#update) -# pspace startup-script assign +## pspace startup-script assign Assign a startup script to a machine. -## Usage +### Usage ``` startup-script assign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -50,19 +50,19 @@ Assign a startup script to a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script create +## pspace startup-script create Create a startup script. -## Usage +### Usage ``` startup-script create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -75,19 +75,19 @@ Create a startup script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script delete +## pspace startup-script delete Delete a startup script from a team. -## Usage +### Usage ``` startup-script delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -97,19 +97,19 @@ Delete a startup script from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script get +## pspace startup-script get Get a startup script from a team. -## Usage +### Usage ``` startup-script get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -119,20 +119,20 @@ Get a startup script from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script help +## pspace startup-script help Show help for a startup-script command -## Usage +### Usage ``` startup-script help [command] startup-script help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -141,10 +141,10 @@ Show help for a startup-script command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace startup-script help commands +## pspace startup-script help commands List startup-script commands @@ -153,13 +153,13 @@ Example: $ startup-script help commands commands ``` -## Usage +### Usage ``` startup-script help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -169,9 +169,9 @@ $ startup-script help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace startup-script list +## pspace startup-script list List startup scripts in your team. @@ -180,13 +180,13 @@ Pick a subset of fields to display: pspace startup-script list -F name -F dtCreated ``` -## Usage +### Usage ``` startup-script list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -202,19 +202,19 @@ pspace startup-script list -F name -F dtCreated | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script unassign +## pspace startup-script unassign Unassign a startup script from a machine. -## Usage +### Usage ``` startup-script unassign [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -225,19 +225,19 @@ Unassign a startup script from a machine. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace startup-script update +## pspace startup-script update Update a startup script. -## Usage +### Usage ``` startup-script update [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -251,5 +251,5 @@ Update a startup script. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md index 7809ca3..185ea29 100644 --- a/.assets/pspace/storage-provider.md +++ b/.assets/pspace/storage-provider.md @@ -1,17 +1,17 @@ -# pspace storage-provider +## pspace storage-provider Manage your storage providers. For more information, see https://docs.paperspace.com/storage/storageProviders. -## Usage +### Usage ``` storage-provider [command] storage-provider [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -20,7 +20,7 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [create](#create) - [delete](#delete) @@ -28,18 +28,18 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. - [help](#help) - [list](#list) - [update](#update) -# pspace storage-provider create +## pspace storage-provider create Create a storage provider. -## Usage +### Usage ``` storage-provider create [command] storage-provider create [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -48,22 +48,22 @@ Create a storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [s3](#s3) -# pspace storage-provider create help +## pspace storage-provider create help Show help for a create command -## Usage +### Usage ``` storage-provider create help [command] storage-provider create help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -72,10 +72,10 @@ Show help for a create command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider create help commands +## pspace storage-provider create help commands List create commands @@ -84,13 +84,13 @@ Example: $ storage-provider create help commands commands ``` -## Usage +### Usage ``` storage-provider create help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -100,19 +100,19 @@ $ storage-provider create help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider create s3 +## pspace storage-provider create s3 Create an S3 storage provider. -## Usage +### Usage ``` storage-provider create s3 [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -131,19 +131,19 @@ Create an S3 storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider delete +## pspace storage-provider delete Delete a storage provider from a team. -## Usage +### Usage ``` storage-provider delete [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -153,19 +153,19 @@ Delete a storage provider from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider get +## pspace storage-provider get Get a storage provider from a team. -## Usage +### Usage ``` storage-provider get [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -175,20 +175,20 @@ Get a storage provider from a team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider help +## pspace storage-provider help Show help for a storage-provider command -## Usage +### Usage ``` storage-provider help [command] storage-provider help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -197,10 +197,10 @@ Show help for a storage-provider command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider help commands +## pspace storage-provider help commands List storage-provider commands @@ -209,13 +209,13 @@ Example: $ storage-provider help commands commands ``` -## Usage +### Usage ``` storage-provider help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -225,9 +225,9 @@ $ storage-provider help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider list +## pspace storage-provider list List storage providers in your team or project. @@ -236,13 +236,13 @@ Pick a subset of fields to display: pspace storage provider list -F name -F dtModified ``` -## Usage +### Usage ``` storage-provider list [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -257,20 +257,20 @@ pspace storage provider list -F name -F dtModified | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands -# pspace storage-provider update +## pspace storage-provider update Update a storage provider. -## Usage +### Usage ``` storage-provider update [command] storage-provider update [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -279,22 +279,22 @@ Update a storage provider. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [help](#help) - [s3](#s3) -# pspace storage-provider update help +## pspace storage-provider update help Show help for a update command -## Usage +### Usage ``` storage-provider update help [command] storage-provider update help [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -303,10 +303,10 @@ Show help for a update command | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands - [commands](#commands) -# pspace storage-provider update help commands +## pspace storage-provider update help commands List update commands @@ -315,13 +315,13 @@ Example: $ storage-provider update help commands commands ``` -## Usage +### Usage ``` storage-provider update help commands [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -331,19 +331,19 @@ $ storage-provider update help commands commands | help | h | Show help for a command | false | | all | a | Show all commands, including hidden ones | false | -### Subcommands +#### Subcommands -# pspace storage-provider update s3 +## pspace storage-provider update s3 Update an S3 storage provider in a project or team. -## Usage +### Usage ``` storage-provider update s3 [arguments] [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -362,5 +362,5 @@ Update an S3 storage provider in a project or team. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md index 1316caa..b1f6e5d 100644 --- a/.assets/pspace/up.md +++ b/.assets/pspace/up.md @@ -1,4 +1,4 @@ -# pspace up +## pspace up This will upsert an app config and deploy your app to Paperspace. You can optionally specify a path to a config file. If no config file is specified, the default @@ -19,13 +19,13 @@ Deploy an app in a different directory. $ pspace up --cwd ../my-app ``` -## Usage +### Usage ``` up [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -50,5 +50,5 @@ The default config file paths are in order of precedence: | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md index 96d9f8f..c5d2a5d 100644 --- a/.assets/pspace/upgrade.md +++ b/.assets/pspace/upgrade.md @@ -1,4 +1,4 @@ -# pspace upgrade +## pspace upgrade This command upgrades pspace to the latest version. @@ -15,13 +15,13 @@ running: pspace upgrade ``` -## Usage +### Usage ``` upgrade [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -30,5 +30,5 @@ pspace upgrade | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md index 5a49e4c..b32401d 100644 --- a/.assets/pspace/version.md +++ b/.assets/pspace/version.md @@ -1,14 +1,14 @@ -# pspace version +## pspace version Shows version information command, including version number and build date. -## Usage +### Usage ``` version [flags] ``` -## Flags +### Flags | Name | Aliases | Description | Required | | --- | --- | --- | --- | @@ -17,5 +17,5 @@ Shows version information command, including version number and build date. | api-key | | A Paperspace public API Key used for authenticating requests | false | | help | h | Show help for a command | false | -### Subcommands +#### Subcommands diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index 6e09d8d..df07d55 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -15,13 +15,13 @@ let markdown = ""; // Also generate markdown for the CLI async function renderCommand(path: string[], command: ZcliJsonCommand) { - markdown += `# ${path.join(" ")}\n\n`; + markdown += `## ${path.join(" ")}\n\n`; markdown += command.description + "\n\n"; - markdown += "## Usage\n\n"; + markdown += "### Usage\n\n"; markdown += `\`\`\`\n`; markdown += `${command.usage}\n`; markdown += "\`\`\`\n\n"; - markdown += "## Flags\n\n"; + markdown += "### Flags\n\n"; markdown += "| Name | Aliases | Description | Required |\n"; markdown += "| --- | --- | --- | --- |\n"; for (const flag of command.flags) { @@ -31,7 +31,7 @@ async function renderCommand(path: string[], command: ZcliJsonCommand) { } markdown += "\n"; - markdown += "### Subcommands\n\n"; + markdown += "#### Subcommands\n\n"; for (const subcommand of command.commands) { markdown += `- [${subcommand.name}](#${subcommand.name})\n`; } From 8c607b243d0142392bb2a1cbb722c748934dd72c Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 23 May 2024 15:43:21 -0400 Subject: [PATCH 07/10] fmt --- .assets/pspace.json | 2 +- .assets/pspace/autoscaling-group.md | 191 +-- .assets/pspace/completion.md | 118 +- .assets/pspace/config.md | 106 +- .assets/pspace/console.md | 15 +- .assets/pspace/custom-template.md | 143 +- .assets/pspace/dataset.md | 311 ++--- .assets/pspace/deployment.md | 145 +- .assets/pspace/docs.md | 23 +- .assets/pspace/help.md | 35 +- .assets/pspace/init.md | 32 +- .assets/pspace/login.md | 15 +- .assets/pspace/logout.md | 17 +- .assets/pspace/machine-event.md | 106 +- .assets/pspace/machine.md | 271 ++-- .assets/pspace/model.md | 141 +- .assets/pspace/os-template.md | 85 +- .assets/pspace/private-network.md | 138 +- .assets/pspace/project.md | 179 +-- .assets/pspace/pspace.md | 1886 ++++++++++++++------------- .assets/pspace/public-ip.md | 139 +- .assets/pspace/secret.md | 225 ++-- .assets/pspace/shared-drive.md | 145 +- .assets/pspace/signup.md | 15 +- .assets/pspace/snapshot.md | 144 +- .assets/pspace/startup-script.md | 199 +-- .assets/pspace/storage-provider.md | 281 ++-- .assets/pspace/up.md | 31 +- .assets/pspace/upgrade.md | 26 +- .assets/pspace/version.md | 15 +- 30 files changed, 2662 insertions(+), 2517 deletions(-) diff --git a/.assets/pspace.json b/.assets/pspace.json index 71aee2a..daad69f 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -19207,4 +19207,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md index e0a7ece..1d8c744 100644 --- a/.assets/pspace/autoscaling-group.md +++ b/.assets/pspace/autoscaling-group.md @@ -1,24 +1,24 @@ ## pspace autoscaling-group -Manage your autoscaling groups. Autoscaling groups enable using -the Kubernetes cluster-autoscaler to automatically scale your cluster. -You can also autoscaling groups as a primitive for your own autoscaler. +Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes +cluster-autoscaler to automatically scale your cluster. You can also autoscaling +groups as a primitive for your own autoscaler. ### Usage ``` - autoscaling-group [command] - autoscaling-group [flags] +autoscaling-group [command] +autoscaling-group [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -28,6 +28,7 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) + ## pspace autoscaling-group create Create an autoscaling group. @@ -35,27 +36,27 @@ Create an autoscaling group. ### Usage ``` - autoscaling-group create [flags] +autoscaling-group create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -66,18 +67,18 @@ Delete an autoscaling group from a team. ### Usage ``` - autoscaling-group delete [arguments] [flags] +autoscaling-group delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -88,18 +89,18 @@ Get an autoscaling group from a team. ### Usage ``` - autoscaling-group get [arguments] [flags] +autoscaling-group get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -110,27 +111,29 @@ Show help for a autoscaling-group command ### Usage ``` - autoscaling-group help [command] - autoscaling-group help [arguments] [flags] +autoscaling-group help [command] +autoscaling-group help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace autoscaling-group help commands List autoscaling-group commands Example: + ``` $ autoscaling-group help commands commands ``` @@ -138,18 +141,18 @@ $ autoscaling-group help commands commands ### Usage ``` - autoscaling-group help commands [flags] +autoscaling-group help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -158,6 +161,7 @@ $ autoscaling-group help commands commands List autoscaling groups in your team. Pick a subset of fields to display: + ``` pspace autoscaling-group list -F name -F dtCreated ``` @@ -165,25 +169,25 @@ pspace autoscaling-group list -F name -F dtCreated ### Usage ``` - autoscaling-group list [flags] +autoscaling-group list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -194,28 +198,27 @@ Update an autoscaling group. ### Usage ``` - autoscaling-group update [arguments] [flags] +autoscaling-group update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md index f2655ec..219c5ab 100644 --- a/.assets/pspace/completion.md +++ b/.assets/pspace/completion.md @@ -1,23 +1,23 @@ ## pspace completion -Generate an autocompletion script for pspace in the specified shell. -See each sub-command's help for details on how to use the generated script. +Generate an autocompletion script for pspace in the specified shell. See each +sub-command's help for details on how to use the generated script. ### Usage ``` - completion [command] - completion [flags] +completion [command] +completion [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -25,14 +25,16 @@ See each sub-command's help for details on how to use the generated script. - [fish](#fish) - [help](#help) - [zsh](#zsh) + ## pspace completion bash Generate the autocompletion script for the bash shell. -This script depends on the `bash-completion` package. -If it is not installed already, you can install it via your OS's package manager. +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. To load completions in your current shell session: + ``` $ source <(completion bash bash) ``` @@ -40,11 +42,13 @@ $ source <(completion bash bash) To load completions for every new session, execute once: Linux: + ``` $ completion bash bash > /etc/bash_completion.d/pspace ``` macOS: + ``` $ completion bash bash > /usr/local/etc/bash_completion.d/pspace ``` @@ -54,17 +58,17 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion bash [flags] +completion bash [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -73,11 +77,13 @@ You will need to start a new shell for this setup to take effect. Generate the autocompletion script for the fish shell. To load completions in your current shell session: + ``` $ completion fish fish | source ``` To load completions for every new session, execute once: + ``` $ completion fish fish > ~/.config/fish/completions/pspace.fish ``` @@ -87,18 +93,18 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion fish [flags] +completion fish [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -109,27 +115,29 @@ Show help for a completion command ### Usage ``` - completion help [command] - completion help [arguments] [flags] +completion help [command] +completion help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace completion help commands List completion commands Example: + ``` $ completion help commands commands ``` @@ -137,18 +145,18 @@ $ completion help commands commands ### Usage ``` - completion help commands [flags] +completion help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -156,8 +164,8 @@ $ completion help commands commands Generate the autocompletion script for the zsh shell. -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: ``` $ echo "autoload -U compinit; compinit" >> ~/.zshrc @@ -166,16 +174,19 @@ $ echo "autoload -U compinit; compinit" >> ~/.zshrc To load completions for every new session, execute once: Linux: + ``` $ completion zsh zsh > "${fpath[1]}/_pspace" ``` macOS: + ``` $ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace ``` Oh My Zsh: + ``` $ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace ``` @@ -185,18 +196,17 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion zsh [flags] +completion zsh [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md index 49c8f6d..fd1d6d8 100644 --- a/.assets/pspace/config.md +++ b/.assets/pspace/config.md @@ -1,12 +1,13 @@ ## pspace config -This command manages your Paperspace configuration. You can use it to set, get, and -delete configuration values. Running this command without any subcommands will print -your current configuration. +This command manages your Paperspace configuration. You can use it to set, get, +and delete configuration values. Running this command without any subcommands +will print your current configuration. -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: -For example, to set the current team, run: ``` pspace config set team "my-team" ``` @@ -14,18 +15,18 @@ pspace config set team "my-team" ### Usage ``` - config [command] - config [flags] +config [command] +config [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -33,6 +34,7 @@ pspace config set team "my-team" - [get](#get) - [help](#help) - [set](#set) + ## pspace config delete Delete a configuration value. @@ -40,17 +42,17 @@ Delete a configuration value. ### Usage ``` - config delete [flags] +config delete [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -60,6 +62,7 @@ This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values. For example, to get the current team run: + ``` pspace config get team ``` @@ -67,17 +70,17 @@ pspace config get team ### Usage ``` - config get [arguments] [flags] +config get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -88,27 +91,29 @@ Show help for a config command ### Usage ``` - config help [command] - config help [arguments] [flags] +config help [command] +config help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace config help commands List config commands Example: + ``` $ config help commands commands ``` @@ -116,18 +121,18 @@ $ config help commands commands ### Usage ``` - config help commands [flags] +config help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -138,17 +143,16 @@ Set a configuration value. ### Usage ``` - config set [arguments] [arguments...] [flags] +config set [arguments] [arguments...] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md index ff754d6..13de327 100644 --- a/.assets/pspace/console.md +++ b/.assets/pspace/console.md @@ -5,17 +5,16 @@ This command opens the Paperspace web console in your browser. ### Usage ``` - console [flags] +console [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md index 86f00c4..07bf1d3 100644 --- a/.assets/pspace/custom-template.md +++ b/.assets/pspace/custom-template.md @@ -1,26 +1,26 @@ ## pspace custom-template -Manage your custom templates. Custom templates are a backup of your -machine's disk. They can be used to create additional machines. You -can use them to prepopulate a machine with your desired software stack. +Manage your custom templates. Custom templates are a backup of your machine's +disk. They can be used to create additional machines. You can use them to +prepopulate a machine with your desired software stack. For more information, see https://docs.paperspace.com/compute/custom-templates. ### Usage ``` - custom-template [command] - custom-template [flags] +custom-template [command] +custom-template [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +29,7 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. - [get](#get) - [help](#help) - [list](#list) + ## pspace custom-template create Create a custom template from a machine. @@ -36,20 +37,20 @@ Create a custom template from a machine. ### Usage ``` - custom-template create [flags] +custom-template create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -60,18 +61,18 @@ Delete a custom template from a team. ### Usage ``` - custom-template delete [arguments] [flags] +custom-template delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -82,18 +83,18 @@ Get a custom template from a team. ### Usage ``` - custom-template get [arguments] [flags] +custom-template get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -104,27 +105,29 @@ Show help for a custom-template command ### Usage ``` - custom-template help [command] - custom-template help [arguments] [flags] +custom-template help [command] +custom-template help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace custom-template help commands List custom-template commands Example: + ``` $ custom-template help commands commands ``` @@ -132,18 +135,18 @@ $ custom-template help commands commands ### Usage ``` - custom-template help commands [flags] +custom-template help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -152,6 +155,7 @@ $ custom-template help commands commands List custom templates in your team. Pick a subset of fields to display: + ``` pspace custom-template list -F name -F dtModified ``` @@ -159,26 +163,25 @@ pspace custom-template list -F name -F dtModified ### Usage ``` - custom-template list [flags] +custom-template list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md index bdeff57..a9cee69 100644 --- a/.assets/pspace/dataset.md +++ b/.assets/pspace/dataset.md @@ -7,18 +7,18 @@ For more information, see https://docs.paperspace.com/storage/datasets. ### Usage ``` - dataset [command] - dataset [flags] +dataset [command] +dataset [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +29,7 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) + ## pspace dataset create Create a dataset. @@ -36,22 +37,22 @@ Create a dataset. ### Usage ``` - dataset create [flags] +dataset create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -62,18 +63,18 @@ Delete a dataset from a team. ### Usage ``` - dataset delete [arguments] [flags] +dataset delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -84,18 +85,18 @@ Get a dataset from a team. ### Usage ``` - dataset get [arguments] [flags] +dataset get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -106,27 +107,29 @@ Show help for a dataset command ### Usage ``` - dataset help [command] - dataset help [arguments] [flags] +dataset help [command] +dataset help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace dataset help commands List dataset commands Example: + ``` $ dataset help commands commands ``` @@ -134,18 +137,18 @@ $ dataset help commands commands ### Usage ``` - dataset help commands [flags] +dataset help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -154,6 +157,7 @@ $ dataset help commands commands List datasets in your team or project. Pick a subset of fields to display: + ``` pspace dataset list -F name -F dtModified ``` @@ -161,23 +165,23 @@ pspace dataset list -F name -F dtModified ### Usage ``` - dataset list [flags] +dataset list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -188,20 +192,20 @@ Update a dataset in a project or team. ### Usage ``` - dataset update [arguments] [flags] +dataset update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -214,18 +218,18 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. ### Usage ``` - dataset versions [command] - dataset versions [flags] +dataset versions [command] +dataset versions [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -235,6 +239,7 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. - [help](#help) - [list](#list) - [update](#update) + ## pspace dataset versions create Create a dataset version. This command will prompt you for an ID if you don't @@ -243,65 +248,65 @@ provide one. ### Usage ``` - dataset versions create [arguments] [arguments] [flags] +dataset versions create [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace dataset versions delete -Delete a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Delete a dataset version from a team. This command will prompt you for an ID if +you don't provide one. ### Usage ``` - dataset versions delete [arguments] [arguments] [flags] +dataset versions delete [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace dataset versions get -Get a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Get a dataset version from a team. This command will prompt you for an ID if you +don't provide one. ### Usage ``` - dataset versions get [arguments] [arguments] [flags] +dataset versions get [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -312,27 +317,29 @@ Show help for a versions command ### Usage ``` - dataset versions help [command] - dataset versions help [arguments] [flags] +dataset versions help [command] +dataset versions help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace dataset versions help commands List versions commands Example: + ``` $ dataset versions help commands commands ``` @@ -340,18 +347,18 @@ $ dataset versions help commands commands ### Usage ``` - dataset versions help commands [flags] +dataset versions help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -360,6 +367,7 @@ $ dataset versions help commands commands List dataset versions in your team or project. Pick a subset of fields to display: + ``` pspace dataset versions list -F name -F dtModified ``` @@ -367,23 +375,23 @@ pspace dataset versions list -F name -F dtModified ### Usage ``` - dataset versions list [arguments] [flags] +dataset versions list [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -394,20 +402,19 @@ Update a dataset version in a project or team. ### Usage ``` - dataset versions update [arguments] [arguments] [flags] +dataset versions update [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md index 43fd736..acef561 100644 --- a/.assets/pspace/deployment.md +++ b/.assets/pspace/deployment.md @@ -5,18 +5,18 @@ Effortlessly deploy ML apps to Paperspace. ### Usage ``` - deployment [command] - deployment [flags] +deployment [command] +deployment [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -25,6 +25,7 @@ Effortlessly deploy ML apps to Paperspace. - [help](#help) - [list](#list) - [up](#up) + ## pspace deployment delete Delete a deployment by its ID. If you don't provide an ID, this command will @@ -37,30 +38,31 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ### Usage ``` - deployment delete [arguments] [flags] +deployment delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace deployment get -Get a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. +Get a deployment by its ID. If you don't provide an ID, this command will prompt +you for one based on the deployments you have access to. ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 ``` Pick a subset of fields to display: + ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ``` @@ -68,18 +70,18 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ### Usage ``` - deployment get [arguments] [flags] +deployment get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -90,27 +92,29 @@ Show help for a deployment command ### Usage ``` - deployment help [command] - deployment help [arguments] [flags] +deployment help [command] +deployment help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace deployment help commands List deployment commands Example: + ``` $ deployment help commands commands ``` @@ -118,18 +122,18 @@ $ deployment help commands commands ### Usage ``` - deployment help commands [flags] +deployment help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -138,6 +142,7 @@ $ deployment help commands commands List deployments in your team. Pick a subset of fields to display: + ``` pspace deployment list -F id -F name ``` @@ -145,48 +150,52 @@ pspace deployment list -F id -F name ### Usage ``` - deployment list [flags] +deployment list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace deployment up -This will create a new deployment for your app or update it if it already exists. -You can optionally specify a path to a config file. If no config file is specified, -the default config file paths will be tried. +This will create a new deployment for your app or update it if it already +exists. You can optionally specify a path to a config file. If no config file is +specified, the default config file paths will be tried. Create a new deployment for the app in the current directory. + ``` $ pspace deployment create ``` Create a new deployment using a config file. + ``` $ pspace deployment create -c paperspace.json ``` Create a new deployment for an app in a different directory. + ``` $ pspace deployment create --cwd ../my-app ``` Create a new deployment for an app in a specific project. + ``` $ pspace deployment create --project-id 1234 ``` @@ -194,14 +203,14 @@ $ pspace deployment create --project-id 1234 ### Usage ``` - deployment up [flags] +deployment up [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. +| Name | Aliases | Description | Required | +| ------ | ------- | ----------------------------------------------------------------------- | -------- | +| config | c | The path to the config file. Defaults to our default config file paths. | | The default config file paths are in order of precedence: @@ -214,13 +223,11 @@ The default config file paths are in order of precedence: - `.paperspace/app.yml` - `.paperspace/app.json` - `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to + deploy to. | false | | cwd | | The directory to deploy the app from. Defaults + to the current directory. | false | | log-level | l | Enable debug logging. | + false | | json | j | Output JSON | false | | api-key | | A Paperspace public + API Key used for authenticating requests | false | | help | h | Show help for + a command | false | #### Subcommands - diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md index 9fc6307..6dd0d89 100644 --- a/.assets/pspace/docs.md +++ b/.assets/pspace/docs.md @@ -1,26 +1,25 @@ ## pspace docs -This command opens the Paperspace documentation in your browser. -You can optionally pass an argument that will take you to a specific -docs page. +This command opens the Paperspace documentation in your browser. You can +optionally pass an argument that will take you to a specific docs page. Valid pages are: - - `d`, `deployment` + +- `d`, `deployment` ### Usage ``` - docs [arguments] [flags] +docs [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md index ab64c90..ffc8781 100644 --- a/.assets/pspace/help.md +++ b/.assets/pspace/help.md @@ -5,27 +5,29 @@ Show help for a pspace command ### Usage ``` - help [command] - help [arguments] [flags] +help [command] +help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace help commands List pspace commands Example: + ``` $ help commands commands ``` @@ -33,18 +35,17 @@ $ help commands commands ### Usage ``` - help commands [flags] +help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands - diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md index d2a2e36..339d380 100644 --- a/.assets/pspace/init.md +++ b/.assets/pspace/init.md @@ -1,22 +1,24 @@ ## pspace init -Create a new Paperspace app. This will create a new directory with a -default app structure. You can optionally specify a name for the app -and a template to use. If no template is specified, the default -template will be used. +Create a new Paperspace app. This will create a new directory with a default app +structure. You can optionally specify a name for the app and a template to use. +If no template is specified, the default template will be used. Create a new app in the current directory. + ``` $ pspace init ``` Create a new app named "my-app" relative to the current directory. + ``` $ pspace init my-app ``` -Create a new app named "my-app" relative to the current directory using -a template from the Paperspace GitHub organization. +Create a new app named "my-app" relative to the current directory using a +template from the Paperspace GitHub organization. + ``` $ pspace init my-app -t Paperspace/gradio-demo ``` @@ -24,17 +26,18 @@ $ pspace init my-app -t Paperspace/gradio-demo ### Usage ``` - init [arguments] [flags] +init [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| template | t | A template to use when creating the app. This can be a URL -to a git repository or a shorthand template name. +| Name | Aliases | Description | Required | +| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | +| template | t | A template to use when creating the app. This can be a URL | | +| to a git repository or a shorthand template name. | | | | These templates are equivalent: + ``` user/repo github:user/repo @@ -43,6 +46,7 @@ https://github.com/user/repo ``` Download from GitLab: + ``` gitlab:user/repo git@gitlab.com:user/repo @@ -50,6 +54,7 @@ https://gitlab.com/user/repo ``` Download from Bitbucket + ``` bitbucket:user/repo git@bitbucket.org:user/repo @@ -57,7 +62,8 @@ https://bitbucket.org/user/repo ``` Specify a tag or branch: -``` + +```` user/repo#dev # branch user/repo#v1.2.3 # release tag user/repo#1234abcd # commit hash @@ -74,4 +80,4 @@ SSH key configured with GitHub, Bitbucket, or GitLab. | false | | help | h | Show help for a command | false | #### Subcommands - +```` diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md index 91aa8fd..13a47a1 100644 --- a/.assets/pspace/login.md +++ b/.assets/pspace/login.md @@ -5,17 +5,16 @@ Log in to the CLI using your Paperspace API key or by opening the web console. ### Usage ``` - login [arguments] [flags] +login [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md index c2bb7b8..3503b5c 100644 --- a/.assets/pspace/logout.md +++ b/.assets/pspace/logout.md @@ -5,18 +5,17 @@ Log out of the CLI for the current team, a specific team, or all teams. ### Usage ``` - logout [arguments...] [flags] +logout [arguments...] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| all | a | Log out of all teams. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| all | a | Log out of all teams. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md index 8e7a553..e11e37b 100644 --- a/.assets/pspace/machine-event.md +++ b/.assets/pspace/machine-event.md @@ -1,32 +1,34 @@ ## pspace machine-event -Manage your machine events. Events are asynchronous tasks performed by our system on your machines. -Not all machine commands are asynchronous. For those that are, a machine event will be returned -which can be tracked using this command. +Manage your machine events. Events are asynchronous tasks performed by our +system on your machines. Not all machine commands are asynchronous. For those +that are, a machine event will be returned which can be tracked using this +command. For more information, see https://docs.paperspace.com/machines. ### Usage ``` - machine-event [command] - machine-event [flags] +machine-event [command] +machine-event [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [get](#get) - [help](#help) - [list](#list) + ## pspace machine-event get Get a machine event from a team. @@ -34,18 +36,18 @@ Get a machine event from a team. ### Usage ``` - machine-event get [arguments] [flags] +machine-event get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -56,27 +58,29 @@ Show help for a machine-event command ### Usage ``` - machine-event help [command] - machine-event help [arguments] [flags] +machine-event help [command] +machine-event help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace machine-event help commands List machine-event commands Example: + ``` $ machine-event help commands commands ``` @@ -84,18 +88,18 @@ $ machine-event help commands commands ### Usage ``` - machine-event help commands [flags] +machine-event help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -104,6 +108,7 @@ $ machine-event help commands commands List machine events in your team. Pick a subset of fields to display: + ``` pspace machine-event list -F name -F dtModified ``` @@ -111,25 +116,24 @@ pspace machine-event list -F name -F dtModified ### Usage ``` - machine-event list [flags] +machine-event list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md index ab3840a..7605892 100644 --- a/.assets/pspace/machine.md +++ b/.assets/pspace/machine.md @@ -2,23 +2,23 @@ Manage your Paperspace machines. -For more information, see https://docs.paperspace.com/machines. +For more information, see https://docs.paperspace.com/machines. ### Usage ``` - machine [command] - machine [flags] +machine [command] +machine [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -31,6 +31,7 @@ For more information, see https://docs.paperspace.com/machines. - [start](#start) - [stop](#stop) - [update](#update) + ## pspace machine create Create a machine. @@ -38,39 +39,39 @@ Create a machine. ### Usage ``` - machine create [flags] +machine create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------------ | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -81,18 +82,18 @@ Delete a machine from a team. ### Usage ``` - machine delete [arguments] [flags] +machine delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -103,18 +104,18 @@ Get a machine from a team. ### Usage ``` - machine get [arguments] [flags] +machine get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -125,27 +126,29 @@ Show help for a machine command ### Usage ``` - machine help [command] - machine help [arguments] [flags] +machine help [command] +machine help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace machine help commands List machine commands Example: + ``` $ machine help commands commands ``` @@ -153,18 +156,18 @@ $ machine help commands commands ### Usage ``` - machine help commands [flags] +machine help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -173,6 +176,7 @@ $ machine help commands commands List machines in your team. Pick a subset of fields to display: + ``` pspace machine list -F name -F dtModified ``` @@ -180,27 +184,27 @@ pspace machine list -F name -F dtModified ### Usage ``` - machine list [flags] +machine list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -211,18 +215,18 @@ Restart a machine from a team. ### Usage ``` - machine restart [arguments] [flags] +machine restart [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -233,18 +237,18 @@ Start a machine from a team. ### Usage ``` - machine start [arguments] [flags] +machine start [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -255,18 +259,18 @@ Stop a machine from a team. ### Usage ``` - machine stop [arguments] [flags] +machine stop [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -277,32 +281,31 @@ Update a machine's settings. ### Usage ``` - machine update [arguments] [flags] +machine update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md index 6f50a26..3c94f20 100644 --- a/.assets/pspace/model.md +++ b/.assets/pspace/model.md @@ -7,18 +7,18 @@ For more information, see https://docs.paperspace.com/deploying/models. ### Usage ``` - model [command] - model [flags] +model [command] +model [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -27,31 +27,32 @@ For more information, see https://docs.paperspace.com/deploying/models. - [get](#get) - [help](#help) - [list](#list) + ## pspace model create -Create a new model. This command will prompt you for a name if you don't -provide one. +Create a new model. This command will prompt you for a name if you don't provide +one. ### Usage ``` - model create [flags] +model create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -62,18 +63,18 @@ Delete a model from a team. ### Usage ``` - model delete [arguments] [flags] +model delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -84,18 +85,18 @@ Get a model from a team. ### Usage ``` - model get [arguments] [flags] +model get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -106,27 +107,29 @@ Show help for a model command ### Usage ``` - model help [command] - model help [arguments] [flags] +model help [command] +model help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace model help commands List model commands Example: + ``` $ model help commands commands ``` @@ -134,18 +137,18 @@ $ model help commands commands ### Usage ``` - model help commands [flags] +model help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -154,6 +157,7 @@ $ model help commands commands List models in your team. Pick a subset of fields to display: + ``` pspace model list -F name -F dtModified ``` @@ -161,23 +165,22 @@ pspace model list -F name -F dtModified ### Usage ``` - model list [flags] +model list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md index fca33b0..b20d5a9 100644 --- a/.assets/pspace/os-template.md +++ b/.assets/pspace/os-template.md @@ -1,30 +1,31 @@ ## pspace os-template -List OS templates. OS templates are pre-configured virtual machines that -you can use to create a new machine. +List OS templates. OS templates are pre-configured virtual machines that you can +use to create a new machine. For more information, see https://docs.paperspace.com/compute/os-templates. ### Usage ``` - os-template [command] - os-template [flags] +os-template [command] +os-template [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [help](#help) - [list](#list) + ## pspace os-template help Show help for a os-template command @@ -32,27 +33,29 @@ Show help for a os-template command ### Usage ``` - os-template help [command] - os-template help [arguments] [flags] +os-template help [command] +os-template help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace os-template help commands List os-template commands Example: + ``` $ os-template help commands commands ``` @@ -60,18 +63,18 @@ $ os-template help commands commands ### Usage ``` - os-template help commands [flags] +os-template help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -80,6 +83,7 @@ $ os-template help commands commands List OS templates. Pick a subset of fields to display: + ``` pspace os-template list -F name ``` @@ -87,24 +91,23 @@ pspace os-template list -F name ### Usage ``` - os-template list [flags] +os-template list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md index b37f679..cf587ea 100644 --- a/.assets/pspace/private-network.md +++ b/.assets/pspace/private-network.md @@ -4,23 +4,24 @@ Manage your private networks. Private networks are logically isolated networks for your machines and shared drives. They can also be used for site-to-site VPNs and direct connections to your on-premise network. -For more information, see https://docs.paperspace.com/networking/private-networks. +For more information, see +https://docs.paperspace.com/networking/private-networks. ### Usage ``` - private-network [command] - private-network [flags] +private-network [command] +private-network [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +30,7 @@ For more information, see https://docs.paperspace.com/networking/private-network - [get](#get) - [help](#help) - [list](#list) + ## pspace private-network create Create a private network. @@ -36,20 +38,20 @@ Create a private network. ### Usage ``` - private-network create [flags] +private-network create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -60,18 +62,18 @@ Delete a private network from a team. ### Usage ``` - private-network delete [arguments] [flags] +private-network delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -82,18 +84,18 @@ Get a private network from a team. ### Usage ``` - private-network get [arguments] [flags] +private-network get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -104,27 +106,29 @@ Show help for a private-network command ### Usage ``` - private-network help [command] - private-network help [arguments] [flags] +private-network help [command] +private-network help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace private-network help commands List private-network commands Example: + ``` $ private-network help commands commands ``` @@ -132,18 +136,18 @@ $ private-network help commands commands ### Usage ``` - private-network help commands [flags] +private-network help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -152,6 +156,7 @@ $ private-network help commands commands List private networks in your team. Pick a subset of fields to display: + ``` pspace private-network list -F name -F dtModified ``` @@ -159,25 +164,24 @@ pspace private-network list -F name -F dtModified ### Usage ``` - private-network list [flags] +private-network list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md index 8b654c4..8c373cc 100644 --- a/.assets/pspace/project.md +++ b/.assets/pspace/project.md @@ -5,18 +5,18 @@ Manage your Paperspace projects. ### Usage ``` - project [command] - project [flags] +project [command] +project [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -27,6 +27,7 @@ Manage your Paperspace projects. - [link](#link) - [list](#list) - [update](#update) + ## pspace project create Create a new project. This command will prompt you for a name if you don't @@ -35,64 +36,64 @@ provide one. ### Usage ``` - project create [arguments] [flags] +project create [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace project delete -Delete a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. +Delete a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. ### Usage ``` - project delete [arguments] [flags] +project delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace project get -Get a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. +Get a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. ### Usage ``` - project get [arguments] [flags] +project get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -103,27 +104,29 @@ Show help for a project command ### Usage ``` - project help [command] - project help [arguments] [flags] +project help [command] +project help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace project help commands List project commands Example: + ``` $ project help commands commands ``` @@ -131,38 +134,41 @@ $ project help commands commands ### Usage ``` - project help commands [flags] +project help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands ## pspace project link -This will link a remote project to a local directory. Commands that -depend on a project ID will use the project ID of the linked project -when communicating with the Paperspace API. +This will link a remote project to a local directory. Commands that depend on a +project ID will use the project ID of the linked project when communicating with +the Paperspace API. Link a project to the current directory. + ``` $ pspace link ``` Link a project to a different directory. + ``` $ pspace link --cwd ../my-app ``` Link a project and specify a project ID. + ``` $ pspace link pzwf2g05ubegj ``` @@ -170,18 +176,18 @@ $ pspace link pzwf2g05ubegj ### Usage ``` - project link [arguments] [flags] +project link [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------------------ | -------- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -190,6 +196,7 @@ $ pspace link pzwf2g05ubegj List projects in your team. Pick a subset of fields to display: + ``` pspace project list -F id -F name -F dtCreated ``` @@ -197,23 +204,23 @@ pspace project list -F id -F name -F dtCreated ### Usage ``` - project list [flags] +project list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -222,6 +229,7 @@ pspace project list -F id -F name -F dtCreated Update an existing project. Example: + ``` pspace project update psukfyemho7 --name my-cool-project ``` @@ -229,19 +237,18 @@ pspace project update psukfyemho7 --name my-cool-project ### Usage ``` - pspace project update [flags] +pspace project update [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md index 3fbafe3..6c3b8f5 100644 --- a/.assets/pspace/pspace.md +++ b/.assets/pspace/pspace.md @@ -1,30 +1,30 @@ ## pspace -A CLI for using the Paperspace API. +A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. -* Deploy an ML app with the `deployment` command -* View a deployed app with the `deployment open` command -* Check the status of a deployment with the `deployment status` command +- Deploy an ML app with the `deployment` command +- View a deployed app with the `deployment open` command +- Check the status of a deployment with the `deployment status` command Read the full documentation at: https://docs.paperspace.com/ ### Usage ``` - pspace [command] - pspace [flags] +pspace [command] +pspace [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -56,27 +56,28 @@ Read the full documentation at: https://docs.paperspace.com/ - [up](#up) - [upgrade](#upgrade) - [version](#version) + ## pspace autoscaling-group -Manage your autoscaling groups. Autoscaling groups enable using -the Kubernetes cluster-autoscaler to automatically scale your cluster. -You can also autoscaling groups as a primitive for your own autoscaler. +Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes +cluster-autoscaler to automatically scale your cluster. You can also autoscaling +groups as a primitive for your own autoscaler. ### Usage ``` - autoscaling-group [command] - autoscaling-group [flags] +autoscaling-group [command] +autoscaling-group [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -86,6 +87,7 @@ You can also autoscaling groups as a primitive for your own autoscaler. - [help](#help) - [list](#list) - [update](#update) + ## pspace autoscaling-group create Create an autoscaling group. @@ -93,27 +95,27 @@ Create an autoscaling group. ### Usage ``` - autoscaling-group create [flags] +autoscaling-group create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -124,18 +126,18 @@ Delete an autoscaling group from a team. ### Usage ``` - autoscaling-group delete [arguments] [flags] +autoscaling-group delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -146,18 +148,18 @@ Get an autoscaling group from a team. ### Usage ``` - autoscaling-group get [arguments] [flags] +autoscaling-group get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -168,27 +170,29 @@ Show help for a autoscaling-group command ### Usage ``` - autoscaling-group help [command] - autoscaling-group help [arguments] [flags] +autoscaling-group help [command] +autoscaling-group help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace autoscaling-group help commands List autoscaling-group commands Example: + ``` $ autoscaling-group help commands commands ``` @@ -196,18 +200,18 @@ $ autoscaling-group help commands commands ### Usage ``` - autoscaling-group help commands [flags] +autoscaling-group help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -216,6 +220,7 @@ $ autoscaling-group help commands commands List autoscaling groups in your team. Pick a subset of fields to display: + ``` pspace autoscaling-group list -F name -F dtCreated ``` @@ -223,25 +228,25 @@ pspace autoscaling-group list -F name -F dtCreated ### Usage ``` - autoscaling-group list [flags] +autoscaling-group list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -252,51 +257,51 @@ Update an autoscaling group. ### Usage ``` - autoscaling-group update [arguments] [flags] +autoscaling-group update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace completion -Generate an autocompletion script for pspace in the specified shell. -See each sub-command's help for details on how to use the generated script. +Generate an autocompletion script for pspace in the specified shell. See each +sub-command's help for details on how to use the generated script. ### Usage ``` - completion [command] - completion [flags] +completion [command] +completion [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -304,14 +309,16 @@ See each sub-command's help for details on how to use the generated script. - [fish](#fish) - [help](#help) - [zsh](#zsh) + ## pspace completion bash Generate the autocompletion script for the bash shell. -This script depends on the `bash-completion` package. -If it is not installed already, you can install it via your OS's package manager. +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. To load completions in your current shell session: + ``` $ source <(completion bash bash) ``` @@ -319,11 +326,13 @@ $ source <(completion bash bash) To load completions for every new session, execute once: Linux: + ``` $ completion bash bash > /etc/bash_completion.d/pspace ``` macOS: + ``` $ completion bash bash > /usr/local/etc/bash_completion.d/pspace ``` @@ -333,17 +342,17 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion bash [flags] +completion bash [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -352,11 +361,13 @@ You will need to start a new shell for this setup to take effect. Generate the autocompletion script for the fish shell. To load completions in your current shell session: + ``` $ completion fish fish | source ``` To load completions for every new session, execute once: + ``` $ completion fish fish > ~/.config/fish/completions/pspace.fish ``` @@ -366,18 +377,18 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion fish [flags] +completion fish [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -388,27 +399,29 @@ Show help for a completion command ### Usage ``` - completion help [command] - completion help [arguments] [flags] +completion help [command] +completion help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace completion help commands List completion commands Example: + ``` $ completion help commands commands ``` @@ -416,18 +429,18 @@ $ completion help commands commands ### Usage ``` - completion help commands [flags] +completion help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -435,8 +448,8 @@ $ completion help commands commands Generate the autocompletion script for the zsh shell. -If shell completion is not already enabled in your environment you will need -to enable it. You can execute the following once: +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: ``` $ echo "autoload -U compinit; compinit" >> ~/.zshrc @@ -445,16 +458,19 @@ $ echo "autoload -U compinit; compinit" >> ~/.zshrc To load completions for every new session, execute once: Linux: + ``` $ completion zsh zsh > "${fpath[1]}/_pspace" ``` macOS: + ``` $ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace ``` Oh My Zsh: + ``` $ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace ``` @@ -464,30 +480,31 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` - completion zsh [flags] +completion zsh [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace config -This command manages your Paperspace configuration. You can use it to set, get, and -delete configuration values. Running this command without any subcommands will print -your current configuration. +This command manages your Paperspace configuration. You can use it to set, get, +and delete configuration values. Running this command without any subcommands +will print your current configuration. -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: -For example, to set the current team, run: ``` pspace config set team "my-team" ``` @@ -495,18 +512,18 @@ pspace config set team "my-team" ### Usage ``` - config [command] - config [flags] +config [command] +config [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -514,6 +531,7 @@ pspace config set team "my-team" - [get](#get) - [help](#help) - [set](#set) + ## pspace config delete Delete a configuration value. @@ -521,17 +539,17 @@ Delete a configuration value. ### Usage ``` - config delete [flags] +config delete [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -541,6 +559,7 @@ This command gets a configuration value. You can pass a key to get a specific value, or you can pass no arguments to get all configuration values. For example, to get the current team run: + ``` pspace config get team ``` @@ -548,17 +567,17 @@ pspace config get team ### Usage ``` - config get [arguments] [flags] +config get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -569,27 +588,29 @@ Show help for a config command ### Usage ``` - config help [command] - config help [arguments] [flags] +config help [command] +config help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace config help commands List config commands Example: + ``` $ config help commands commands ``` @@ -597,18 +618,18 @@ $ config help commands commands ### Usage ``` - config help commands [flags] +config help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -619,17 +640,17 @@ Set a configuration value. ### Usage ``` - config set [arguments] [arguments...] [flags] +config set [arguments] [arguments...] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -640,43 +661,43 @@ This command opens the Paperspace web console in your browser. ### Usage ``` - console [flags] +console [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace custom-template -Manage your custom templates. Custom templates are a backup of your -machine's disk. They can be used to create additional machines. You -can use them to prepopulate a machine with your desired software stack. +Manage your custom templates. Custom templates are a backup of your machine's +disk. They can be used to create additional machines. You can use them to +prepopulate a machine with your desired software stack. For more information, see https://docs.paperspace.com/compute/custom-templates. ### Usage ``` - custom-template [command] - custom-template [flags] +custom-template [command] +custom-template [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -685,6 +706,7 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. - [get](#get) - [help](#help) - [list](#list) + ## pspace custom-template create Create a custom template from a machine. @@ -692,20 +714,20 @@ Create a custom template from a machine. ### Usage ``` - custom-template create [flags] +custom-template create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -716,18 +738,18 @@ Delete a custom template from a team. ### Usage ``` - custom-template delete [arguments] [flags] +custom-template delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -738,18 +760,18 @@ Get a custom template from a team. ### Usage ``` - custom-template get [arguments] [flags] +custom-template get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -760,27 +782,29 @@ Show help for a custom-template command ### Usage ``` - custom-template help [command] - custom-template help [arguments] [flags] +custom-template help [command] +custom-template help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace custom-template help commands List custom-template commands Example: + ``` $ custom-template help commands commands ``` @@ -788,18 +812,18 @@ $ custom-template help commands commands ### Usage ``` - custom-template help commands [flags] +custom-template help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -808,6 +832,7 @@ $ custom-template help commands commands List custom templates in your team. Pick a subset of fields to display: + ``` pspace custom-template list -F name -F dtModified ``` @@ -815,26 +840,26 @@ pspace custom-template list -F name -F dtModified ### Usage ``` - custom-template list [flags] +custom-template list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -847,18 +872,18 @@ For more information, see https://docs.paperspace.com/storage/datasets. ### Usage ``` - dataset [command] - dataset [flags] +dataset [command] +dataset [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -869,6 +894,7 @@ For more information, see https://docs.paperspace.com/storage/datasets. - [list](#list) - [update](#update) - [versions](#versions) + ## pspace dataset create Create a dataset. @@ -876,22 +902,22 @@ Create a dataset. ### Usage ``` - dataset create [flags] +dataset create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -902,18 +928,18 @@ Delete a dataset from a team. ### Usage ``` - dataset delete [arguments] [flags] +dataset delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -924,18 +950,18 @@ Get a dataset from a team. ### Usage ``` - dataset get [arguments] [flags] +dataset get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -946,27 +972,29 @@ Show help for a dataset command ### Usage ``` - dataset help [command] - dataset help [arguments] [flags] +dataset help [command] +dataset help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace dataset help commands List dataset commands Example: + ``` $ dataset help commands commands ``` @@ -974,18 +1002,18 @@ $ dataset help commands commands ### Usage ``` - dataset help commands [flags] +dataset help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -994,6 +1022,7 @@ $ dataset help commands commands List datasets in your team or project. Pick a subset of fields to display: + ``` pspace dataset list -F name -F dtModified ``` @@ -1001,23 +1030,23 @@ pspace dataset list -F name -F dtModified ### Usage ``` - dataset list [flags] +dataset list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1028,20 +1057,20 @@ Update a dataset in a project or team. ### Usage ``` - dataset update [arguments] [flags] +dataset update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1054,18 +1083,18 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. ### Usage ``` - dataset versions [command] - dataset versions [flags] +dataset versions [command] +dataset versions [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1075,6 +1104,7 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. - [help](#help) - [list](#list) - [update](#update) + ## pspace dataset versions create Create a dataset version. This command will prompt you for an ID if you don't @@ -1083,65 +1113,65 @@ provide one. ### Usage ``` - dataset versions create [arguments] [arguments] [flags] +dataset versions create [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace dataset versions delete -Delete a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Delete a dataset version from a team. This command will prompt you for an ID if +you don't provide one. ### Usage ``` - dataset versions delete [arguments] [arguments] [flags] +dataset versions delete [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace dataset versions get -Get a dataset version from a team. This command will prompt you for an ID -if you don't provide one. +Get a dataset version from a team. This command will prompt you for an ID if you +don't provide one. ### Usage ``` - dataset versions get [arguments] [arguments] [flags] +dataset versions get [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1152,27 +1182,29 @@ Show help for a versions command ### Usage ``` - dataset versions help [command] - dataset versions help [arguments] [flags] +dataset versions help [command] +dataset versions help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace dataset versions help commands List versions commands Example: + ``` $ dataset versions help commands commands ``` @@ -1180,18 +1212,18 @@ $ dataset versions help commands commands ### Usage ``` - dataset versions help commands [flags] +dataset versions help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -1200,6 +1232,7 @@ $ dataset versions help commands commands List dataset versions in your team or project. Pick a subset of fields to display: + ``` pspace dataset versions list -F name -F dtModified ``` @@ -1207,23 +1240,23 @@ pspace dataset versions list -F name -F dtModified ### Usage ``` - dataset versions list [arguments] [flags] +dataset versions list [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1234,20 +1267,20 @@ Update a dataset version in a project or team. ### Usage ``` - dataset versions update [arguments] [arguments] [flags] +dataset versions update [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1258,18 +1291,18 @@ Effortlessly deploy ML apps to Paperspace. ### Usage ``` - deployment [command] - deployment [flags] +deployment [command] +deployment [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1278,6 +1311,7 @@ Effortlessly deploy ML apps to Paperspace. - [help](#help) - [list](#list) - [up](#up) + ## pspace deployment delete Delete a deployment by its ID. If you don't provide an ID, this command will @@ -1290,30 +1324,31 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ### Usage ``` - deployment delete [arguments] [flags] +deployment delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace deployment get -Get a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. +Get a deployment by its ID. If you don't provide an ID, this command will prompt +you for one based on the deployments you have access to. ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 ``` Pick a subset of fields to display: + ``` pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ``` @@ -1321,18 +1356,18 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ### Usage ``` - deployment get [arguments] [flags] +deployment get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1343,27 +1378,29 @@ Show help for a deployment command ### Usage ``` - deployment help [command] - deployment help [arguments] [flags] +deployment help [command] +deployment help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace deployment help commands List deployment commands Example: + ``` $ deployment help commands commands ``` @@ -1371,18 +1408,18 @@ $ deployment help commands commands ### Usage ``` - deployment help commands [flags] +deployment help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -1391,6 +1428,7 @@ $ deployment help commands commands List deployments in your team. Pick a subset of fields to display: + ``` pspace deployment list -F id -F name ``` @@ -1398,48 +1436,52 @@ pspace deployment list -F id -F name ### Usage ``` - deployment list [flags] +deployment list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace deployment up -This will create a new deployment for your app or update it if it already exists. -You can optionally specify a path to a config file. If no config file is specified, -the default config file paths will be tried. +This will create a new deployment for your app or update it if it already +exists. You can optionally specify a path to a config file. If no config file is +specified, the default config file paths will be tried. Create a new deployment for the app in the current directory. + ``` $ pspace deployment create ``` Create a new deployment using a config file. + ``` $ pspace deployment create -c paperspace.json ``` Create a new deployment for an app in a different directory. + ``` $ pspace deployment create --cwd ../my-app ``` Create a new deployment for an app in a specific project. + ``` $ pspace deployment create --project-id 1234 ``` @@ -1447,14 +1489,14 @@ $ pspace deployment create --project-id 1234 ### Usage ``` - deployment up [flags] +deployment up [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. +| Name | Aliases | Description | Required | +| ------ | ------- | ----------------------------------------------------------------------- | -------- | +| config | c | The path to the config file. Defaults to our default config file paths. | | The default config file paths are in order of precedence: @@ -1467,39 +1509,38 @@ The default config file paths are in order of precedence: - `.paperspace/app.yml` - `.paperspace/app.json` - `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to + deploy to. | false | | cwd | | The directory to deploy the app from. Defaults + to the current directory. | false | | log-level | l | Enable debug logging. | + false | | json | j | Output JSON | false | | api-key | | A Paperspace public + API Key used for authenticating requests | false | | help | h | Show help for + a command | false | #### Subcommands ## pspace docs -This command opens the Paperspace documentation in your browser. -You can optionally pass an argument that will take you to a specific -docs page. +This command opens the Paperspace documentation in your browser. You can +optionally pass an argument that will take you to a specific docs page. Valid pages are: - - `d`, `deployment` + +- `d`, `deployment` ### Usage ``` - docs [arguments] [flags] +docs [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -1510,27 +1551,29 @@ Show help for a pspace command ### Usage ``` - help [command] - help [arguments] [flags] +help [command] +help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace help commands List pspace commands Example: + ``` $ help commands commands ``` @@ -1538,40 +1581,42 @@ $ help commands commands ### Usage ``` - help commands [flags] +help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands ## pspace init -Create a new Paperspace app. This will create a new directory with a -default app structure. You can optionally specify a name for the app -and a template to use. If no template is specified, the default -template will be used. +Create a new Paperspace app. This will create a new directory with a default app +structure. You can optionally specify a name for the app and a template to use. +If no template is specified, the default template will be used. Create a new app in the current directory. + ``` $ pspace init ``` Create a new app named "my-app" relative to the current directory. + ``` $ pspace init my-app ``` -Create a new app named "my-app" relative to the current directory using -a template from the Paperspace GitHub organization. +Create a new app named "my-app" relative to the current directory using a +template from the Paperspace GitHub organization. + ``` $ pspace init my-app -t Paperspace/gradio-demo ``` @@ -1579,17 +1624,18 @@ $ pspace init my-app -t Paperspace/gradio-demo ### Usage ``` - init [arguments] [flags] +init [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| template | t | A template to use when creating the app. This can be a URL -to a git repository or a shorthand template name. +| Name | Aliases | Description | Required | +| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | +| template | t | A template to use when creating the app. This can be a URL | | +| to a git repository or a shorthand template name. | | | | These templates are equivalent: + ``` user/repo github:user/repo @@ -1598,6 +1644,7 @@ https://github.com/user/repo ``` Download from GitLab: + ``` gitlab:user/repo git@gitlab.com:user/repo @@ -1605,6 +1652,7 @@ https://gitlab.com/user/repo ``` Download from Bitbucket + ``` bitbucket:user/repo git@bitbucket.org:user/repo @@ -1612,7 +1660,8 @@ https://bitbucket.org/user/repo ``` Specify a tag or branch: -``` + +```` user/repo#dev # branch user/repo#v1.2.3 # release tag user/repo#1234abcd # commit hash @@ -1635,11 +1684,11 @@ SSH key configured with GitHub, Bitbucket, or GitLab. | false | Log in to the CLI using your Paperspace API key or by opening the web console. ### Usage +```` -``` - login [arguments] [flags] -``` +login [arguments] [flags] +``` ### Flags | Name | Aliases | Description | Required | @@ -1655,12 +1704,12 @@ Log in to the CLI using your Paperspace API key or by opening the web console. Log out of the CLI for the current team, a specific team, or all teams. -### Usage +### Usage +``` + +logout [arguments...] [flags] ``` - logout [arguments...] [flags] -``` - ### Flags | Name | Aliases | Description | Required | @@ -1680,12 +1729,11 @@ Manage your Paperspace machines. For more information, see https://docs.paperspace.com/machines. ### Usage - -``` - machine [command] - machine [flags] ``` +machine [command] machine [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1711,11 +1759,11 @@ For more information, see https://docs.paperspace.com/machines. Create a machine. ### Usage - -``` - machine create [flags] ``` +machine create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1754,11 +1802,11 @@ Create a machine. Delete a machine from a team. ### Usage - -``` - machine delete [arguments] [flags] ``` +machine delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1776,11 +1824,11 @@ Delete a machine from a team. Get a machine from a team. ### Usage - -``` - machine get [arguments] [flags] ``` +machine get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1798,12 +1846,11 @@ Get a machine from a team. Show help for a machine command ### Usage - -``` - machine help [command] - machine help [arguments] [flags] ``` +machine help [command] machine help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1822,15 +1869,16 @@ List machine commands Example: ``` -$ machine help commands commands -``` -### Usage +$ machine help commands commands ``` - machine help commands [flags] +### Usage ``` +machine help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1849,15 +1897,16 @@ List machines in your team. Pick a subset of fields to display: ``` -pspace machine list -F name -F dtModified -``` -### Usage +pspace machine list -F name -F dtModified ``` - machine list [flags] +### Usage ``` +machine list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1884,11 +1933,11 @@ pspace machine list -F name -F dtModified Restart a machine from a team. ### Usage - -``` - machine restart [arguments] [flags] ``` +machine restart [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1906,11 +1955,11 @@ Restart a machine from a team. Start a machine from a team. ### Usage - -``` - machine start [arguments] [flags] ``` +machine start [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1928,11 +1977,11 @@ Start a machine from a team. Stop a machine from a team. ### Usage - -``` - machine stop [arguments] [flags] ``` +machine stop [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1950,11 +1999,11 @@ Stop a machine from a team. Update a machine's settings. ### Usage - -``` - machine update [arguments] [flags] ``` +machine update [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -1990,12 +2039,11 @@ which can be tracked using this command. For more information, see https://docs.paperspace.com/machines. ### Usage - -``` - machine-event [command] - machine-event [flags] ``` +machine-event [command] machine-event [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2015,11 +2063,11 @@ For more information, see https://docs.paperspace.com/machines. Get a machine event from a team. ### Usage - -``` - machine-event get [arguments] [flags] ``` +machine-event get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2037,12 +2085,11 @@ Get a machine event from a team. Show help for a machine-event command ### Usage - -``` - machine-event help [command] - machine-event help [arguments] [flags] ``` +machine-event help [command] machine-event help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2061,15 +2108,16 @@ List machine-event commands Example: ``` -$ machine-event help commands commands -``` -### Usage +$ machine-event help commands commands ``` - machine-event help commands [flags] +### Usage ``` +machine-event help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2088,15 +2136,16 @@ List machine events in your team. Pick a subset of fields to display: ``` -pspace machine-event list -F name -F dtModified -``` -### Usage +pspace machine-event list -F name -F dtModified ``` - machine-event list [flags] +### Usage ``` +machine-event list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2123,12 +2172,11 @@ Manage your Paperspace models. For more information, see https://docs.paperspace.com/deploying/models. ### Usage - -``` - model [command] - model [flags] ``` +model [command] model [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2151,11 +2199,11 @@ Create a new model. This command will prompt you for a name if you don't provide one. ### Usage - -``` - model create [flags] ``` +model create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2178,11 +2226,11 @@ provide one. Delete a model from a team. ### Usage - -``` - model delete [arguments] [flags] ``` +model delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2200,11 +2248,11 @@ Delete a model from a team. Get a model from a team. ### Usage - -``` - model get [arguments] [flags] ``` +model get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2222,12 +2270,11 @@ Get a model from a team. Show help for a model command ### Usage - -``` - model help [command] - model help [arguments] [flags] ``` +model help [command] model help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2246,15 +2293,16 @@ List model commands Example: ``` -$ model help commands commands -``` -### Usage +$ model help commands commands ``` - model help commands [flags] +### Usage ``` +model help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2273,15 +2321,16 @@ List models in your team. Pick a subset of fields to display: ``` -pspace model list -F name -F dtModified -``` -### Usage +pspace model list -F name -F dtModified ``` - model list [flags] +### Usage ``` +model list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2307,12 +2356,11 @@ you can use to create a new machine. For more information, see https://docs.paperspace.com/compute/os-templates. ### Usage - -``` - os-template [command] - os-template [flags] ``` +os-template [command] os-template [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2331,12 +2379,11 @@ For more information, see https://docs.paperspace.com/compute/os-templates. Show help for a os-template command ### Usage - -``` - os-template help [command] - os-template help [arguments] [flags] ``` +os-template help [command] os-template help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2355,15 +2402,16 @@ List os-template commands Example: ``` -$ os-template help commands commands -``` -### Usage +$ os-template help commands commands ``` - os-template help commands [flags] +### Usage ``` +os-template help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2382,15 +2430,16 @@ List OS templates. Pick a subset of fields to display: ``` -pspace os-template list -F name -``` -### Usage +pspace os-template list -F name ``` - os-template list [flags] +### Usage ``` +os-template list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2418,12 +2467,11 @@ and direct connections to your on-premise network. For more information, see https://docs.paperspace.com/networking/private-networks. ### Usage - -``` - private-network [command] - private-network [flags] ``` +private-network [command] private-network [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2445,11 +2493,11 @@ For more information, see https://docs.paperspace.com/networking/private-network Create a private network. ### Usage - -``` - private-network create [flags] ``` +private-network create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2469,11 +2517,11 @@ Create a private network. Delete a private network from a team. ### Usage - -``` - private-network delete [arguments] [flags] ``` +private-network delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2491,11 +2539,11 @@ Delete a private network from a team. Get a private network from a team. ### Usage - -``` - private-network get [arguments] [flags] ``` +private-network get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2513,12 +2561,11 @@ Get a private network from a team. Show help for a private-network command ### Usage - -``` - private-network help [command] - private-network help [arguments] [flags] ``` +private-network help [command] private-network help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2537,15 +2584,16 @@ List private-network commands Example: ``` -$ private-network help commands commands -``` -### Usage +$ private-network help commands commands ``` - private-network help commands [flags] +### Usage ``` +private-network help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2564,15 +2612,16 @@ List private networks in your team. Pick a subset of fields to display: ``` -pspace private-network list -F name -F dtModified -``` -### Usage +pspace private-network list -F name -F dtModified ``` - private-network list [flags] +### Usage ``` +private-network list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2597,12 +2646,11 @@ pspace private-network list -F name -F dtModified Manage your Paperspace projects. ### Usage - -``` - project [command] - project [flags] ``` +project [command] project [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2627,11 +2675,11 @@ Create a new project. This command will prompt you for a name if you don't provide one. ### Usage - -``` - project create [arguments] [flags] ``` +project create [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2650,11 +2698,11 @@ Delete a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. ### Usage - -``` - project delete [arguments] [flags] ``` +project delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2673,11 +2721,11 @@ Get a project by its ID. If you don't provide an ID, this command will prompt you for one based on the projects you have access to. ### Usage - -``` - project get [arguments] [flags] ``` +project get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2695,12 +2743,11 @@ prompt you for one based on the projects you have access to. Show help for a project command ### Usage - -``` - project help [command] - project help [arguments] [flags] ``` +project help [command] project help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2719,15 +2766,16 @@ List project commands Example: ``` -$ project help commands commands -``` -### Usage +$ project help commands commands ``` - project help commands [flags] +### Usage ``` +project help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2748,25 +2796,28 @@ when communicating with the Paperspace API. Link a project to the current directory. ``` + $ pspace link -``` +``` Link a project to a different directory. ``` + $ pspace link --cwd ../my-app -``` -Link a project and specify a project ID. ``` -$ pspace link pzwf2g05ubegj +Link a project and specify a project ID. ``` -### Usage +$ pspace link pzwf2g05ubegj ``` - project link [arguments] [flags] +### Usage ``` +project link [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2785,15 +2836,16 @@ List projects in your team. Pick a subset of fields to display: ``` -pspace project list -F id -F name -F dtCreated -``` -### Usage +pspace project list -F id -F name -F dtCreated ``` - project list [flags] +### Usage ``` +project list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2817,15 +2869,16 @@ Update an existing project. Example: ``` -pspace project update psukfyemho7 --name my-cool-project -``` -### Usage +pspace project update psukfyemho7 --name my-cool-project ``` - pspace project update [flags] +### Usage ``` +pspace project update [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2846,12 +2899,11 @@ Manage your public IPs. Public IP addresses allow your compute machines to be re For more information, see https://docs.paperspace.com/networking/public-ips. ### Usage - -``` - public-ip [command] - public-ip [flags] ``` +public-ip [command] public-ip [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2873,11 +2925,11 @@ For more information, see https://docs.paperspace.com/networking/public-ips. Assign a public IP to a machine. ### Usage - -``` - public-ip assign [arguments] [flags] ``` +public-ip assign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2896,11 +2948,11 @@ Assign a public IP to a machine. Claim a public IP for a team. ### Usage - -``` - public-ip claim [flags] ``` +public-ip claim [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2919,12 +2971,11 @@ Claim a public IP for a team. Show help for a public-ip command ### Usage - -``` - public-ip help [command] - public-ip help [arguments] [flags] ``` +public-ip help [command] public-ip help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2943,15 +2994,16 @@ List public-ip commands Example: ``` -$ public-ip help commands commands -``` -### Usage +$ public-ip help commands commands ``` - public-ip help commands [flags] +### Usage ``` +public-ip help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -2970,15 +3022,16 @@ List public IPs in your team or project. Pick a subset of fields to display: ``` -pspace public-ip list -F name -F dtModified -``` -### Usage +pspace public-ip list -F name -F dtModified ``` - public-ip list [flags] +### Usage ``` +public-ip list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3001,12 +3054,12 @@ pspace public-ip list -F name -F dtModified Release a public IP from a team. This will unassign it from its assigned machine, if any. -### Usage +### Usage +``` + +public-ip release [arguments] [flags] ``` - public-ip release [arguments] [flags] -``` - ### Flags | Name | Aliases | Description | Required | @@ -3034,12 +3087,11 @@ Secrets can be created at the following levels: For more information, see https://docs.paperspace.com/secrets. ### Usage - -``` - secret [command] - secret [flags] ``` +secret [command] secret [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3062,11 +3114,11 @@ For more information, see https://docs.paperspace.com/secrets. Create a secret in a project or team. ### Usage - -``` - secret create [arguments] [arguments] [flags] ``` +secret create [arguments] [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3091,11 +3143,11 @@ a project. | false | Delete a secret from a project or team. ### Usage - -``` - secret delete [arguments] [flags] ``` +secret delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3120,11 +3172,11 @@ a project. | false | Get a secret from a project or team. ### Usage - -``` - secret get [arguments] [flags] ``` +secret get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3150,12 +3202,11 @@ a project. | false | Show help for a secret command ### Usage - -``` - secret help [command] - secret help [arguments] [flags] ``` +secret help [command] secret help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3174,15 +3225,16 @@ List secret commands Example: ``` -$ secret help commands commands -``` -### Usage +$ secret help commands commands ``` - secret help commands [flags] +### Usage ``` +secret help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3201,15 +3253,16 @@ List secrets in your team or project. Pick a subset of fields to display: ``` -pspace secret list -F name -F dtModified -``` -### Usage +pspace secret list -F name -F dtModified ``` - secret list [flags] +### Usage ``` +secret list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3240,11 +3293,11 @@ a project. | false | Update a secret in a project or team. ### Usage - -``` - secret update [arguments] [arguments] [flags] ``` +secret update [arguments] [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3273,12 +3326,11 @@ in the same private network. For more information, see https://docs.paperspace.com/storage/shared-drives. ### Usage - -``` - shared-drive [command] - shared-drive [flags] ``` +shared-drive [command] shared-drive [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3300,11 +3352,11 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. Create a shared drive. ### Usage - -``` - shared-drive create [flags] ``` +shared-drive create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3326,11 +3378,11 @@ Create a shared drive. Delete a shared drive from a team. ### Usage - -``` - shared-drive delete [arguments] [flags] ``` +shared-drive delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3348,11 +3400,11 @@ Delete a shared drive from a team. Get a shared drive from a team. ### Usage - -``` - shared-drive get [arguments] [flags] ``` +shared-drive get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3370,12 +3422,11 @@ Get a shared drive from a team. Show help for a shared-drive command ### Usage - -``` - shared-drive help [command] - shared-drive help [arguments] [flags] ``` +shared-drive help [command] shared-drive help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3394,15 +3445,16 @@ List shared-drive commands Example: ``` -$ shared-drive help commands commands -``` -### Usage +$ shared-drive help commands commands ``` - shared-drive help commands [flags] +### Usage ``` +shared-drive help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3421,15 +3473,16 @@ List shared drives in your team or project. Pick a subset of fields to display: ``` -pspace shared-drive list -F name -F dtModified -``` -### Usage +pspace shared-drive list -F name -F dtModified ``` - shared-drive list [flags] +### Usage ``` +shared-drive list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3454,11 +3507,11 @@ pspace shared-drive list -F name -F dtModified This command opens the Paperspace signup page in your browser. ### Usage - -``` - signup [flags] ``` +signup [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3479,12 +3532,11 @@ before taking any action that could affect the usability of the machine or its n For more information, see https://docs.paperspace.com/storage/snapshots. ### Usage - -``` - snapshot [command] - snapshot [flags] ``` +snapshot [command] snapshot [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3506,11 +3558,11 @@ For more information, see https://docs.paperspace.com/storage/snapshots. Create a snapshot from a machine. ### Usage - -``` - snapshot create [flags] ``` +snapshot create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3530,11 +3582,11 @@ Create a snapshot from a machine. Delete a snapshot from a team. ### Usage - -``` - snapshot delete [arguments] [flags] ``` +snapshot delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3552,12 +3604,11 @@ Delete a snapshot from a team. Show help for a snapshot command ### Usage - -``` - snapshot help [command] - snapshot help [arguments] [flags] ``` +snapshot help [command] snapshot help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3576,15 +3627,16 @@ List snapshot commands Example: ``` -$ snapshot help commands commands -``` -### Usage +$ snapshot help commands commands ``` - snapshot help commands [flags] +### Usage ``` +snapshot help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3603,15 +3655,16 @@ List snapshots in your team. Pick a subset of fields to display: ``` -pspace snapshot list -F name -F dtModified -``` -### Usage +pspace snapshot list -F name -F dtModified ``` - snapshot list [flags] +### Usage ``` +snapshot list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3636,11 +3689,11 @@ will be returned. | false | Restore a machine to a snapshot. ### Usage - -``` - snapshot restore [arguments] [flags] ``` +snapshot restore [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3660,12 +3713,11 @@ Manage your startup scripts. Startup scripts allow you to configure a machine on first boot or on every boot. ### Usage - -``` - startup-script [command] - startup-script [flags] ``` +startup-script [command] startup-script [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3690,11 +3742,11 @@ on first boot or on every boot. Assign a startup script to a machine. ### Usage - -``` - startup-script assign [arguments] [flags] ``` +startup-script assign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3713,11 +3765,11 @@ Assign a startup script to a machine. Create a startup script. ### Usage - -``` - startup-script create [flags] ``` +startup-script create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3738,11 +3790,11 @@ Create a startup script. Delete a startup script from a team. ### Usage - -``` - startup-script delete [arguments] [flags] ``` +startup-script delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3760,11 +3812,11 @@ Delete a startup script from a team. Get a startup script from a team. ### Usage - -``` - startup-script get [arguments] [flags] ``` +startup-script get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3782,12 +3834,11 @@ Get a startup script from a team. Show help for a startup-script command ### Usage - -``` - startup-script help [command] - startup-script help [arguments] [flags] ``` +startup-script help [command] startup-script help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3806,15 +3857,16 @@ List startup-script commands Example: ``` -$ startup-script help commands commands -``` -### Usage +$ startup-script help commands commands ``` - startup-script help commands [flags] +### Usage ``` +startup-script help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3833,15 +3885,16 @@ List startup scripts in your team. Pick a subset of fields to display: ``` -pspace startup-script list -F name -F dtCreated -``` -### Usage +pspace startup-script list -F name -F dtCreated ``` - startup-script list [flags] +### Usage ``` +startup-script list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3865,11 +3918,11 @@ pspace startup-script list -F name -F dtCreated Unassign a startup script from a machine. ### Usage - -``` - startup-script unassign [arguments] [flags] ``` +startup-script unassign [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3888,11 +3941,11 @@ Unassign a startup script from a machine. Update a startup script. ### Usage - -``` - startup-script update [arguments] [flags] ``` +startup-script update [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3916,12 +3969,11 @@ Manage your storage providers. For more information, see https://docs.paperspace.com/storage/storageProviders. ### Usage - -``` - storage-provider [command] - storage-provider [flags] ``` +storage-provider [command] storage-provider [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3944,12 +3996,11 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. Create a storage provider. ### Usage - -``` - storage-provider create [command] - storage-provider create [flags] ``` +storage-provider create [command] storage-provider create [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3968,12 +4019,12 @@ Create a storage provider. Show help for a create command ### Usage - -``` - storage-provider create help [command] - storage-provider create help [arguments] [flags] ``` +storage-provider create help [command] storage-provider create help [arguments] +[flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -3992,15 +4043,16 @@ List create commands Example: ``` -$ storage-provider create help commands commands -``` -### Usage +$ storage-provider create help commands commands ``` - storage-provider create help commands [flags] +### Usage ``` +storage-provider create help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4018,11 +4070,11 @@ $ storage-provider create help commands commands Create an S3 storage provider. ### Usage - -``` - storage-provider create s3 [flags] ``` +storage-provider create s3 [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4049,11 +4101,11 @@ Create an S3 storage provider. Delete a storage provider from a team. ### Usage - -``` - storage-provider delete [arguments] [flags] ``` +storage-provider delete [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4071,11 +4123,11 @@ Delete a storage provider from a team. Get a storage provider from a team. ### Usage - -``` - storage-provider get [arguments] [flags] ``` +storage-provider get [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4093,12 +4145,11 @@ Get a storage provider from a team. Show help for a storage-provider command ### Usage - -``` - storage-provider help [command] - storage-provider help [arguments] [flags] ``` +storage-provider help [command] storage-provider help [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4117,15 +4168,16 @@ List storage-provider commands Example: ``` -$ storage-provider help commands commands -``` -### Usage +$ storage-provider help commands commands ``` - storage-provider help commands [flags] +### Usage ``` +storage-provider help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4144,15 +4196,16 @@ List storage providers in your team or project. Pick a subset of fields to display: ``` -pspace storage provider list -F name -F dtModified -``` -### Usage +pspace storage provider list -F name -F dtModified ``` - storage-provider list [flags] +### Usage ``` +storage-provider list [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4175,12 +4228,11 @@ pspace storage provider list -F name -F dtModified Update a storage provider. ### Usage - -``` - storage-provider update [command] - storage-provider update [flags] ``` +storage-provider update [command] storage-provider update [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4199,12 +4251,12 @@ Update a storage provider. Show help for a update command ### Usage - -``` - storage-provider update help [command] - storage-provider update help [arguments] [flags] ``` +storage-provider update help [command] storage-provider update help [arguments] +[flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4223,15 +4275,16 @@ List update commands Example: ``` -$ storage-provider update help commands commands -``` -### Usage +$ storage-provider update help commands commands ``` - storage-provider update help commands [flags] +### Usage ``` +storage-provider update help commands [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4249,11 +4302,11 @@ $ storage-provider update help commands commands Update an S3 storage provider in a project or team. ### Usage - -``` - storage-provider update s3 [arguments] [flags] ``` +storage-provider update s3 [arguments] [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4283,25 +4336,28 @@ config file paths will be tried. Deploy the app in the current directory. ``` + $ pspace up -``` +``` Deploy the app using a config file. ``` + $ pspace up -c paperspace.json -``` -Deploy an app in a different directory. ``` -$ pspace up --cwd ../my-app +Deploy an app in a different directory. ``` -### Usage +$ pspace up --cwd ../my-app ``` - up [flags] +### Usage ``` +up [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4337,21 +4393,23 @@ If you used a package manager like `brew` to install `pspace`, you should use that to upgrade in order to avoid potential permissions issues. For example, for `brew` you can upgrade by running: ``` + brew upgrade pspace -``` +``` If you installed `pspace` using the install script, you can upgrade by running: ``` -pspace upgrade -``` -### Usage +pspace upgrade ``` - upgrade [flags] +### Usage ``` +upgrade [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4368,11 +4426,11 @@ pspace upgrade Shows version information command, including version number and build date. ### Usage - -``` - version [flags] ``` +version [flags] + +``` ### Flags | Name | Aliases | Description | Required | @@ -4383,4 +4441,4 @@ Shows version information command, including version number and build date. | help | h | Show help for a command | false | #### Subcommands - +``` diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md index 7590bae..832c6cc 100644 --- a/.assets/pspace/public-ip.md +++ b/.assets/pspace/public-ip.md @@ -1,24 +1,25 @@ ## pspace public-ip -Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. +Manage your public IPs. Public IP addresses allow your compute machines to be +reachable over the internet. For more information, see https://docs.paperspace.com/networking/public-ips. ### Usage ``` - public-ip [command] - public-ip [flags] +public-ip [command] +public-ip [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -27,6 +28,7 @@ For more information, see https://docs.paperspace.com/networking/public-ips. - [help](#help) - [list](#list) - [release](#release) + ## pspace public-ip assign Assign a public IP to a machine. @@ -34,19 +36,19 @@ Assign a public IP to a machine. ### Usage ``` - public-ip assign [arguments] [flags] +public-ip assign [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -57,19 +59,19 @@ Claim a public IP for a team. ### Usage ``` - public-ip claim [flags] +public-ip claim [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -80,27 +82,29 @@ Show help for a public-ip command ### Usage ``` - public-ip help [command] - public-ip help [arguments] [flags] +public-ip help [command] +public-ip help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace public-ip help commands List public-ip commands Example: + ``` $ public-ip help commands commands ``` @@ -108,18 +112,18 @@ $ public-ip help commands commands ### Usage ``` - public-ip help commands [flags] +public-ip help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -128,6 +132,7 @@ $ public-ip help commands commands List public IPs in your team or project. Pick a subset of fields to display: + ``` pspace public-ip list -F name -F dtModified ``` @@ -135,46 +140,46 @@ pspace public-ip list -F name -F dtModified ### Usage ``` - public-ip list [flags] +public-ip list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands ## pspace public-ip release -Release a public IP from a team. This will unassign it from its assigned machine, if any. +Release a public IP from a team. This will unassign it from its assigned +machine, if any. ### Usage ``` - public-ip release [arguments] [flags] +public-ip release [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md index c8a0039..6f6c4f3 100644 --- a/.assets/pspace/secret.md +++ b/.assets/pspace/secret.md @@ -1,9 +1,9 @@ ## pspace secret -Manage your Paperspace secrets. Secrets are used to store sensitive -information such as API keys, passwords, and other credentials. Secrets -can be safely injected into workloads as environment variables. An environment -variable that uses a Secret will not reveal the contents of the secret itself. +Manage your Paperspace secrets. Secrets are used to store sensitive information +such as API keys, passwords, and other credentials. Secrets can be safely +injected into workloads as environment variables. An environment variable that +uses a Secret will not reveal the contents of the secret itself. Secrets can be created at the following levels: @@ -15,18 +15,18 @@ For more information, see https://docs.paperspace.com/secrets. ### Usage ``` - secret [command] - secret [flags] +secret [command] +secret [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -36,6 +36,7 @@ For more information, see https://docs.paperspace.com/secrets. - [help](#help) - [list](#list) - [update](#update) + ## pspace secret create Create a secret in a project or team. @@ -43,25 +44,25 @@ Create a secret in a project or team. ### Usage ``` - secret create [arguments] [arguments] [flags] +secret create [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| project-id | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| global | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -72,25 +73,25 @@ Delete a secret from a project or team. ### Usage ``` - secret delete [arguments] [flags] +secret delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| project-id | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| global | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -101,26 +102,26 @@ Get a secret from a project or team. ### Usage ``` - secret get [arguments] [flags] +secret get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| project-id | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| global | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -131,27 +132,29 @@ Show help for a secret command ### Usage ``` - secret help [command] - secret help [arguments] [flags] +secret help [command] +secret help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace secret help commands List secret commands Example: + ``` $ secret help commands commands ``` @@ -159,18 +162,18 @@ $ secret help commands commands ### Usage ``` - secret help commands [flags] +secret help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -179,6 +182,7 @@ $ secret help commands commands List secrets in your team or project. Pick a subset of fields to display: + ``` pspace secret list -F name -F dtModified ``` @@ -186,31 +190,31 @@ pspace secret list -F name -F dtModified ### Usage ``` - secret list [flags] +secret list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| global | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -221,25 +225,24 @@ Update a secret in a project or team. ### Usage ``` - secret update [arguments] [arguments] [flags] +secret update [arguments] [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| project-id | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| global | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md index 9dab486..7dd8860 100644 --- a/.assets/pspace/shared-drive.md +++ b/.assets/pspace/shared-drive.md @@ -1,26 +1,26 @@ ## pspace shared-drive -Manage your shared drives. Shared drives are used to centralize data -used by your team. Shared drives can be mounted on any Paperspace machine -in the same private network. +Manage your shared drives. Shared drives are used to centralize data used by +your team. Shared drives can be mounted on any Paperspace machine in the same +private network. For more information, see https://docs.paperspace.com/storage/shared-drives. ### Usage ``` - shared-drive [command] - shared-drive [flags] +shared-drive [command] +shared-drive [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +29,7 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. - [get](#get) - [help](#help) - [list](#list) + ## pspace shared-drive create Create a shared drive. @@ -36,22 +37,22 @@ Create a shared drive. ### Usage ``` - shared-drive create [flags] +shared-drive create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -62,18 +63,18 @@ Delete a shared drive from a team. ### Usage ``` - shared-drive delete [arguments] [flags] +shared-drive delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -84,18 +85,18 @@ Get a shared drive from a team. ### Usage ``` - shared-drive get [arguments] [flags] +shared-drive get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -106,27 +107,29 @@ Show help for a shared-drive command ### Usage ``` - shared-drive help [command] - shared-drive help [arguments] [flags] +shared-drive help [command] +shared-drive help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace shared-drive help commands List shared-drive commands Example: + ``` $ shared-drive help commands commands ``` @@ -134,18 +137,18 @@ $ shared-drive help commands commands ### Usage ``` - shared-drive help commands [flags] +shared-drive help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -154,6 +157,7 @@ $ shared-drive help commands commands List shared drives in your team or project. Pick a subset of fields to display: + ``` pspace shared-drive list -F name -F dtModified ``` @@ -161,25 +165,24 @@ pspace shared-drive list -F name -F dtModified ### Usage ``` - shared-drive list [flags] +shared-drive list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md index 5cf0144..9ba9230 100644 --- a/.assets/pspace/signup.md +++ b/.assets/pspace/signup.md @@ -5,17 +5,16 @@ This command opens the Paperspace signup page in your browser. ### Usage ``` - signup [flags] +signup [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md index 89cc951..078295d 100644 --- a/.assets/pspace/snapshot.md +++ b/.assets/pspace/snapshot.md @@ -1,26 +1,27 @@ ## pspace snapshot -Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. -They can be used to restore the machine to its previous state. Using snapshots is recommended -before taking any action that could affect the usability of the machine or its network connection. +Manage your snapshots. Snapshots are copies of your machine's disk at a point in +time. They can be used to restore the machine to its previous state. Using +snapshots is recommended before taking any action that could affect the +usability of the machine or its network connection. For more information, see https://docs.paperspace.com/storage/snapshots. ### Usage ``` - snapshot [command] - snapshot [flags] +snapshot [command] +snapshot [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +30,7 @@ For more information, see https://docs.paperspace.com/storage/snapshots. - [help](#help) - [list](#list) - [restore](#restore) + ## pspace snapshot create Create a snapshot from a machine. @@ -36,20 +38,20 @@ Create a snapshot from a machine. ### Usage ``` - snapshot create [flags] +snapshot create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -60,18 +62,18 @@ Delete a snapshot from a team. ### Usage ``` - snapshot delete [arguments] [flags] +snapshot delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -82,27 +84,29 @@ Show help for a snapshot command ### Usage ``` - snapshot help [command] - snapshot help [arguments] [flags] +snapshot help [command] +snapshot help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace snapshot help commands List snapshot commands Example: + ``` $ snapshot help commands commands ``` @@ -110,18 +114,18 @@ $ snapshot help commands commands ### Usage ``` - snapshot help commands [flags] +snapshot help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -130,6 +134,7 @@ $ snapshot help commands commands List snapshots in your team. Pick a subset of fields to display: + ``` pspace snapshot list -F name -F dtModified ``` @@ -137,25 +142,25 @@ pspace snapshot list -F name -F dtModified ### Usage ``` - snapshot list [flags] +snapshot list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -166,19 +171,18 @@ Restore a machine to a snapshot. ### Usage ``` - snapshot restore [arguments] [flags] +snapshot restore [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md index 4ff5148..c592d77 100644 --- a/.assets/pspace/startup-script.md +++ b/.assets/pspace/startup-script.md @@ -1,23 +1,23 @@ ## pspace startup-script -Manage your startup scripts. Startup scripts allow you to configure a machine -on first boot or on every boot. +Manage your startup scripts. Startup scripts allow you to configure a machine on +first boot or on every boot. ### Usage ``` - startup-script [command] - startup-script [flags] +startup-script [command] +startup-script [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -29,6 +29,7 @@ on first boot or on every boot. - [list](#list) - [unassign](#unassign) - [update](#update) + ## pspace startup-script assign Assign a startup script to a machine. @@ -36,19 +37,19 @@ Assign a startup script to a machine. ### Usage ``` - startup-script assign [arguments] [flags] +startup-script assign [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -59,21 +60,21 @@ Create a startup script. ### Usage ``` - startup-script create [flags] +startup-script create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -84,18 +85,18 @@ Delete a startup script from a team. ### Usage ``` - startup-script delete [arguments] [flags] +startup-script delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -106,18 +107,18 @@ Get a startup script from a team. ### Usage ``` - startup-script get [arguments] [flags] +startup-script get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -128,27 +129,29 @@ Show help for a startup-script command ### Usage ``` - startup-script help [command] - startup-script help [arguments] [flags] +startup-script help [command] +startup-script help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace startup-script help commands List startup-script commands Example: + ``` $ startup-script help commands commands ``` @@ -156,18 +159,18 @@ $ startup-script help commands commands ### Usage ``` - startup-script help commands [flags] +startup-script help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -176,6 +179,7 @@ $ startup-script help commands commands List startup scripts in your team. Pick a subset of fields to display: + ``` pspace startup-script list -F name -F dtCreated ``` @@ -183,24 +187,24 @@ pspace startup-script list -F name -F dtCreated ### Usage ``` - startup-script list [flags] +startup-script list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -211,19 +215,19 @@ Unassign a startup script from a machine. ### Usage ``` - startup-script unassign [arguments] [flags] +startup-script unassign [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ---------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -234,22 +238,21 @@ Update a startup script. ### Usage ``` - startup-script update [arguments] [flags] +startup-script update [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md index 185ea29..a332d1e 100644 --- a/.assets/pspace/storage-provider.md +++ b/.assets/pspace/storage-provider.md @@ -7,18 +7,18 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. ### Usage ``` - storage-provider [command] - storage-provider [flags] +storage-provider [command] +storage-provider [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -28,6 +28,7 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. - [help](#help) - [list](#list) - [update](#update) + ## pspace storage-provider create Create a storage provider. @@ -35,23 +36,24 @@ Create a storage provider. ### Usage ``` - storage-provider create [command] - storage-provider create [flags] +storage-provider create [command] +storage-provider create [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [help](#help) - [s3](#s3) + ## pspace storage-provider create help Show help for a create command @@ -59,27 +61,29 @@ Show help for a create command ### Usage ``` - storage-provider create help [command] - storage-provider create help [arguments] [flags] +storage-provider create help [command] +storage-provider create help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace storage-provider create help commands List create commands Example: + ``` $ storage-provider create help commands commands ``` @@ -87,18 +91,18 @@ $ storage-provider create help commands commands ### Usage ``` - storage-provider create help commands [flags] +storage-provider create help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -109,27 +113,27 @@ Create an S3 storage provider. ### Usage ``` - storage-provider create s3 [flags] +storage-provider create s3 [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -140,18 +144,18 @@ Delete a storage provider from a team. ### Usage ``` - storage-provider delete [arguments] [flags] +storage-provider delete [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -162,18 +166,18 @@ Get a storage provider from a team. ### Usage ``` - storage-provider get [arguments] [flags] +storage-provider get [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -184,27 +188,29 @@ Show help for a storage-provider command ### Usage ``` - storage-provider help [command] - storage-provider help [arguments] [flags] +storage-provider help [command] +storage-provider help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace storage-provider help commands List storage-provider commands Example: + ``` $ storage-provider help commands commands ``` @@ -212,18 +218,18 @@ $ storage-provider help commands commands ### Usage ``` - storage-provider help commands [flags] +storage-provider help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -232,6 +238,7 @@ $ storage-provider help commands commands List storage providers in your team or project. Pick a subset of fields to display: + ``` pspace storage provider list -F name -F dtModified ``` @@ -239,23 +246,23 @@ pspace storage provider list -F name -F dtModified ### Usage ``` - storage-provider list [flags] +storage-provider list [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands @@ -266,23 +273,24 @@ Update a storage provider. ### Usage ``` - storage-provider update [command] - storage-provider update [flags] +storage-provider update [command] +storage-provider update [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [help](#help) - [s3](#s3) + ## pspace storage-provider update help Show help for a update command @@ -290,27 +298,29 @@ Show help for a update command ### Usage ``` - storage-provider update help [command] - storage-provider update help [arguments] [flags] +storage-provider update help [command] +storage-provider update help [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - [commands](#commands) + ## pspace storage-provider update help commands List update commands Example: + ``` $ storage-provider update help commands commands ``` @@ -318,18 +328,18 @@ $ storage-provider update help commands commands ### Usage ``` - storage-provider update help commands [flags] +storage-provider update help commands [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | #### Subcommands @@ -340,27 +350,26 @@ Update an S3 storage provider in a project or team. ### Usage ``` - storage-provider update s3 [arguments] [flags] +storage-provider update s3 [arguments] [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md index b1f6e5d..177f907 100644 --- a/.assets/pspace/up.md +++ b/.assets/pspace/up.md @@ -1,20 +1,23 @@ ## pspace up -This will upsert an app config and deploy your app to Paperspace. You can optionally -specify a path to a config file. If no config file is specified, the default -config file paths will be tried. +This will upsert an app config and deploy your app to Paperspace. You can +optionally specify a path to a config file. If no config file is specified, the +default config file paths will be tried. Deploy the app in the current directory. + ``` $ pspace up ``` Deploy the app using a config file. + ``` $ pspace up -c paperspace.json ``` Deploy an app in a different directory. + ``` $ pspace up --cwd ../my-app ``` @@ -22,14 +25,14 @@ $ pspace up --cwd ../my-app ### Usage ``` - up [flags] +up [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. +| Name | Aliases | Description | Required | +| ------ | ------- | ----------------------------------------------------------------------- | -------- | +| config | c | The path to the config file. Defaults to our default config file paths. | | The default config file paths are in order of precedence: @@ -42,13 +45,11 @@ The default config file paths are in order of precedence: - `.paperspace/app.yml` - `.paperspace/app.json` - `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to + deploy to. | false | | cwd | | The directory to deploy the app from. Defaults + to the current directory. | false | | log-level | l | Enable debug logging. | + false | | json | j | Output JSON | false | | api-key | | A Paperspace public + API Key used for authenticating requests | false | | help | h | Show help for + a command | false | #### Subcommands - diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md index c5d2a5d..6cd3c3f 100644 --- a/.assets/pspace/upgrade.md +++ b/.assets/pspace/upgrade.md @@ -2,15 +2,16 @@ This command upgrades pspace to the latest version. -If you used a package manager like `brew` to install `pspace`, -you should use that to upgrade in order to avoid potential permissions -issues. For example, for `brew` you can upgrade by running: +If you used a package manager like `brew` to install `pspace`, you should use +that to upgrade in order to avoid potential permissions issues. For example, for +`brew` you can upgrade by running: + ``` brew upgrade pspace ``` -If you installed `pspace` using the install script, you can upgrade by -running: +If you installed `pspace` using the install script, you can upgrade by running: + ``` pspace upgrade ``` @@ -18,17 +19,16 @@ pspace upgrade ### Usage ``` - upgrade [flags] +upgrade [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md index b32401d..1096a69 100644 --- a/.assets/pspace/version.md +++ b/.assets/pspace/version.md @@ -5,17 +5,16 @@ Shows version information command, including version number and build date. ### Usage ``` - version [flags] +version [flags] ``` ### Flags -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --------- | ------- | ------------------------------------------------------------ | -------- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | #### Subcommands - From aca61b6b8db84666a09e87e725d8e4c2ce432edf Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 23 May 2024 18:39:38 -0400 Subject: [PATCH 08/10] fix --- .assets/pspace.json | 364 +-- .assets/pspace/autoscaling-group.md | 46 +- .assets/pspace/completion.md | 58 +- .assets/pspace/config.md | 42 +- .assets/pspace/console.md | 2 +- .assets/pspace/custom-template.md | 44 +- .assets/pspace/dataset.md | 229 +- .assets/pspace/deployment.md | 44 +- .assets/pspace/docs.md | 2 +- .assets/pspace/help.md | 8 +- .assets/pspace/init.md | 2 +- .assets/pspace/login.md | 2 +- .assets/pspace/logout.md | 2 +- .assets/pspace/machine-event.md | 40 +- .assets/pspace/machine.md | 52 +- .assets/pspace/model.md | 44 +- .assets/pspace/os-template.md | 38 +- .assets/pspace/private-network.md | 44 +- .assets/pspace/project.md | 46 +- .assets/pspace/pspace.md | 4386 --------------------------- .assets/pspace/public-ip.md | 44 +- .assets/pspace/secret.md | 46 +- .assets/pspace/shared-drive.md | 44 +- .assets/pspace/signup.md | 2 +- .assets/pspace/snapshot.md | 44 +- .assets/pspace/startup-script.md | 50 +- .assets/pspace/storage-provider.md | 216 +- .assets/pspace/up.md | 2 +- .assets/pspace/upgrade.md | 2 +- .assets/pspace/version.md | 2 +- .scripts/generate-docs.ts | 14 +- .scripts/zcli-json.ts | 2 +- 32 files changed, 367 insertions(+), 5596 deletions(-) diff --git a/.assets/pspace.json b/.assets/pspace.json index daad69f..b5fc660 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-23T19:42:58.057Z", + "buildDate": "2024-05-23T22:39:21.821Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, @@ -91,7 +91,7 @@ "name": "autoscaling-group", "description": "Manage your autoscaling groups. Autoscaling groups enable using\nthe Kubernetes cluster-autoscaler to automatically scale your cluster.\nYou can also autoscaling groups as a primitive for your own autoscaler.", "summary": "Manage your autoscaling groups", - "usage": " autoscaling-group [command]\n autoscaling-group [flags]", + "usage": " pspace autoscaling-group [command]\n pspace autoscaling-group [flags]", "flags": [ { "name": "log-level", @@ -169,7 +169,7 @@ "name": "create", "description": "Create an autoscaling group.", "summary": "Create an autoscaling group", - "usage": " autoscaling-group create [flags]", + "usage": " pspace autoscaling-group create [flags]", "flags": [ { "name": "fields", @@ -392,7 +392,7 @@ "name": "delete", "description": "Delete an autoscaling group from a team.", "summary": "Delete an autoscaling group", - "usage": " autoscaling-group delete [arguments] [flags]", + "usage": " pspace autoscaling-group delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -504,7 +504,7 @@ "name": "get", "description": "Get an autoscaling group from a team.", "summary": "Get an autoscaling group", - "usage": " autoscaling-group get [arguments] [flags]", + "usage": " pspace autoscaling-group get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -616,7 +616,7 @@ "name": "help", "description": "Show help for a autoscaling-group command", "summary": "Show help for a autoscaling-group command", - "usage": " autoscaling-group help [command]\n autoscaling-group help [arguments] [flags]", + "usage": " pspace autoscaling-group help [command]\n pspace autoscaling-group help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -717,9 +717,9 @@ "commands": [ { "name": "commands", - "description": "List autoscaling-group commands\n\nExample:\n```\n$ autoscaling-group help commands commands\n```", + "description": "List autoscaling-group commands\n\nExample:\n```\n$ pspace autoscaling-group help commands commands\n```", "summary": "List autoscaling-group commands", - "usage": " autoscaling-group help commands [flags]", + "usage": " pspace autoscaling-group help commands [flags]", "flags": [ { "name": "log-level", @@ -817,7 +817,7 @@ "name": "list", "description": "List autoscaling groups in your team.\n\nPick a subset of fields to display:\n```\npspace autoscaling-group list -F name -F dtCreated\n```", "summary": "List autoscaling groups.", - "usage": " autoscaling-group list [flags]", + "usage": " pspace autoscaling-group list [flags]", "flags": [ { "name": "limit", @@ -1013,7 +1013,7 @@ "name": "update", "description": "Update an autoscaling group.", "summary": "Update an autoscaling group", - "usage": " autoscaling-group update [arguments] [flags]", + "usage": " pspace autoscaling-group update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1269,7 +1269,7 @@ "name": "completion", "description": "Generate an autocompletion script for pspace in the specified shell.\nSee each sub-command's help for details on how to use the generated script.", "summary": "Generate an autocompletion script for the specified shell", - "usage": " completion [command]\n completion [flags]", + "usage": " pspace completion [command]\n pspace completion [flags]", "flags": [ { "name": "log-level", @@ -1345,9 +1345,9 @@ "commands": [ { "name": "bash", - "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(completion bash bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ completion bash bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ completion bash bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(pspace completion bash bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion bash bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the bash shell", - "usage": " completion bash [flags]", + "usage": " pspace completion bash [flags]", "flags": [ { "name": "log-level", @@ -1424,9 +1424,9 @@ }, { "name": "fish", - "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ completion fish fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ completion fish fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ pspace completion fish fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the fish shell", - "usage": " completion fish [flags]", + "usage": " pspace completion fish [flags]", "flags": [ { "name": "no-descriptions", @@ -1520,7 +1520,7 @@ "name": "help", "description": "Show help for a completion command", "summary": "Show help for a completion command", - "usage": " completion help [command]\n completion help [arguments] [flags]", + "usage": " pspace completion help [command]\n pspace completion help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1619,9 +1619,9 @@ "commands": [ { "name": "commands", - "description": "List completion commands\n\nExample:\n```\n$ completion help commands commands\n```", + "description": "List completion commands\n\nExample:\n```\n$ pspace completion help commands commands\n```", "summary": "List completion commands", - "usage": " completion help commands [flags]", + "usage": " pspace completion help commands [flags]", "flags": [ { "name": "log-level", @@ -1717,9 +1717,9 @@ }, { "name": "zsh", - "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ completion zsh zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion zsh zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the zsh shell", - "usage": " completion zsh [flags]", + "usage": " pspace completion zsh [flags]", "flags": [ { "name": "no-descriptions", @@ -1815,7 +1815,7 @@ "name": "config", "description": "This command manages your Paperspace configuration. You can use it to set, get, and \ndelete configuration values. Running this command without any subcommands will print \nyour current configuration.\n\nYour configuration is stored in a TOML file at `~/.paperspace/config.toml`. \n\nFor example, to set the current team, run: \n```\npspace config set team \"my-team\"\n```", "summary": "Manage your local Paperspace configuration.", - "usage": " config [command]\n config [flags]", + "usage": " pspace config [command]\n pspace config [flags]", "flags": [ { "name": "log-level", @@ -1893,7 +1893,7 @@ "name": "delete", "description": "Delete a configuration value.", "summary": "Delete a configuration value.", - "usage": " config delete [flags]", + "usage": " pspace config delete [flags]", "arguments": { "description": "", "summary": "The key to delete.", @@ -1994,7 +1994,7 @@ "name": "get", "description": "This command gets a configuration value. You can pass a key to get a specific\nvalue, or you can pass no arguments to get all configuration values.\n\nFor example, to get the current team run:\n```\npspace config get team\n```", "summary": "Get a configuration value.", - "usage": " config get [arguments] [flags]", + "usage": " pspace config get [arguments] [flags]", "arguments": { "description": "", "summary": "The key to get.", @@ -2095,7 +2095,7 @@ "name": "help", "description": "Show help for a config command", "summary": "Show help for a config command", - "usage": " config help [command]\n config help [arguments] [flags]", + "usage": " pspace config help [command]\n pspace config help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2194,9 +2194,9 @@ "commands": [ { "name": "commands", - "description": "List config commands\n\nExample:\n```\n$ config help commands commands\n```", + "description": "List config commands\n\nExample:\n```\n$ pspace config help commands commands\n```", "summary": "List config commands", - "usage": " config help commands [flags]", + "usage": " pspace config help commands [flags]", "flags": [ { "name": "log-level", @@ -2294,7 +2294,7 @@ "name": "set", "description": "Set a configuration value.", "summary": "Set a configuration value.", - "usage": " config set [arguments] [arguments...] [flags]", + "usage": " pspace config set [arguments] [arguments...] [flags]", "arguments": { "description": "", "summary": "The key/value pair to set.", @@ -2408,7 +2408,7 @@ "name": "console", "description": "This command opens the Paperspace web console in your browser.", "summary": "Open the Paperspace web console.", - "usage": " console [flags]", + "usage": " pspace console [flags]", "flags": [ { "name": "log-level", @@ -2487,7 +2487,7 @@ "name": "custom-template", "description": "Manage your custom templates. Custom templates are a backup of your\nmachine's disk. They can be used to create additional machines. You\ncan use them to prepopulate a machine with your desired software stack.\n\nFor more information, see https://docs.paperspace.com/compute/custom-templates.", "summary": "Manage your custom templates", - "usage": " custom-template [command]\n custom-template [flags]", + "usage": " pspace custom-template [command]\n pspace custom-template [flags]", "flags": [ { "name": "log-level", @@ -2565,7 +2565,7 @@ "name": "create", "description": "Create a custom template from a machine.", "summary": "Create a custom template", - "usage": " custom-template create [flags]", + "usage": " pspace custom-template create [flags]", "flags": [ { "name": "fields", @@ -2692,7 +2692,7 @@ "name": "delete", "description": "Delete a custom template from a team.", "summary": "Delete a custom template", - "usage": " custom-template delete [arguments] [flags]", + "usage": " pspace custom-template delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2804,7 +2804,7 @@ "name": "get", "description": "Get a custom template from a team.", "summary": "Get a custom template", - "usage": " custom-template get [arguments] [flags]", + "usage": " pspace custom-template get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2916,7 +2916,7 @@ "name": "help", "description": "Show help for a custom-template command", "summary": "Show help for a custom-template command", - "usage": " custom-template help [command]\n custom-template help [arguments] [flags]", + "usage": " pspace custom-template help [command]\n pspace custom-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -3016,9 +3016,9 @@ "commands": [ { "name": "commands", - "description": "List custom-template commands\n\nExample:\n```\n$ custom-template help commands commands\n```", + "description": "List custom-template commands\n\nExample:\n```\n$ pspace custom-template help commands commands\n```", "summary": "List custom-template commands", - "usage": " custom-template help commands [flags]", + "usage": " pspace custom-template help commands [flags]", "flags": [ { "name": "log-level", @@ -3116,7 +3116,7 @@ "name": "list", "description": "List custom templates in your team.\n\nPick a subset of fields to display:\n```\npspace custom-template list -F name -F dtModified\n```", "summary": "List custom templates.", - "usage": " custom-template list [flags]", + "usage": " pspace custom-template list [flags]", "flags": [ { "name": "limit", @@ -3318,7 +3318,7 @@ "name": "dataset", "description": "Manage your datasets.\n\nFor more information, see https://docs.paperspace.com/storage/datasets.", "summary": "Manage your datasets", - "usage": " dataset [command]\n dataset [flags]", + "usage": " pspace dataset [command]\n pspace dataset [flags]", "flags": [ { "name": "log-level", @@ -3396,7 +3396,7 @@ "name": "create", "description": "Create a dataset.", "summary": "Create a dataset", - "usage": " dataset create [flags]", + "usage": " pspace dataset create [flags]", "flags": [ { "name": "fields", @@ -3549,7 +3549,7 @@ "name": "delete", "description": "Delete a dataset from a team.", "summary": "Delete a dataset", - "usage": " dataset delete [arguments] [flags]", + "usage": " pspace dataset delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -3661,7 +3661,7 @@ "name": "get", "description": "Get a dataset from a team.", "summary": "Get a dataset", - "usage": " dataset get [arguments] [flags]", + "usage": " pspace dataset get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -3773,7 +3773,7 @@ "name": "help", "description": "Show help for a dataset command", "summary": "Show help for a dataset command", - "usage": " dataset help [command]\n dataset help [arguments] [flags]", + "usage": " pspace dataset help [command]\n pspace dataset help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -3875,9 +3875,9 @@ "commands": [ { "name": "commands", - "description": "List dataset commands\n\nExample:\n```\n$ dataset help commands commands\n```", + "description": "List dataset commands\n\nExample:\n```\n$ pspace dataset help commands commands\n```", "summary": "List dataset commands", - "usage": " dataset help commands [flags]", + "usage": " pspace dataset help commands [flags]", "flags": [ { "name": "log-level", @@ -3975,7 +3975,7 @@ "name": "list", "description": "List datasets in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset list -F name -F dtModified\n```", "summary": "List datasets.", - "usage": " dataset list [flags]", + "usage": " pspace dataset list [flags]", "flags": [ { "name": "limit", @@ -4143,7 +4143,7 @@ "name": "update", "description": "Update a dataset in a project or team.", "summary": "Update a dataset", - "usage": " dataset update [arguments] [flags]", + "usage": " pspace dataset update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4285,7 +4285,7 @@ "name": "versions", "description": "Manage your dataset versions.\n\nFor more information, see https://docs.paperspace.com/storage/datasetVersions.", "summary": "Manage your dataset versions", - "usage": " dataset versions [command]\n dataset versions [flags]", + "usage": " pspace dataset versions [command]\n pspace dataset versions [flags]", "flags": [ { "name": "log-level", @@ -4363,7 +4363,7 @@ "name": "create", "description": "Create a dataset version. This command will prompt you for an ID if you don't\nprovide one.", "summary": "Create a dataset version", - "usage": " dataset versions create [arguments] [arguments] [flags]", + "usage": " pspace dataset versions create [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4500,7 +4500,7 @@ "name": "delete", "description": "Delete a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", "summary": "Delete a dataset version", - "usage": " dataset versions delete [arguments] [arguments] [flags]", + "usage": " pspace dataset versions delete [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4623,7 +4623,7 @@ "name": "get", "description": "Get a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", "summary": "Get a dataset version", - "usage": " dataset versions get [arguments] [arguments] [flags]", + "usage": " pspace dataset versions get [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4746,7 +4746,7 @@ "name": "help", "description": "Show help for a versions command", "summary": "Show help for a versions command", - "usage": " dataset versions help [command]\n dataset versions help [arguments] [flags]", + "usage": " pspace dataset versions help [command]\n pspace dataset versions help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4847,9 +4847,9 @@ "commands": [ { "name": "commands", - "description": "List versions commands\n\nExample:\n```\n$ dataset versions help commands commands\n```", + "description": "List versions commands\n\nExample:\n```\n$ pspace dataset versions help commands commands\n```", "summary": "List versions commands", - "usage": " dataset versions help commands [flags]", + "usage": " pspace dataset versions help commands [flags]", "flags": [ { "name": "log-level", @@ -4947,7 +4947,7 @@ "name": "list", "description": "List dataset versions in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset versions list -F name -F dtModified\n```", "summary": "List dataset versions.", - "usage": " dataset versions list [arguments] [flags]", + "usage": " pspace dataset versions list [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5132,7 +5132,7 @@ "name": "update", "description": "Update a dataset version in a project or team.", "summary": "Update a dataset version", - "usage": " dataset versions update [arguments] [arguments] [flags]", + "usage": " pspace dataset versions update [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5289,7 +5289,7 @@ "name": "deployment", "description": "Effortlessly deploy ML apps to Paperspace.", "summary": "Effortlessly deploy ML apps to Paperspace.", - "usage": " deployment [command]\n deployment [flags]", + "usage": " pspace deployment [command]\n pspace deployment [flags]", "flags": [ { "name": "log-level", @@ -5367,7 +5367,7 @@ "name": "delete", "description": "Delete a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment delete 123e4567-e89b-12d3-a456-426614174000\n```", "summary": "Delete a deployment.", - "usage": " deployment delete [arguments] [flags]", + "usage": " pspace deployment delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5463,7 +5463,7 @@ "name": "get", "description": "Get a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000\n```\n\nPick a subset of fields to display:\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name\n```", "summary": "Get a deployment.", - "usage": " deployment get [arguments] [flags]", + "usage": " pspace deployment get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5575,7 +5575,7 @@ "name": "help", "description": "Show help for a deployment command", "summary": "Show help for a deployment command", - "usage": " deployment help [command]\n deployment help [arguments] [flags]", + "usage": " pspace deployment help [command]\n pspace deployment help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5675,9 +5675,9 @@ "commands": [ { "name": "commands", - "description": "List deployment commands\n\nExample:\n```\n$ deployment help commands commands\n```", + "description": "List deployment commands\n\nExample:\n```\n$ pspace deployment help commands commands\n```", "summary": "List deployment commands", - "usage": " deployment help commands [flags]", + "usage": " pspace deployment help commands [flags]", "flags": [ { "name": "log-level", @@ -5775,7 +5775,7 @@ "name": "list", "description": "List deployments in your team.\n\nPick a subset of fields to display:\n```\npspace deployment list -F id -F name\n```", "summary": "List deployments.", - "usage": " deployment list [flags]", + "usage": " pspace deployment list [flags]", "flags": [ { "name": "limit", @@ -5943,7 +5943,7 @@ "name": "up", "description": "This will create a new deployment for your app or update it if it already exists. \nYou can optionally specify a path to a config file. If no config file is specified, \nthe default config file paths will be tried.\n\nCreate a new deployment for the app in the current directory.\n```\n$ pspace deployment create\n```\n\nCreate a new deployment using a config file.\n```\n$ pspace deployment create -c paperspace.json\n```\n\nCreate a new deployment for an app in a different directory.\n```\n$ pspace deployment create --cwd ../my-app\n```\n\nCreate a new deployment for an app in a specific project.\n```\n$ pspace deployment create --project-id 1234\n```", "summary": "Create or update a deployment", - "usage": " deployment up [flags]", + "usage": " pspace deployment up [flags]", "flags": [ { "name": "config", @@ -6070,7 +6070,7 @@ "name": "docs", "description": "This command opens the Paperspace documentation in your browser.\nYou can optionally pass an argument that will take you to a specific \ndocs page.\n\nValid pages are:\n - `d`, `deployment`", "summary": "Open Paperspace documention in your default browser.", - "usage": " docs [arguments] [flags]", + "usage": " pspace docs [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6170,7 +6170,7 @@ "name": "help", "description": "Show help for a pspace command", "summary": "Show help for a pspace command", - "usage": " help [command]\n help [arguments] [flags]", + "usage": " pspace help [command]\n pspace help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6293,9 +6293,9 @@ "commands": [ { "name": "commands", - "description": "List pspace commands\n\nExample:\n```\n$ help commands commands\n```", + "description": "List pspace commands\n\nExample:\n```\n$ pspace help commands commands\n```", "summary": "List pspace commands", - "usage": " help commands [flags]", + "usage": " pspace help commands [flags]", "flags": [ { "name": "log-level", @@ -6393,7 +6393,7 @@ "name": "init", "description": "Create a new Paperspace app. This will create a new directory with a\ndefault app structure. You can optionally specify a name for the app\nand a template to use. If no template is specified, the default\ntemplate will be used.\n\nCreate a new app in the current directory.\n```\n$ pspace init\n```\n\nCreate a new app named \"my-app\" relative to the current directory.\n```\n$ pspace init my-app\n```\n\nCreate a new app named \"my-app\" relative to the current directory using\na template from the Paperspace GitHub organization.\n```\n$ pspace init my-app -t Paperspace/gradio-demo\n```", "summary": "Create a new Paperspace app", - "usage": " init [arguments] [flags]", + "usage": " pspace init [arguments] [flags]", "arguments": { "description": "", "summary": "The directory to create the app in. Defaults to the current directory.", @@ -6564,7 +6564,7 @@ "name": "login", "description": "Log in to the CLI using your Paperspace API key or by opening the web console.", "summary": "Log in to the CLI.", - "usage": " login [arguments] [flags]", + "usage": " pspace login [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6660,7 +6660,7 @@ "name": "logout", "description": "Log out of the CLI for the current team, a specific team, or all teams.", "summary": "Log out of the CLI.", - "usage": " logout [arguments...] [flags]", + "usage": " pspace logout [arguments...] [flags]", "arguments": { "description": "", "summary": "The teams to logout of.", @@ -6772,7 +6772,7 @@ "name": "machine", "description": "Manage your Paperspace machines.\n\nFor more information, see https://docs.paperspace.com/machines.", "summary": "Manage your Paperspace machines", - "usage": " machine [command]\n machine [flags]", + "usage": " pspace machine [command]\n pspace machine [flags]", "flags": [ { "name": "log-level", @@ -6850,7 +6850,7 @@ "name": "create", "description": "Create a machine.", "summary": "Create a machine", - "usage": " machine create [flags]", + "usage": " pspace machine create [flags]", "flags": [ { "name": "fields", @@ -7241,7 +7241,7 @@ "name": "delete", "description": "Delete a machine from a team.", "summary": "Delete a machine", - "usage": " machine delete [arguments] [flags]", + "usage": " pspace machine delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7353,7 +7353,7 @@ "name": "get", "description": "Get a machine from a team.", "summary": "Get a machine", - "usage": " machine get [arguments] [flags]", + "usage": " pspace machine get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7465,7 +7465,7 @@ "name": "help", "description": "Show help for a machine command", "summary": "Show help for a machine command", - "usage": " machine help [command]\n machine help [arguments] [flags]", + "usage": " pspace machine help [command]\n pspace machine help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7569,9 +7569,9 @@ "commands": [ { "name": "commands", - "description": "List machine commands\n\nExample:\n```\n$ machine help commands commands\n```", + "description": "List machine commands\n\nExample:\n```\n$ pspace machine help commands commands\n```", "summary": "List machine commands", - "usage": " machine help commands [flags]", + "usage": " pspace machine help commands [flags]", "flags": [ { "name": "log-level", @@ -7669,7 +7669,7 @@ "name": "list", "description": "List machines in your team.\n\nPick a subset of fields to display:\n```\npspace machine list -F name -F dtModified\n```", "summary": "List machines.", - "usage": " machine list [flags]", + "usage": " pspace machine list [flags]", "flags": [ { "name": "limit", @@ -7901,7 +7901,7 @@ "name": "restart", "description": "Restart a machine from a team.", "summary": "Restart a machine", - "usage": " machine restart [arguments] [flags]", + "usage": " pspace machine restart [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8013,7 +8013,7 @@ "name": "start", "description": "Start a machine from a team.", "summary": "Start a machine", - "usage": " machine start [arguments] [flags]", + "usage": " pspace machine start [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8125,7 +8125,7 @@ "name": "stop", "description": "Stop a machine from a team.", "summary": "Stop a machine", - "usage": " machine stop [arguments] [flags]", + "usage": " pspace machine stop [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8237,7 +8237,7 @@ "name": "update", "description": "Update a machine's settings.", "summary": "Update a machine", - "usage": " machine update [arguments] [flags]", + "usage": " pspace machine update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8549,7 +8549,7 @@ "name": "machine-event", "description": "Manage your machine events. Events are asynchronous tasks performed by our system on your machines.\nNot all machine commands are asynchronous. For those that are, a machine event will be returned\nwhich can be tracked using this command.\n\nFor more information, see https://docs.paperspace.com/machines.", "summary": "Manage your machine events", - "usage": " machine-event [command]\n machine-event [flags]", + "usage": " pspace machine-event [command]\n pspace machine-event [flags]", "flags": [ { "name": "log-level", @@ -8627,7 +8627,7 @@ "name": "get", "description": "Get a machine event from a team.", "summary": "Get a machine event", - "usage": " machine-event get [arguments] [flags]", + "usage": " pspace machine-event get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8739,7 +8739,7 @@ "name": "help", "description": "Show help for a machine-event command", "summary": "Show help for a machine-event command", - "usage": " machine-event help [command]\n machine-event help [arguments] [flags]", + "usage": " pspace machine-event help [command]\n pspace machine-event help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8837,9 +8837,9 @@ "commands": [ { "name": "commands", - "description": "List machine-event commands\n\nExample:\n```\n$ machine-event help commands commands\n```", + "description": "List machine-event commands\n\nExample:\n```\n$ pspace machine-event help commands commands\n```", "summary": "List machine-event commands", - "usage": " machine-event help commands [flags]", + "usage": " pspace machine-event help commands [flags]", "flags": [ { "name": "log-level", @@ -8937,7 +8937,7 @@ "name": "list", "description": "List machine events in your team.\n\nPick a subset of fields to display:\n```\npspace machine-event list -F name -F dtModified\n```", "summary": "List machine events.", - "usage": " machine-event list [flags]", + "usage": " pspace machine-event list [flags]", "flags": [ { "name": "limit", @@ -9123,7 +9123,7 @@ "name": "model", "description": "Manage your Paperspace models.\n\nFor more information, see https://docs.paperspace.com/deploying/models.", "summary": "Manage your Paperspace models", - "usage": " model [command]\n model [flags]", + "usage": " pspace model [command]\n pspace model [flags]", "flags": [ { "name": "log-level", @@ -9201,7 +9201,7 @@ "name": "create", "description": "Create a new model. This command will prompt you for a name if you don't\nprovide one.", "summary": "Create a new model", - "usage": " model create [flags]", + "usage": " pspace model create [flags]", "flags": [ { "name": "fields", @@ -9374,7 +9374,7 @@ "name": "delete", "description": "Delete a model from a team.", "summary": "Delete a model", - "usage": " model delete [arguments] [flags]", + "usage": " pspace model delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9486,7 +9486,7 @@ "name": "get", "description": "Get a model from a team.", "summary": "Get a model", - "usage": " model get [arguments] [flags]", + "usage": " pspace model get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9598,7 +9598,7 @@ "name": "help", "description": "Show help for a model command", "summary": "Show help for a model command", - "usage": " model help [command]\n model help [arguments] [flags]", + "usage": " pspace model help [command]\n pspace model help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9698,9 +9698,9 @@ "commands": [ { "name": "commands", - "description": "List model commands\n\nExample:\n```\n$ model help commands commands\n```", + "description": "List model commands\n\nExample:\n```\n$ pspace model help commands commands\n```", "summary": "List model commands", - "usage": " model help commands [flags]", + "usage": " pspace model help commands [flags]", "flags": [ { "name": "log-level", @@ -9798,7 +9798,7 @@ "name": "list", "description": "List models in your team.\n\nPick a subset of fields to display:\n```\npspace model list -F name -F dtModified\n```", "summary": "List models.", - "usage": " model list [flags]", + "usage": " pspace model list [flags]", "flags": [ { "name": "limit", @@ -9968,7 +9968,7 @@ "name": "os-template", "description": "List OS templates. OS templates are pre-configured virtual machines that\nyou can use to create a new machine.\n\nFor more information, see https://docs.paperspace.com/compute/os-templates.", "summary": "List OS templates", - "usage": " os-template [command]\n os-template [flags]", + "usage": " pspace os-template [command]\n pspace os-template [flags]", "flags": [ { "name": "log-level", @@ -10046,7 +10046,7 @@ "name": "help", "description": "Show help for a os-template command", "summary": "Show help for a os-template command", - "usage": " os-template help [command]\n os-template help [arguments] [flags]", + "usage": " pspace os-template help [command]\n pspace os-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10143,9 +10143,9 @@ "commands": [ { "name": "commands", - "description": "List os-template commands\n\nExample:\n```\n$ os-template help commands commands\n```", + "description": "List os-template commands\n\nExample:\n```\n$ pspace os-template help commands commands\n```", "summary": "List os-template commands", - "usage": " os-template help commands [flags]", + "usage": " pspace os-template help commands [flags]", "flags": [ { "name": "log-level", @@ -10243,7 +10243,7 @@ "name": "list", "description": "List OS templates.\n\nPick a subset of fields to display:\n```\npspace os-template list -F name\n```", "summary": "List OS templates.", - "usage": " os-template list [flags]", + "usage": " pspace os-template list [flags]", "flags": [ { "name": "limit", @@ -10429,7 +10429,7 @@ "name": "private-network", "description": "Manage your private networks. Private networks are logically isolated networks\nfor your machines and shared drives. They can also be used for site-to-site VPNs\nand direct connections to your on-premise network.\n\nFor more information, see https://docs.paperspace.com/networking/private-networks.", "summary": "Manage your private networks", - "usage": " private-network [command]\n private-network [flags]", + "usage": " pspace private-network [command]\n pspace private-network [flags]", "flags": [ { "name": "log-level", @@ -10507,7 +10507,7 @@ "name": "create", "description": "Create a private network.", "summary": "Create a private network", - "usage": " private-network create [flags]", + "usage": " pspace private-network create [flags]", "flags": [ { "name": "fields", @@ -10632,7 +10632,7 @@ "name": "delete", "description": "Delete a private network from a team.", "summary": "Delete a private network", - "usage": " private-network delete [arguments] [flags]", + "usage": " pspace private-network delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10744,7 +10744,7 @@ "name": "get", "description": "Get a private network from a team.", "summary": "Get a private network", - "usage": " private-network get [arguments] [flags]", + "usage": " pspace private-network get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10856,7 +10856,7 @@ "name": "help", "description": "Show help for a private-network command", "summary": "Show help for a private-network command", - "usage": " private-network help [command]\n private-network help [arguments] [flags]", + "usage": " pspace private-network help [command]\n pspace private-network help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10956,9 +10956,9 @@ "commands": [ { "name": "commands", - "description": "List private-network commands\n\nExample:\n```\n$ private-network help commands commands\n```", + "description": "List private-network commands\n\nExample:\n```\n$ pspace private-network help commands commands\n```", "summary": "List private-network commands", - "usage": " private-network help commands [flags]", + "usage": " pspace private-network help commands [flags]", "flags": [ { "name": "log-level", @@ -11056,7 +11056,7 @@ "name": "list", "description": "List private networks in your team.\n\nPick a subset of fields to display:\n```\npspace private-network list -F name -F dtModified\n```", "summary": "List private networks.", - "usage": " private-network list [flags]", + "usage": " pspace private-network list [flags]", "flags": [ { "name": "limit", @@ -11258,7 +11258,7 @@ "name": "project", "description": "Manage your Paperspace projects.", "summary": "Manage your Paperspace projects.", - "usage": " project [command]\n project [flags]", + "usage": " pspace project [command]\n pspace project [flags]", "flags": [ { "name": "log-level", @@ -11336,7 +11336,7 @@ "name": "create", "description": "Create a new project. This command will prompt you for a name if you don't\nprovide one.", "summary": "Create a new project", - "usage": " project create [arguments] [flags]", + "usage": " pspace project create [arguments] [flags]", "arguments": { "description": "", "summary": "Create a project with these properties.", @@ -11449,7 +11449,7 @@ "name": "delete", "description": "Delete a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", "summary": "Delete a project.", - "usage": " project delete [arguments] [flags]", + "usage": " pspace project delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11561,7 +11561,7 @@ "name": "get", "description": "Get a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", "summary": "Get a project.", - "usage": " project get [arguments] [flags]", + "usage": " pspace project get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11673,7 +11673,7 @@ "name": "help", "description": "Show help for a project command", "summary": "Show help for a project command", - "usage": " project help [command]\n project help [arguments] [flags]", + "usage": " pspace project help [command]\n pspace project help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11775,9 +11775,9 @@ "commands": [ { "name": "commands", - "description": "List project commands\n\nExample:\n```\n$ project help commands commands\n```", + "description": "List project commands\n\nExample:\n```\n$ pspace project help commands commands\n```", "summary": "List project commands", - "usage": " project help commands [flags]", + "usage": " pspace project help commands [flags]", "flags": [ { "name": "log-level", @@ -11875,7 +11875,7 @@ "name": "link", "description": "This will link a remote project to a local directory. Commands that\ndepend on a project ID will use the project ID of the linked project\nwhen communicating with the Paperspace API.\n\nLink a project to the current directory.\n```\n$ pspace link\n```\n\nLink a project to a different directory.\n```\n$ pspace link --cwd ../my-app\n```\n\nLink a project and specify a project ID.\n```\n$ pspace link pzwf2g05ubegj\n```", "summary": "Link a remote project to ", - "usage": " project link [arguments] [flags]", + "usage": " pspace project link [arguments] [flags]", "arguments": { "description": "", "summary": "A project ID. If not provided, you will be prompted to select one.", @@ -11985,7 +11985,7 @@ "name": "list", "description": "List projects in your team.\n\nPick a subset of fields to display:\n```\npspace project list -F id -F name -F dtCreated\n```", "summary": "List projects.", - "usage": " project list [flags]", + "usage": " pspace project list [flags]", "flags": [ { "name": "limit", @@ -12283,7 +12283,7 @@ "name": "public-ip", "description": "Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet.\n\nFor more information, see https://docs.paperspace.com/networking/public-ips.", "summary": "Manage your public IPs", - "usage": " public-ip [command]\n public-ip [flags]", + "usage": " pspace public-ip [command]\n pspace public-ip [flags]", "flags": [ { "name": "log-level", @@ -12361,7 +12361,7 @@ "name": "assign", "description": "Assign a public IP to a machine.", "summary": "Assign a public IP", - "usage": " public-ip assign [arguments] [flags]", + "usage": " pspace public-ip assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12492,7 +12492,7 @@ "name": "claim", "description": "Claim a public IP for a team.", "summary": "Claim a public IP", - "usage": " public-ip claim [flags]", + "usage": " pspace public-ip claim [flags]", "flags": [ { "name": "fields", @@ -12603,7 +12603,7 @@ "name": "help", "description": "Show help for a public-ip command", "summary": "Show help for a public-ip command", - "usage": " public-ip help [command]\n public-ip help [arguments] [flags]", + "usage": " pspace public-ip help [command]\n pspace public-ip help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12703,9 +12703,9 @@ "commands": [ { "name": "commands", - "description": "List public-ip commands\n\nExample:\n```\n$ public-ip help commands commands\n```", + "description": "List public-ip commands\n\nExample:\n```\n$ pspace public-ip help commands commands\n```", "summary": "List public-ip commands", - "usage": " public-ip help commands [flags]", + "usage": " pspace public-ip help commands [flags]", "flags": [ { "name": "log-level", @@ -12803,7 +12803,7 @@ "name": "list", "description": "List public IPs in your team or project.\n\nPick a subset of fields to display:\n```\npspace public-ip list -F name -F dtModified\n```", "summary": "List public IPs.", - "usage": " public-ip list [flags]", + "usage": " pspace public-ip list [flags]", "flags": [ { "name": "limit", @@ -12987,7 +12987,7 @@ "name": "release", "description": "Release a public IP from a team. This will unassign it from its assigned machine, if any.", "summary": "Release a public IP", - "usage": " public-ip release [arguments] [flags]", + "usage": " pspace public-ip release [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -13101,7 +13101,7 @@ "name": "secret", "description": "Manage your Paperspace secrets. Secrets are used to store sensitive\ninformation such as API keys, passwords, and other credentials. Secrets \ncan be safely injected into workloads as environment variables. An environment \nvariable that uses a Secret will not reveal the contents of the secret itself.\n\nSecrets can be created at the following levels:\n\n- Project (default): these secrets are applied to all resources in a project\n- Global: these secrets can be applied to all resources on your current team\n\nFor more information, see https://docs.paperspace.com/secrets.", "summary": "Manage your Paperspace secrets", - "usage": " secret [command]\n secret [flags]", + "usage": " pspace secret [command]\n pspace secret [flags]", "flags": [ { "name": "log-level", @@ -13179,7 +13179,7 @@ "name": "create", "description": "Create a secret in a project or team.", "summary": "Create a secret", - "usage": " secret create [arguments] [arguments] [flags]", + "usage": " pspace secret create [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -13337,7 +13337,7 @@ "name": "delete", "description": "Delete a secret from a project or team.", "summary": "Delete a secret", - "usage": " secret delete [arguments] [flags]", + "usage": " pspace secret delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -13482,7 +13482,7 @@ "name": "get", "description": "Get a secret from a project or team.", "summary": "Get a secret", - "usage": " secret get [arguments] [flags]", + "usage": " pspace secret get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -13643,7 +13643,7 @@ "name": "help", "description": "Show help for a secret command", "summary": "Show help for a secret command", - "usage": " secret help [command]\n secret help [arguments] [flags]", + "usage": " pspace secret help [command]\n pspace secret help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -13744,9 +13744,9 @@ "commands": [ { "name": "commands", - "description": "List secret commands\n\nExample:\n```\n$ secret help commands commands\n```", + "description": "List secret commands\n\nExample:\n```\n$ pspace secret help commands commands\n```", "summary": "List secret commands", - "usage": " secret help commands [flags]", + "usage": " pspace secret help commands [flags]", "flags": [ { "name": "log-level", @@ -13844,7 +13844,7 @@ "name": "list", "description": "List secrets in your team or project.\n\nPick a subset of fields to display:\n```\npspace secret list -F name -F dtModified\n```", "summary": "List secrets.", - "usage": " secret list [flags]", + "usage": " pspace secret list [flags]", "flags": [ { "name": "limit", @@ -14058,7 +14058,7 @@ "name": "update", "description": "Update a secret in a project or team.", "summary": "Update a secret", - "usage": " secret update [arguments] [arguments] [flags]", + "usage": " pspace secret update [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -14218,7 +14218,7 @@ "name": "shared-drive", "description": "Manage your shared drives. Shared drives are used to centralize data\nused by your team. Shared drives can be mounted on any Paperspace machine\nin the same private network.\n\nFor more information, see https://docs.paperspace.com/storage/shared-drives.", "summary": "Manage your shared drives", - "usage": " shared-drive [command]\n shared-drive [flags]", + "usage": " pspace shared-drive [command]\n pspace shared-drive [flags]", "flags": [ { "name": "log-level", @@ -14296,7 +14296,7 @@ "name": "create", "description": "Create a shared drive.", "summary": "Create a shared drive", - "usage": " shared-drive create [flags]", + "usage": " pspace shared-drive create [flags]", "flags": [ { "name": "fields", @@ -14449,7 +14449,7 @@ "name": "delete", "description": "Delete a shared drive from a team.", "summary": "Delete a shared drive", - "usage": " shared-drive delete [arguments] [flags]", + "usage": " pspace shared-drive delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -14561,7 +14561,7 @@ "name": "get", "description": "Get a shared drive from a team.", "summary": "Get a shared drive", - "usage": " shared-drive get [arguments] [flags]", + "usage": " pspace shared-drive get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -14673,7 +14673,7 @@ "name": "help", "description": "Show help for a shared-drive command", "summary": "Show help for a shared-drive command", - "usage": " shared-drive help [command]\n shared-drive help [arguments] [flags]", + "usage": " pspace shared-drive help [command]\n pspace shared-drive help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -14773,9 +14773,9 @@ "commands": [ { "name": "commands", - "description": "List shared-drive commands\n\nExample:\n```\n$ shared-drive help commands commands\n```", + "description": "List shared-drive commands\n\nExample:\n```\n$ pspace shared-drive help commands commands\n```", "summary": "List shared-drive commands", - "usage": " shared-drive help commands [flags]", + "usage": " pspace shared-drive help commands [flags]", "flags": [ { "name": "log-level", @@ -14873,7 +14873,7 @@ "name": "list", "description": "List shared drives in your team or project.\n\nPick a subset of fields to display:\n```\npspace shared-drive list -F name -F dtModified\n```", "summary": "List shared drives.", - "usage": " shared-drive list [flags]", + "usage": " pspace shared-drive list [flags]", "flags": [ { "name": "limit", @@ -15075,7 +15075,7 @@ "name": "signup", "description": "This command opens the Paperspace signup page in your browser.", "summary": "Sign up for a Paperspace account.", - "usage": " signup [flags]", + "usage": " pspace signup [flags]", "flags": [ { "name": "log-level", @@ -15154,7 +15154,7 @@ "name": "snapshot", "description": "Manage your snapshots. Snapshots are copies of your machine's disk at a point in time.\nThey can be used to restore the machine to its previous state. Using snapshots is recommended\nbefore taking any action that could affect the usability of the machine or its network connection.\n\nFor more information, see https://docs.paperspace.com/storage/snapshots.", "summary": "Manage your snapshots", - "usage": " snapshot [command]\n snapshot [flags]", + "usage": " pspace snapshot [command]\n pspace snapshot [flags]", "flags": [ { "name": "log-level", @@ -15232,7 +15232,7 @@ "name": "create", "description": "Create a snapshot from a machine.", "summary": "Create a snapshot", - "usage": " snapshot create [flags]", + "usage": " pspace snapshot create [flags]", "flags": [ { "name": "fields", @@ -15359,7 +15359,7 @@ "name": "delete", "description": "Delete a snapshot from a team.", "summary": "Delete a snapshot", - "usage": " snapshot delete [arguments] [flags]", + "usage": " pspace snapshot delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -15471,7 +15471,7 @@ "name": "help", "description": "Show help for a snapshot command", "summary": "Show help for a snapshot command", - "usage": " snapshot help [command]\n snapshot help [arguments] [flags]", + "usage": " pspace snapshot help [command]\n pspace snapshot help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -15571,9 +15571,9 @@ "commands": [ { "name": "commands", - "description": "List snapshot commands\n\nExample:\n```\n$ snapshot help commands commands\n```", + "description": "List snapshot commands\n\nExample:\n```\n$ pspace snapshot help commands commands\n```", "summary": "List snapshot commands", - "usage": " snapshot help commands [flags]", + "usage": " pspace snapshot help commands [flags]", "flags": [ { "name": "log-level", @@ -15671,7 +15671,7 @@ "name": "list", "description": "List snapshots in your team.\n\nPick a subset of fields to display:\n```\npspace snapshot list -F name -F dtModified\n```", "summary": "List snapshots.", - "usage": " snapshot list [flags]", + "usage": " pspace snapshot list [flags]", "flags": [ { "name": "limit", @@ -15855,7 +15855,7 @@ "name": "restore", "description": "Restore a machine to a snapshot.", "summary": "Restore a snapshot", - "usage": " snapshot restore [arguments] [flags]", + "usage": " pspace snapshot restore [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -15983,7 +15983,7 @@ "name": "startup-script", "description": "Manage your startup scripts. Startup scripts allow you to configure a machine\non first boot or on every boot.", "summary": "Manage your startup scripts", - "usage": " startup-script [command]\n startup-script [flags]", + "usage": " pspace startup-script [command]\n pspace startup-script [flags]", "flags": [ { "name": "log-level", @@ -16061,7 +16061,7 @@ "name": "assign", "description": "Assign a startup script to a machine.", "summary": "Assign a startup script", - "usage": " startup-script assign [arguments] [flags]", + "usage": " pspace startup-script assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -16187,7 +16187,7 @@ "name": "create", "description": "Create a startup script.", "summary": "Create a startup script", - "usage": " startup-script create [flags]", + "usage": " pspace startup-script create [flags]", "flags": [ { "name": "fields", @@ -16326,7 +16326,7 @@ "name": "delete", "description": "Delete a startup script from a team.", "summary": "Delete a startup script", - "usage": " startup-script delete [arguments] [flags]", + "usage": " pspace startup-script delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -16438,7 +16438,7 @@ "name": "get", "description": "Get a startup script from a team.", "summary": "Get a startup script", - "usage": " startup-script get [arguments] [flags]", + "usage": " pspace startup-script get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -16550,7 +16550,7 @@ "name": "help", "description": "Show help for a startup-script command", "summary": "Show help for a startup-script command", - "usage": " startup-script help [command]\n startup-script help [arguments] [flags]", + "usage": " pspace startup-script help [command]\n pspace startup-script help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -16653,9 +16653,9 @@ "commands": [ { "name": "commands", - "description": "List startup-script commands\n\nExample:\n```\n$ startup-script help commands commands\n```", + "description": "List startup-script commands\n\nExample:\n```\n$ pspace startup-script help commands commands\n```", "summary": "List startup-script commands", - "usage": " startup-script help commands [flags]", + "usage": " pspace startup-script help commands [flags]", "flags": [ { "name": "log-level", @@ -16753,7 +16753,7 @@ "name": "list", "description": "List startup scripts in your team.\n\nPick a subset of fields to display:\n```\npspace startup-script list -F name -F dtCreated\n```", "summary": "List startup scripts.", - "usage": " startup-script list [flags]", + "usage": " pspace startup-script list [flags]", "flags": [ { "name": "limit", @@ -16937,7 +16937,7 @@ "name": "unassign", "description": "Unassign a startup script from a machine.", "summary": "Unassign a startup script", - "usage": " startup-script unassign [arguments] [flags]", + "usage": " pspace startup-script unassign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -17063,7 +17063,7 @@ "name": "update", "description": "Update a startup script.", "summary": "Update a startup script", - "usage": " startup-script update [arguments] [flags]", + "usage": " pspace startup-script update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -17235,7 +17235,7 @@ "name": "storage-provider", "description": "Manage your storage providers.\n\nFor more information, see https://docs.paperspace.com/storage/storageProviders.", "summary": "Manage your storage providers", - "usage": " storage-provider [command]\n storage-provider [flags]", + "usage": " pspace storage-provider [command]\n pspace storage-provider [flags]", "flags": [ { "name": "log-level", @@ -17313,7 +17313,7 @@ "name": "create", "description": "Create a storage provider.", "summary": "Create a storage provider", - "usage": " storage-provider create [command]\n storage-provider create [flags]", + "usage": " pspace storage-provider create [command]\n pspace storage-provider create [flags]", "flags": [ { "name": "log-level", @@ -17391,7 +17391,7 @@ "name": "help", "description": "Show help for a create command", "summary": "Show help for a create command", - "usage": " storage-provider create help [command]\n storage-provider create help [arguments] [flags]", + "usage": " pspace storage-provider create help [command]\n pspace storage-provider create help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -17488,9 +17488,9 @@ "commands": [ { "name": "commands", - "description": "List create commands\n\nExample:\n```\n$ storage-provider create help commands commands\n```", + "description": "List create commands\n\nExample:\n```\n$ pspace storage-provider create help commands commands\n```", "summary": "List create commands", - "usage": " storage-provider create help commands [flags]", + "usage": " pspace storage-provider create help commands [flags]", "flags": [ { "name": "log-level", @@ -17588,7 +17588,7 @@ "name": "s3", "description": "Create an S3 storage provider.", "summary": "Create an S3 storage provider", - "usage": " storage-provider create s3 [flags]", + "usage": " pspace storage-provider create s3 [flags]", "flags": [ { "name": "fields", @@ -17813,7 +17813,7 @@ "name": "delete", "description": "Delete a storage provider from a team.", "summary": "Delete a storage provider", - "usage": " storage-provider delete [arguments] [flags]", + "usage": " pspace storage-provider delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -17925,7 +17925,7 @@ "name": "get", "description": "Get a storage provider from a team.", "summary": "Get a storage provider", - "usage": " storage-provider get [arguments] [flags]", + "usage": " pspace storage-provider get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -18037,7 +18037,7 @@ "name": "help", "description": "Show help for a storage-provider command", "summary": "Show help for a storage-provider command", - "usage": " storage-provider help [command]\n storage-provider help [arguments] [flags]", + "usage": " pspace storage-provider help [command]\n pspace storage-provider help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -18138,9 +18138,9 @@ "commands": [ { "name": "commands", - "description": "List storage-provider commands\n\nExample:\n```\n$ storage-provider help commands commands\n```", + "description": "List storage-provider commands\n\nExample:\n```\n$ pspace storage-provider help commands commands\n```", "summary": "List storage-provider commands", - "usage": " storage-provider help commands [flags]", + "usage": " pspace storage-provider help commands [flags]", "flags": [ { "name": "log-level", @@ -18238,7 +18238,7 @@ "name": "list", "description": "List storage providers in your team or project.\n\nPick a subset of fields to display:\n```\npspace storage provider list -F name -F dtModified\n```", "summary": "List storage providers.", - "usage": " storage-provider list [flags]", + "usage": " pspace storage-provider list [flags]", "flags": [ { "name": "limit", @@ -18406,7 +18406,7 @@ "name": "update", "description": "Update a storage provider.", "summary": "Update a storage provider", - "usage": " storage-provider update [command]\n storage-provider update [flags]", + "usage": " pspace storage-provider update [command]\n pspace storage-provider update [flags]", "flags": [ { "name": "log-level", @@ -18484,7 +18484,7 @@ "name": "help", "description": "Show help for a update command", "summary": "Show help for a update command", - "usage": " storage-provider update help [command]\n storage-provider update help [arguments] [flags]", + "usage": " pspace storage-provider update help [command]\n pspace storage-provider update help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -18581,9 +18581,9 @@ "commands": [ { "name": "commands", - "description": "List update commands\n\nExample:\n```\n$ storage-provider update help commands commands\n```", + "description": "List update commands\n\nExample:\n```\n$ pspace storage-provider update help commands commands\n```", "summary": "List update commands", - "usage": " storage-provider update help commands [flags]", + "usage": " pspace storage-provider update help commands [flags]", "flags": [ { "name": "log-level", @@ -18681,7 +18681,7 @@ "name": "s3", "description": "Update an S3 storage provider in a project or team.", "summary": "Update an S3 storage provider", - "usage": " storage-provider update s3 [arguments] [flags]", + "usage": " pspace storage-provider update s3 [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -18925,7 +18925,7 @@ "name": "up", "description": "This will upsert an app config and deploy your app to Paperspace. You can optionally \nspecify a path to a config file. If no config file is specified, the default\nconfig file paths will be tried.\n\nDeploy the app in the current directory.\n```\n$ pspace up\n```\n\nDeploy the app using a config file.\n```\n$ pspace up -c paperspace.json\n```\n\nDeploy an app in a different directory.\n```\n$ pspace up --cwd ../my-app\n```", "summary": "Deploy your app to Paperspace", - "usage": " up [flags]", + "usage": " pspace up [flags]", "flags": [ { "name": "config", @@ -19050,7 +19050,7 @@ "name": "upgrade", "description": "This command upgrades \u001b[1mpspace\u001b[22m to the latest version.\n\nIf you used a package manager like `brew` to install `pspace`, \nyou should use that to upgrade in order to avoid potential permissions \nissues. For example, for `brew` you can upgrade by running:\n```\nbrew upgrade pspace\n```\n\nIf you installed `pspace` using the install script, you can upgrade by\nrunning:\n```\npspace upgrade\n```", "summary": "Upgrade \u001b[1mpspace\u001b[22m to the latest version.", - "usage": " upgrade [flags]", + "usage": " pspace upgrade [flags]", "flags": [ { "name": "log-level", @@ -19129,7 +19129,7 @@ "name": "version", "description": "Shows version information command, including version number and build date.", "summary": "Show version information", - "usage": " version [flags]", + "usage": " pspace version [flags]", "flags": [ { "name": "log-level", diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md index 1d8c744..ec680e8 100644 --- a/.assets/pspace/autoscaling-group.md +++ b/.assets/pspace/autoscaling-group.md @@ -7,8 +7,8 @@ groups as a primitive for your own autoscaler. ### Usage ``` -autoscaling-group [command] -autoscaling-group [flags] +pspace autoscaling-group [command] +pspace autoscaling-group [flags] ``` ### Flags @@ -36,7 +36,7 @@ Create an autoscaling group. ### Usage ``` -autoscaling-group create [flags] +pspace autoscaling-group create [flags] ``` ### Flags @@ -67,7 +67,7 @@ Delete an autoscaling group from a team. ### Usage ``` -autoscaling-group delete [arguments] [flags] +pspace autoscaling-group delete [arguments] [flags] ``` ### Flags @@ -89,7 +89,7 @@ Get an autoscaling group from a team. ### Usage ``` -autoscaling-group get [arguments] [flags] +pspace autoscaling-group get [arguments] [flags] ``` ### Flags @@ -111,8 +111,8 @@ Show help for a autoscaling-group command ### Usage ``` -autoscaling-group help [command] -autoscaling-group help [arguments] [flags] +pspace autoscaling-group help [command] +pspace autoscaling-group help [arguments] [flags] ``` ### Flags @@ -128,34 +128,6 @@ autoscaling-group help [arguments] [flags] - [commands](#commands) -## pspace autoscaling-group help commands - -List autoscaling-group commands - -Example: - -``` -$ autoscaling-group help commands commands -``` - -### Usage - -``` -autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace autoscaling-group list List autoscaling groups in your team. @@ -169,7 +141,7 @@ pspace autoscaling-group list -F name -F dtCreated ### Usage ``` -autoscaling-group list [flags] +pspace autoscaling-group list [flags] ``` ### Flags @@ -198,7 +170,7 @@ Update an autoscaling group. ### Usage ``` -autoscaling-group update [arguments] [flags] +pspace autoscaling-group update [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md index 219c5ab..f4f6911 100644 --- a/.assets/pspace/completion.md +++ b/.assets/pspace/completion.md @@ -6,8 +6,8 @@ sub-command's help for details on how to use the generated script. ### Usage ``` -completion [command] -completion [flags] +pspace completion [command] +pspace completion [flags] ``` ### Flags @@ -36,7 +36,7 @@ already, you can install it via your OS's package manager. To load completions in your current shell session: ``` -$ source <(completion bash bash) +$ source <(pspace completion bash bash) ``` To load completions for every new session, execute once: @@ -44,13 +44,13 @@ To load completions for every new session, execute once: Linux: ``` -$ completion bash bash > /etc/bash_completion.d/pspace +$ pspace completion bash bash > /etc/bash_completion.d/pspace ``` macOS: ``` -$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace ``` You will need to start a new shell for this setup to take effect. @@ -58,7 +58,7 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` -completion bash [flags] +pspace completion bash [flags] ``` ### Flags @@ -79,13 +79,13 @@ Generate the autocompletion script for the fish shell. To load completions in your current shell session: ``` -$ completion fish fish | source +$ pspace completion fish fish | source ``` To load completions for every new session, execute once: ``` -$ completion fish fish > ~/.config/fish/completions/pspace.fish +$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish ``` You will need to start a new shell for this setup to take effect. @@ -93,7 +93,7 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` -completion fish [flags] +pspace completion fish [flags] ``` ### Flags @@ -115,8 +115,8 @@ Show help for a completion command ### Usage ``` -completion help [command] -completion help [arguments] [flags] +pspace completion help [command] +pspace completion help [arguments] [flags] ``` ### Flags @@ -132,34 +132,6 @@ completion help [arguments] [flags] - [commands](#commands) -## pspace completion help commands - -List completion commands - -Example: - -``` -$ completion help commands commands -``` - -### Usage - -``` -completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace completion zsh Generate the autocompletion script for the zsh shell. @@ -176,19 +148,19 @@ To load completions for every new session, execute once: Linux: ``` -$ completion zsh zsh > "${fpath[1]}/_pspace" +$ pspace completion zsh zsh > "${fpath[1]}/_pspace" ``` macOS: ``` -$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace ``` Oh My Zsh: ``` -$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace ``` You will need to start a new shell for this setup to take effect. @@ -196,7 +168,7 @@ You will need to start a new shell for this setup to take effect. ### Usage ``` -completion zsh [flags] +pspace completion zsh [flags] ``` ### Flags diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md index fd1d6d8..09ff3b0 100644 --- a/.assets/pspace/config.md +++ b/.assets/pspace/config.md @@ -15,8 +15,8 @@ pspace config set team "my-team" ### Usage ``` -config [command] -config [flags] +pspace config [command] +pspace config [flags] ``` ### Flags @@ -42,7 +42,7 @@ Delete a configuration value. ### Usage ``` -config delete [flags] +pspace config delete [flags] ``` ### Flags @@ -70,7 +70,7 @@ pspace config get team ### Usage ``` -config get [arguments] [flags] +pspace config get [arguments] [flags] ``` ### Flags @@ -91,8 +91,8 @@ Show help for a config command ### Usage ``` -config help [command] -config help [arguments] [flags] +pspace config help [command] +pspace config help [arguments] [flags] ``` ### Flags @@ -108,34 +108,6 @@ config help [arguments] [flags] - [commands](#commands) -## pspace config help commands - -List config commands - -Example: - -``` -$ config help commands commands -``` - -### Usage - -``` -config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace config set Set a configuration value. @@ -143,7 +115,7 @@ Set a configuration value. ### Usage ``` -config set [arguments] [arguments...] [flags] +pspace config set [arguments] [arguments...] [flags] ``` ### Flags diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md index 13de327..1034deb 100644 --- a/.assets/pspace/console.md +++ b/.assets/pspace/console.md @@ -5,7 +5,7 @@ This command opens the Paperspace web console in your browser. ### Usage ``` -console [flags] +pspace console [flags] ``` ### Flags diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md index 07bf1d3..8af51ca 100644 --- a/.assets/pspace/custom-template.md +++ b/.assets/pspace/custom-template.md @@ -9,8 +9,8 @@ For more information, see https://docs.paperspace.com/compute/custom-templates. ### Usage ``` -custom-template [command] -custom-template [flags] +pspace custom-template [command] +pspace custom-template [flags] ``` ### Flags @@ -37,7 +37,7 @@ Create a custom template from a machine. ### Usage ``` -custom-template create [flags] +pspace custom-template create [flags] ``` ### Flags @@ -61,7 +61,7 @@ Delete a custom template from a team. ### Usage ``` -custom-template delete [arguments] [flags] +pspace custom-template delete [arguments] [flags] ``` ### Flags @@ -83,7 +83,7 @@ Get a custom template from a team. ### Usage ``` -custom-template get [arguments] [flags] +pspace custom-template get [arguments] [flags] ``` ### Flags @@ -105,8 +105,8 @@ Show help for a custom-template command ### Usage ``` -custom-template help [command] -custom-template help [arguments] [flags] +pspace custom-template help [command] +pspace custom-template help [arguments] [flags] ``` ### Flags @@ -122,34 +122,6 @@ custom-template help [arguments] [flags] - [commands](#commands) -## pspace custom-template help commands - -List custom-template commands - -Example: - -``` -$ custom-template help commands commands -``` - -### Usage - -``` -custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace custom-template list List custom templates in your team. @@ -163,7 +135,7 @@ pspace custom-template list -F name -F dtModified ### Usage ``` -custom-template list [flags] +pspace custom-template list [flags] ``` ### Flags diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md index a9cee69..c6fd0e6 100644 --- a/.assets/pspace/dataset.md +++ b/.assets/pspace/dataset.md @@ -7,8 +7,8 @@ For more information, see https://docs.paperspace.com/storage/datasets. ### Usage ``` -dataset [command] -dataset [flags] +pspace dataset [command] +pspace dataset [flags] ``` ### Flags @@ -37,7 +37,7 @@ Create a dataset. ### Usage ``` -dataset create [flags] +pspace dataset create [flags] ``` ### Flags @@ -63,7 +63,7 @@ Delete a dataset from a team. ### Usage ``` -dataset delete [arguments] [flags] +pspace dataset delete [arguments] [flags] ``` ### Flags @@ -85,7 +85,7 @@ Get a dataset from a team. ### Usage ``` -dataset get [arguments] [flags] +pspace dataset get [arguments] [flags] ``` ### Flags @@ -107,8 +107,8 @@ Show help for a dataset command ### Usage ``` -dataset help [command] -dataset help [arguments] [flags] +pspace dataset help [command] +pspace dataset help [arguments] [flags] ``` ### Flags @@ -124,34 +124,6 @@ dataset help [arguments] [flags] - [commands](#commands) -## pspace dataset help commands - -List dataset commands - -Example: - -``` -$ dataset help commands commands -``` - -### Usage - -``` -dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace dataset list List datasets in your team or project. @@ -165,7 +137,7 @@ pspace dataset list -F name -F dtModified ### Usage ``` -dataset list [flags] +pspace dataset list [flags] ``` ### Flags @@ -192,7 +164,7 @@ Update a dataset in a project or team. ### Usage ``` -dataset update [arguments] [flags] +pspace dataset update [arguments] [flags] ``` ### Flags @@ -218,8 +190,8 @@ For more information, see https://docs.paperspace.com/storage/datasetVersions. ### Usage ``` -dataset versions [command] -dataset versions [flags] +pspace dataset versions [command] +pspace dataset versions [flags] ``` ### Flags @@ -239,182 +211,3 @@ dataset versions [flags] - [help](#help) - [list](#list) - [update](#update) - -## pspace dataset versions create - -Create a dataset version. This command will prompt you for an ID if you don't -provide one. - -### Usage - -``` -dataset versions create [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions delete - -Delete a dataset version from a team. This command will prompt you for an ID if -you don't provide one. - -### Usage - -``` -dataset versions delete [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions get - -Get a dataset version from a team. This command will prompt you for an ID if you -don't provide one. - -### Usage - -``` -dataset versions get [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions help - -Show help for a versions command - -### Usage - -``` -dataset versions help [command] -dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace dataset versions help commands - -List versions commands - -Example: - -``` -$ dataset versions help commands commands -``` - -### Usage - -``` -dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace dataset versions list - -List dataset versions in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset versions list -F name -F dtModified -``` - -### Usage - -``` -dataset versions list [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions update - -Update a dataset version in a project or team. - -### Usage - -``` -dataset versions update [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md index acef561..c5c3f2d 100644 --- a/.assets/pspace/deployment.md +++ b/.assets/pspace/deployment.md @@ -5,8 +5,8 @@ Effortlessly deploy ML apps to Paperspace. ### Usage ``` -deployment [command] -deployment [flags] +pspace deployment [command] +pspace deployment [flags] ``` ### Flags @@ -38,7 +38,7 @@ pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 ### Usage ``` -deployment delete [arguments] [flags] +pspace deployment delete [arguments] [flags] ``` ### Flags @@ -70,7 +70,7 @@ pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name ### Usage ``` -deployment get [arguments] [flags] +pspace deployment get [arguments] [flags] ``` ### Flags @@ -92,8 +92,8 @@ Show help for a deployment command ### Usage ``` -deployment help [command] -deployment help [arguments] [flags] +pspace deployment help [command] +pspace deployment help [arguments] [flags] ``` ### Flags @@ -109,34 +109,6 @@ deployment help [arguments] [flags] - [commands](#commands) -## pspace deployment help commands - -List deployment commands - -Example: - -``` -$ deployment help commands commands -``` - -### Usage - -``` -deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace deployment list List deployments in your team. @@ -150,7 +122,7 @@ pspace deployment list -F id -F name ### Usage ``` -deployment list [flags] +pspace deployment list [flags] ``` ### Flags @@ -203,7 +175,7 @@ $ pspace deployment create --project-id 1234 ### Usage ``` -deployment up [flags] +pspace deployment up [flags] ``` ### Flags diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md index 6dd0d89..a2888bd 100644 --- a/.assets/pspace/docs.md +++ b/.assets/pspace/docs.md @@ -10,7 +10,7 @@ Valid pages are: ### Usage ``` -docs [arguments] [flags] +pspace docs [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md index ffc8781..53fe651 100644 --- a/.assets/pspace/help.md +++ b/.assets/pspace/help.md @@ -5,8 +5,8 @@ Show help for a pspace command ### Usage ``` -help [command] -help [arguments] [flags] +pspace help [command] +pspace help [arguments] [flags] ``` ### Flags @@ -29,13 +29,13 @@ List pspace commands Example: ``` -$ help commands commands +$ pspace help commands commands ``` ### Usage ``` -help commands [flags] +pspace help commands [flags] ``` ### Flags diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md index 339d380..3347799 100644 --- a/.assets/pspace/init.md +++ b/.assets/pspace/init.md @@ -26,7 +26,7 @@ $ pspace init my-app -t Paperspace/gradio-demo ### Usage ``` -init [arguments] [flags] +pspace init [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md index 13a47a1..41e5a58 100644 --- a/.assets/pspace/login.md +++ b/.assets/pspace/login.md @@ -5,7 +5,7 @@ Log in to the CLI using your Paperspace API key or by opening the web console. ### Usage ``` -login [arguments] [flags] +pspace login [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md index 3503b5c..a9fae65 100644 --- a/.assets/pspace/logout.md +++ b/.assets/pspace/logout.md @@ -5,7 +5,7 @@ Log out of the CLI for the current team, a specific team, or all teams. ### Usage ``` -logout [arguments...] [flags] +pspace logout [arguments...] [flags] ``` ### Flags diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md index e11e37b..019eecf 100644 --- a/.assets/pspace/machine-event.md +++ b/.assets/pspace/machine-event.md @@ -10,8 +10,8 @@ For more information, see https://docs.paperspace.com/machines. ### Usage ``` -machine-event [command] -machine-event [flags] +pspace machine-event [command] +pspace machine-event [flags] ``` ### Flags @@ -36,7 +36,7 @@ Get a machine event from a team. ### Usage ``` -machine-event get [arguments] [flags] +pspace machine-event get [arguments] [flags] ``` ### Flags @@ -58,8 +58,8 @@ Show help for a machine-event command ### Usage ``` -machine-event help [command] -machine-event help [arguments] [flags] +pspace machine-event help [command] +pspace machine-event help [arguments] [flags] ``` ### Flags @@ -75,34 +75,6 @@ machine-event help [arguments] [flags] - [commands](#commands) -## pspace machine-event help commands - -List machine-event commands - -Example: - -``` -$ machine-event help commands commands -``` - -### Usage - -``` -machine-event help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace machine-event list List machine events in your team. @@ -116,7 +88,7 @@ pspace machine-event list -F name -F dtModified ### Usage ``` -machine-event list [flags] +pspace machine-event list [flags] ``` ### Flags diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md index 7605892..5a4be99 100644 --- a/.assets/pspace/machine.md +++ b/.assets/pspace/machine.md @@ -7,8 +7,8 @@ For more information, see https://docs.paperspace.com/machines. ### Usage ``` -machine [command] -machine [flags] +pspace machine [command] +pspace machine [flags] ``` ### Flags @@ -39,7 +39,7 @@ Create a machine. ### Usage ``` -machine create [flags] +pspace machine create [flags] ``` ### Flags @@ -82,7 +82,7 @@ Delete a machine from a team. ### Usage ``` -machine delete [arguments] [flags] +pspace machine delete [arguments] [flags] ``` ### Flags @@ -104,7 +104,7 @@ Get a machine from a team. ### Usage ``` -machine get [arguments] [flags] +pspace machine get [arguments] [flags] ``` ### Flags @@ -126,8 +126,8 @@ Show help for a machine command ### Usage ``` -machine help [command] -machine help [arguments] [flags] +pspace machine help [command] +pspace machine help [arguments] [flags] ``` ### Flags @@ -143,34 +143,6 @@ machine help [arguments] [flags] - [commands](#commands) -## pspace machine help commands - -List machine commands - -Example: - -``` -$ machine help commands commands -``` - -### Usage - -``` -machine help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace machine list List machines in your team. @@ -184,7 +156,7 @@ pspace machine list -F name -F dtModified ### Usage ``` -machine list [flags] +pspace machine list [flags] ``` ### Flags @@ -215,7 +187,7 @@ Restart a machine from a team. ### Usage ``` -machine restart [arguments] [flags] +pspace machine restart [arguments] [flags] ``` ### Flags @@ -237,7 +209,7 @@ Start a machine from a team. ### Usage ``` -machine start [arguments] [flags] +pspace machine start [arguments] [flags] ``` ### Flags @@ -259,7 +231,7 @@ Stop a machine from a team. ### Usage ``` -machine stop [arguments] [flags] +pspace machine stop [arguments] [flags] ``` ### Flags @@ -281,7 +253,7 @@ Update a machine's settings. ### Usage ``` -machine update [arguments] [flags] +pspace machine update [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md index 3c94f20..93d236d 100644 --- a/.assets/pspace/model.md +++ b/.assets/pspace/model.md @@ -7,8 +7,8 @@ For more information, see https://docs.paperspace.com/deploying/models. ### Usage ``` -model [command] -model [flags] +pspace model [command] +pspace model [flags] ``` ### Flags @@ -36,7 +36,7 @@ one. ### Usage ``` -model create [flags] +pspace model create [flags] ``` ### Flags @@ -63,7 +63,7 @@ Delete a model from a team. ### Usage ``` -model delete [arguments] [flags] +pspace model delete [arguments] [flags] ``` ### Flags @@ -85,7 +85,7 @@ Get a model from a team. ### Usage ``` -model get [arguments] [flags] +pspace model get [arguments] [flags] ``` ### Flags @@ -107,8 +107,8 @@ Show help for a model command ### Usage ``` -model help [command] -model help [arguments] [flags] +pspace model help [command] +pspace model help [arguments] [flags] ``` ### Flags @@ -124,34 +124,6 @@ model help [arguments] [flags] - [commands](#commands) -## pspace model help commands - -List model commands - -Example: - -``` -$ model help commands commands -``` - -### Usage - -``` -model help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace model list List models in your team. @@ -165,7 +137,7 @@ pspace model list -F name -F dtModified ### Usage ``` -model list [flags] +pspace model list [flags] ``` ### Flags diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md index b20d5a9..4371205 100644 --- a/.assets/pspace/os-template.md +++ b/.assets/pspace/os-template.md @@ -8,8 +8,8 @@ For more information, see https://docs.paperspace.com/compute/os-templates. ### Usage ``` -os-template [command] -os-template [flags] +pspace os-template [command] +pspace os-template [flags] ``` ### Flags @@ -33,8 +33,8 @@ Show help for a os-template command ### Usage ``` -os-template help [command] -os-template help [arguments] [flags] +pspace os-template help [command] +pspace os-template help [arguments] [flags] ``` ### Flags @@ -50,34 +50,6 @@ os-template help [arguments] [flags] - [commands](#commands) -## pspace os-template help commands - -List os-template commands - -Example: - -``` -$ os-template help commands commands -``` - -### Usage - -``` -os-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace os-template list List OS templates. @@ -91,7 +63,7 @@ pspace os-template list -F name ### Usage ``` -os-template list [flags] +pspace os-template list [flags] ``` ### Flags diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md index cf587ea..bf474a2 100644 --- a/.assets/pspace/private-network.md +++ b/.assets/pspace/private-network.md @@ -10,8 +10,8 @@ https://docs.paperspace.com/networking/private-networks. ### Usage ``` -private-network [command] -private-network [flags] +pspace private-network [command] +pspace private-network [flags] ``` ### Flags @@ -38,7 +38,7 @@ Create a private network. ### Usage ``` -private-network create [flags] +pspace private-network create [flags] ``` ### Flags @@ -62,7 +62,7 @@ Delete a private network from a team. ### Usage ``` -private-network delete [arguments] [flags] +pspace private-network delete [arguments] [flags] ``` ### Flags @@ -84,7 +84,7 @@ Get a private network from a team. ### Usage ``` -private-network get [arguments] [flags] +pspace private-network get [arguments] [flags] ``` ### Flags @@ -106,8 +106,8 @@ Show help for a private-network command ### Usage ``` -private-network help [command] -private-network help [arguments] [flags] +pspace private-network help [command] +pspace private-network help [arguments] [flags] ``` ### Flags @@ -123,34 +123,6 @@ private-network help [arguments] [flags] - [commands](#commands) -## pspace private-network help commands - -List private-network commands - -Example: - -``` -$ private-network help commands commands -``` - -### Usage - -``` -private-network help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace private-network list List private networks in your team. @@ -164,7 +136,7 @@ pspace private-network list -F name -F dtModified ### Usage ``` -private-network list [flags] +pspace private-network list [flags] ``` ### Flags diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md index 8c373cc..5f89484 100644 --- a/.assets/pspace/project.md +++ b/.assets/pspace/project.md @@ -5,8 +5,8 @@ Manage your Paperspace projects. ### Usage ``` -project [command] -project [flags] +pspace project [command] +pspace project [flags] ``` ### Flags @@ -36,7 +36,7 @@ provide one. ### Usage ``` -project create [arguments] [flags] +pspace project create [arguments] [flags] ``` ### Flags @@ -59,7 +59,7 @@ you for one based on the projects you have access to. ### Usage ``` -project delete [arguments] [flags] +pspace project delete [arguments] [flags] ``` ### Flags @@ -82,7 +82,7 @@ you for one based on the projects you have access to. ### Usage ``` -project get [arguments] [flags] +pspace project get [arguments] [flags] ``` ### Flags @@ -104,8 +104,8 @@ Show help for a project command ### Usage ``` -project help [command] -project help [arguments] [flags] +pspace project help [command] +pspace project help [arguments] [flags] ``` ### Flags @@ -121,34 +121,6 @@ project help [arguments] [flags] - [commands](#commands) -## pspace project help commands - -List project commands - -Example: - -``` -$ project help commands commands -``` - -### Usage - -``` -project help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace project link This will link a remote project to a local directory. Commands that depend on a @@ -176,7 +148,7 @@ $ pspace link pzwf2g05ubegj ### Usage ``` -project link [arguments] [flags] +pspace project link [arguments] [flags] ``` ### Flags @@ -204,7 +176,7 @@ pspace project list -F id -F name -F dtCreated ### Usage ``` -project list [flags] +pspace project list [flags] ``` ### Flags diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md index 6c3b8f5..65e61a9 100644 --- a/.assets/pspace/pspace.md +++ b/.assets/pspace/pspace.md @@ -56,4389 +56,3 @@ pspace [flags] - [up](#up) - [upgrade](#upgrade) - [version](#version) - -## pspace autoscaling-group - -Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes -cluster-autoscaler to automatically scale your cluster. You can also autoscaling -groups as a primitive for your own autoscaler. - -### Usage - -``` -autoscaling-group [command] -autoscaling-group [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace autoscaling-group create - -Create an autoscaling group. - -### Usage - -``` -autoscaling-group create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group delete - -Delete an autoscaling group from a team. - -### Usage - -``` -autoscaling-group delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group get - -Get an autoscaling group from a team. - -### Usage - -``` -autoscaling-group get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group help - -Show help for a autoscaling-group command - -### Usage - -``` -autoscaling-group help [command] -autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace autoscaling-group help commands - -List autoscaling-group commands - -Example: - -``` -$ autoscaling-group help commands commands -``` - -### Usage - -``` -autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace autoscaling-group list - -List autoscaling groups in your team. - -Pick a subset of fields to display: - -``` -pspace autoscaling-group list -F name -F dtCreated -``` - -### Usage - -``` -autoscaling-group list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------ | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group update - -Update an autoscaling group. - -### Usage - -``` -autoscaling-group update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace completion - -Generate an autocompletion script for pspace in the specified shell. See each -sub-command's help for details on how to use the generated script. - -### Usage - -``` -completion [command] -completion [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [bash](#bash) -- [fish](#fish) -- [help](#help) -- [zsh](#zsh) - -## pspace completion bash - -Generate the autocompletion script for the bash shell. - -This script depends on the `bash-completion` package. If it is not installed -already, you can install it via your OS's package manager. - -To load completions in your current shell session: - -``` -$ source <(completion bash bash) -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion bash bash > /etc/bash_completion.d/pspace -``` - -macOS: - -``` -$ completion bash bash > /usr/local/etc/bash_completion.d/pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion bash [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace completion fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - -``` -$ completion fish fish | source -``` - -To load completions for every new session, execute once: - -``` -$ completion fish fish > ~/.config/fish/completions/pspace.fish -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion fish [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace completion help - -Show help for a completion command - -### Usage - -``` -completion help [command] -completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace completion help commands - -List completion commands - -Example: - -``` -$ completion help commands commands -``` - -### Usage - -``` -completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace completion zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need to -enable it. You can execute the following once: - -``` -$ echo "autoload -U compinit; compinit" >> ~/.zshrc -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion zsh zsh > "${fpath[1]}/_pspace" -``` - -macOS: - -``` -$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace -``` - -Oh My Zsh: - -``` -$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion zsh [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace config - -This command manages your Paperspace configuration. You can use it to set, get, -and delete configuration values. Running this command without any subcommands -will print your current configuration. - -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. - -For example, to set the current team, run: - -``` -pspace config set team "my-team" -``` - -### Usage - -``` -config [command] -config [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [set](#set) - -## pspace config delete - -Delete a configuration value. - -### Usage - -``` -config delete [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace config get - -This command gets a configuration value. You can pass a key to get a specific -value, or you can pass no arguments to get all configuration values. - -For example, to get the current team run: - -``` -pspace config get team -``` - -### Usage - -``` -config get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace config help - -Show help for a config command - -### Usage - -``` -config help [command] -config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace config help commands - -List config commands - -Example: - -``` -$ config help commands commands -``` - -### Usage - -``` -config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace config set - -Set a configuration value. - -### Usage - -``` -config set [arguments] [arguments...] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace console - -This command opens the Paperspace web console in your browser. - -### Usage - -``` -console [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template - -Manage your custom templates. Custom templates are a backup of your machine's -disk. They can be used to create additional machines. You can use them to -prepopulate a machine with your desired software stack. - -For more information, see https://docs.paperspace.com/compute/custom-templates. - -### Usage - -``` -custom-template [command] -custom-template [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace custom-template create - -Create a custom template from a machine. - -### Usage - -``` -custom-template create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template delete - -Delete a custom template from a team. - -### Usage - -``` -custom-template delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template get - -Get a custom template from a team. - -### Usage - -``` -custom-template get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template help - -Show help for a custom-template command - -### Usage - -``` -custom-template help [command] -custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace custom-template help commands - -List custom-template commands - -Example: - -``` -$ custom-template help commands commands -``` - -### Usage - -``` -custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace custom-template list - -List custom templates in your team. - -Pick a subset of fields to display: - -``` -pspace custom-template list -F name -F dtModified -``` - -### Usage - -``` -custom-template list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset - -Manage your datasets. - -For more information, see https://docs.paperspace.com/storage/datasets. - -### Usage - -``` -dataset [command] -dataset [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -- [versions](#versions) - -## pspace dataset create - -Create a dataset. - -### Usage - -``` -dataset create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset delete - -Delete a dataset from a team. - -### Usage - -``` -dataset delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset get - -Get a dataset from a team. - -### Usage - -``` -dataset get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset help - -Show help for a dataset command - -### Usage - -``` -dataset help [command] -dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace dataset help commands - -List dataset commands - -Example: - -``` -$ dataset help commands commands -``` - -### Usage - -``` -dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace dataset list - -List datasets in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset list -F name -F dtModified -``` - -### Usage - -``` -dataset list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset update - -Update a dataset in a project or team. - -### Usage - -``` -dataset update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions - -Manage your dataset versions. - -For more information, see https://docs.paperspace.com/storage/datasetVersions. - -### Usage - -``` -dataset versions [command] -dataset versions [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace dataset versions create - -Create a dataset version. This command will prompt you for an ID if you don't -provide one. - -### Usage - -``` -dataset versions create [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions delete - -Delete a dataset version from a team. This command will prompt you for an ID if -you don't provide one. - -### Usage - -``` -dataset versions delete [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions get - -Get a dataset version from a team. This command will prompt you for an ID if you -don't provide one. - -### Usage - -``` -dataset versions get [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions help - -Show help for a versions command - -### Usage - -``` -dataset versions help [command] -dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace dataset versions help commands - -List versions commands - -Example: - -``` -$ dataset versions help commands commands -``` - -### Usage - -``` -dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace dataset versions list - -List dataset versions in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset versions list -F name -F dtModified -``` - -### Usage - -``` -dataset versions list [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions update - -Update a dataset version in a project or team. - -### Usage - -``` -dataset versions update [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment - -Effortlessly deploy ML apps to Paperspace. - -### Usage - -``` -deployment [command] -deployment [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [up](#up) - -## pspace deployment delete - -Delete a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 -``` - -### Usage - -``` -deployment delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment get - -Get a deployment by its ID. If you don't provide an ID, this command will prompt -you for one based on the deployments you have access to. - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -``` - -Pick a subset of fields to display: - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name -``` - -### Usage - -``` -deployment get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment help - -Show help for a deployment command - -### Usage - -``` -deployment help [command] -deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace deployment help commands - -List deployment commands - -Example: - -``` -$ deployment help commands commands -``` - -### Usage - -``` -deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace deployment list - -List deployments in your team. - -Pick a subset of fields to display: - -``` -pspace deployment list -F id -F name -``` - -### Usage - -``` -deployment list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment up - -This will create a new deployment for your app or update it if it already -exists. You can optionally specify a path to a config file. If no config file is -specified, the default config file paths will be tried. - -Create a new deployment for the app in the current directory. - -``` -$ pspace deployment create -``` - -Create a new deployment using a config file. - -``` -$ pspace deployment create -c paperspace.json -``` - -Create a new deployment for an app in a different directory. - -``` -$ pspace deployment create --cwd ../my-app -``` - -Create a new deployment for an app in a specific project. - -``` -$ pspace deployment create --project-id 1234 -``` - -### Usage - -``` -deployment up [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------ | ------- | ----------------------------------------------------------------------- | -------- | -| config | c | The path to the config file. Defaults to our default config file paths. | | - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to - deploy to. | false | | cwd | | The directory to deploy the app from. Defaults - to the current directory. | false | | log-level | l | Enable debug logging. | - false | | json | j | Output JSON | false | | api-key | | A Paperspace public - API Key used for authenticating requests | false | | help | h | Show help for - a command | false | - -#### Subcommands - -## pspace docs - -This command opens the Paperspace documentation in your browser. You can -optionally pass an argument that will take you to a specific docs page. - -Valid pages are: - -- `d`, `deployment` - -### Usage - -``` -docs [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace help - -Show help for a pspace command - -### Usage - -``` -help [command] -help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace help commands - -List pspace commands - -Example: - -``` -$ help commands commands -``` - -### Usage - -``` -help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace init - -Create a new Paperspace app. This will create a new directory with a default app -structure. You can optionally specify a name for the app and a template to use. -If no template is specified, the default template will be used. - -Create a new app in the current directory. - -``` -$ pspace init -``` - -Create a new app named "my-app" relative to the current directory. - -``` -$ pspace init my-app -``` - -Create a new app named "my-app" relative to the current directory using a -template from the Paperspace GitHub organization. - -``` -$ pspace init my-app -t Paperspace/gradio-demo -``` - -### Usage - -``` -init [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | -| template | t | A template to use when creating the app. This can be a URL | | -| to a git repository or a shorthand template name. | | | | - -These templates are equivalent: - -``` -user/repo -github:user/repo -git@github.com:user/repo -https://github.com/user/repo -``` - -Download from GitLab: - -``` -gitlab:user/repo -git@gitlab.com:user/repo -https://gitlab.com/user/repo -``` - -Download from Bitbucket - -``` -bitbucket:user/repo -git@bitbucket.org:user/repo -https://bitbucket.org/user/repo -``` - -Specify a tag or branch: - -```` -user/repo#dev # branch -user/repo#v1.2.3 # release tag -user/repo#1234abcd # commit hash -``` | true | -| mode | m | The mode to use when creating the app. This can be either "git" or -"tar". If "git" is specified, the template will be downloaded as a -tarball. Note that "git" clones over SSH, so you must have a valid -SSH key configured with GitHub, Bitbucket, or GitLab. | false | -| name | n | The name of the app. Defaults to the first argument current directory name. | false | -| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace login - -Log in to the CLI using your Paperspace API key or by opening the web console. - -### Usage -```` - -login [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace logout - -Log out of the CLI for the current team, a specific team, or all teams. - -### Usage -``` - -logout [arguments...] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| all | a | Log out of all teams. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine - -Manage your Paperspace machines. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine [command] machine [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [restart](#restart) -- [start](#start) -- [stop](#stop) -- [update](#update) -## pspace machine create - -Create a machine. - -### Usage -``` - -machine create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine delete - -Delete a machine from a team. - -### Usage -``` - -machine delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine get - -Get a machine from a team. - -### Usage -``` - -machine get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine help - -Show help for a machine command - -### Usage -``` - -machine help [command] machine help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace machine help commands - -List machine commands - -Example: -``` - -$ machine help commands commands - -``` -### Usage -``` - -machine help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace machine list - -List machines in your team. - -Pick a subset of fields to display: -``` - -pspace machine list -F name -F dtModified - -``` -### Usage -``` - -machine list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine restart - -Restart a machine from a team. - -### Usage -``` - -machine restart [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine start - -Start a machine from a team. - -### Usage -``` - -machine start [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine stop - -Stop a machine from a team. - -### Usage -``` - -machine stop [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine update - -Update a machine's settings. - -### Usage -``` - -machine update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine-event - -Manage your machine events. Events are asynchronous tasks performed by our system on your machines. -Not all machine commands are asynchronous. For those that are, a machine event will be returned -which can be tracked using this command. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine-event [command] machine-event [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [get](#get) -- [help](#help) -- [list](#list) -## pspace machine-event get - -Get a machine event from a team. - -### Usage -``` - -machine-event get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine-event help - -Show help for a machine-event command - -### Usage -``` - -machine-event help [command] machine-event help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace machine-event help commands - -List machine-event commands - -Example: -``` - -$ machine-event help commands commands - -``` -### Usage -``` - -machine-event help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace machine-event list - -List machine events in your team. - -Pick a subset of fields to display: -``` - -pspace machine-event list -F name -F dtModified - -``` -### Usage -``` - -machine-event list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model - -Manage your Paperspace models. - -For more information, see https://docs.paperspace.com/deploying/models. - -### Usage -``` - -model [command] model [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace model create - -Create a new model. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -model create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model delete - -Delete a model from a team. - -### Usage -``` - -model delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model get - -Get a model from a team. - -### Usage -``` - -model get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model help - -Show help for a model command - -### Usage -``` - -model help [command] model help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace model help commands - -List model commands - -Example: -``` - -$ model help commands commands - -``` -### Usage -``` - -model help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace model list - -List models in your team. - -Pick a subset of fields to display: -``` - -pspace model list -F name -F dtModified - -``` -### Usage -``` - -model list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace os-template - -List OS templates. OS templates are pre-configured virtual machines that -you can use to create a new machine. - -For more information, see https://docs.paperspace.com/compute/os-templates. - -### Usage -``` - -os-template [command] os-template [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [list](#list) -## pspace os-template help - -Show help for a os-template command - -### Usage -``` - -os-template help [command] os-template help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace os-template help commands - -List os-template commands - -Example: -``` - -$ os-template help commands commands - -``` -### Usage -``` - -os-template help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace os-template list - -List OS templates. - -Pick a subset of fields to display: -``` - -pspace os-template list -F name - -``` -### Usage -``` - -os-template list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network - -Manage your private networks. Private networks are logically isolated networks -for your machines and shared drives. They can also be used for site-to-site VPNs -and direct connections to your on-premise network. - -For more information, see https://docs.paperspace.com/networking/private-networks. - -### Usage -``` - -private-network [command] private-network [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace private-network create - -Create a private network. - -### Usage -``` - -private-network create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network delete - -Delete a private network from a team. - -### Usage -``` - -private-network delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network get - -Get a private network from a team. - -### Usage -``` - -private-network get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network help - -Show help for a private-network command - -### Usage -``` - -private-network help [command] private-network help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace private-network help commands - -List private-network commands - -Example: -``` - -$ private-network help commands commands - -``` -### Usage -``` - -private-network help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace private-network list - -List private networks in your team. - -Pick a subset of fields to display: -``` - -pspace private-network list -F name -F dtModified - -``` -### Usage -``` - -private-network list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project - -Manage your Paperspace projects. - -### Usage -``` - -project [command] project [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [link](#link) -- [list](#list) -- [update](#update) -## pspace project create - -Create a new project. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -project create [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project delete - -Delete a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project get - -Get a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project help - -Show help for a project command - -### Usage -``` - -project help [command] project help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace project help commands - -List project commands - -Example: -``` - -$ project help commands commands - -``` -### Usage -``` - -project help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace project link - -This will link a remote project to a local directory. Commands that -depend on a project ID will use the project ID of the linked project -when communicating with the Paperspace API. - -Link a project to the current directory. -``` - -$ pspace link - -``` -Link a project to a different directory. -``` - -$ pspace link --cwd ../my-app - -``` -Link a project and specify a project ID. -``` - -$ pspace link pzwf2g05ubegj - -``` -### Usage -``` - -project link [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project list - -List projects in your team. - -Pick a subset of fields to display: -``` - -pspace project list -F id -F name -F dtCreated - -``` -### Usage -``` - -project list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project update - -Update an existing project. - -Example: -``` - -pspace project update psukfyemho7 --name my-cool-project - -``` -### Usage -``` - -pspace project update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip - -Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. - -For more information, see https://docs.paperspace.com/networking/public-ips. - -### Usage -``` - -public-ip [command] public-ip [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [assign](#assign) -- [claim](#claim) -- [help](#help) -- [list](#list) -- [release](#release) -## pspace public-ip assign - -Assign a public IP to a machine. - -### Usage -``` - -public-ip assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip claim - -Claim a public IP for a team. - -### Usage -``` - -public-ip claim [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip help - -Show help for a public-ip command - -### Usage -``` - -public-ip help [command] public-ip help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace public-ip help commands - -List public-ip commands - -Example: -``` - -$ public-ip help commands commands - -``` -### Usage -``` - -public-ip help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace public-ip list - -List public IPs in your team or project. - -Pick a subset of fields to display: -``` - -pspace public-ip list -F name -F dtModified - -``` -### Usage -``` - -public-ip list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip release - -Release a public IP from a team. This will unassign it from its assigned machine, if any. - -### Usage -``` - -public-ip release [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret - -Manage your Paperspace secrets. Secrets are used to store sensitive -information such as API keys, passwords, and other credentials. Secrets -can be safely injected into workloads as environment variables. An environment -variable that uses a Secret will not reveal the contents of the secret itself. - -Secrets can be created at the following levels: - -- Project (default): these secrets are applied to all resources in a project -- Global: these secrets can be applied to all resources on your current team - -For more information, see https://docs.paperspace.com/secrets. - -### Usage -``` - -secret [command] secret [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace secret create - -Create a secret in a project or team. - -### Usage -``` - -secret create [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret delete - -Delete a secret from a project or team. - -### Usage -``` - -secret delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret get - -Get a secret from a project or team. - -### Usage -``` - -secret get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret help - -Show help for a secret command - -### Usage -``` - -secret help [command] secret help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace secret help commands - -List secret commands - -Example: -``` - -$ secret help commands commands - -``` -### Usage -``` - -secret help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace secret list - -List secrets in your team or project. - -Pick a subset of fields to display: -``` - -pspace secret list -F name -F dtModified - -``` -### Usage -``` - -secret list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret update - -Update a secret in a project or team. - -### Usage -``` - -secret update [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive - -Manage your shared drives. Shared drives are used to centralize data -used by your team. Shared drives can be mounted on any Paperspace machine -in the same private network. - -For more information, see https://docs.paperspace.com/storage/shared-drives. - -### Usage -``` - -shared-drive [command] shared-drive [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace shared-drive create - -Create a shared drive. - -### Usage -``` - -shared-drive create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive delete - -Delete a shared drive from a team. - -### Usage -``` - -shared-drive delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive get - -Get a shared drive from a team. - -### Usage -``` - -shared-drive get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive help - -Show help for a shared-drive command - -### Usage -``` - -shared-drive help [command] shared-drive help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace shared-drive help commands - -List shared-drive commands - -Example: -``` - -$ shared-drive help commands commands - -``` -### Usage -``` - -shared-drive help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace shared-drive list - -List shared drives in your team or project. - -Pick a subset of fields to display: -``` - -pspace shared-drive list -F name -F dtModified - -``` -### Usage -``` - -shared-drive list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace signup - -This command opens the Paperspace signup page in your browser. - -### Usage -``` - -signup [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot - -Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. -They can be used to restore the machine to its previous state. Using snapshots is recommended -before taking any action that could affect the usability of the machine or its network connection. - -For more information, see https://docs.paperspace.com/storage/snapshots. - -### Usage -``` - -snapshot [command] snapshot [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [help](#help) -- [list](#list) -- [restore](#restore) -## pspace snapshot create - -Create a snapshot from a machine. - -### Usage -``` - -snapshot create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot delete - -Delete a snapshot from a team. - -### Usage -``` - -snapshot delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot help - -Show help for a snapshot command - -### Usage -``` - -snapshot help [command] snapshot help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace snapshot help commands - -List snapshot commands - -Example: -``` - -$ snapshot help commands commands - -``` -### Usage -``` - -snapshot help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace snapshot list - -List snapshots in your team. - -Pick a subset of fields to display: -``` - -pspace snapshot list -F name -F dtModified - -``` -### Usage -``` - -snapshot list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot restore - -Restore a machine to a snapshot. - -### Usage -``` - -snapshot restore [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script - -Manage your startup scripts. Startup scripts allow you to configure a machine -on first boot or on every boot. - -### Usage -``` - -startup-script [command] startup-script [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [assign](#assign) -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [unassign](#unassign) -- [update](#update) -## pspace startup-script assign - -Assign a startup script to a machine. - -### Usage -``` - -startup-script assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script create - -Create a startup script. - -### Usage -``` - -startup-script create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script delete - -Delete a startup script from a team. - -### Usage -``` - -startup-script delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script get - -Get a startup script from a team. - -### Usage -``` - -startup-script get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script help - -Show help for a startup-script command - -### Usage -``` - -startup-script help [command] startup-script help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace startup-script help commands - -List startup-script commands - -Example: -``` - -$ startup-script help commands commands - -``` -### Usage -``` - -startup-script help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace startup-script list - -List startup scripts in your team. - -Pick a subset of fields to display: -``` - -pspace startup-script list -F name -F dtCreated - -``` -### Usage -``` - -startup-script list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script unassign - -Unassign a startup script from a machine. - -### Usage -``` - -startup-script unassign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script update - -Update a startup script. - -### Usage -``` - -startup-script update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider - -Manage your storage providers. - -For more information, see https://docs.paperspace.com/storage/storageProviders. - -### Usage -``` - -storage-provider [command] storage-provider [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace storage-provider create - -Create a storage provider. - -### Usage -``` - -storage-provider create [command] storage-provider create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider create help - -Show help for a create command - -### Usage -``` - -storage-provider create help [command] storage-provider create help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace storage-provider create help commands - -List create commands - -Example: -``` - -$ storage-provider create help commands commands - -``` -### Usage -``` - -storage-provider create help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace storage-provider create s3 - -Create an S3 storage provider. - -### Usage -``` - -storage-provider create s3 [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider delete - -Delete a storage provider from a team. - -### Usage -``` - -storage-provider delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider get - -Get a storage provider from a team. - -### Usage -``` - -storage-provider get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider help - -Show help for a storage-provider command - -### Usage -``` - -storage-provider help [command] storage-provider help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace storage-provider help commands - -List storage-provider commands - -Example: -``` - -$ storage-provider help commands commands - -``` -### Usage -``` - -storage-provider help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace storage-provider list - -List storage providers in your team or project. - -Pick a subset of fields to display: -``` - -pspace storage provider list -F name -F dtModified - -``` -### Usage -``` - -storage-provider list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider update - -Update a storage provider. - -### Usage -``` - -storage-provider update [command] storage-provider update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider update help - -Show help for a update command - -### Usage -``` - -storage-provider update help [command] storage-provider update help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) -## pspace storage-provider update help commands - -List update commands - -Example: -``` - -$ storage-provider update help commands commands - -``` -### Usage -``` - -storage-provider update help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace storage-provider update s3 - -Update an S3 storage provider in a project or team. - -### Usage -``` - -storage-provider update s3 [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace up - -This will upsert an app config and deploy your app to Paperspace. You can optionally -specify a path to a config file. If no config file is specified, the default -config file paths will be tried. - -Deploy the app in the current directory. -``` - -$ pspace up - -``` -Deploy the app using a config file. -``` - -$ pspace up -c paperspace.json - -``` -Deploy an app in a different directory. -``` - -$ pspace up --cwd ../my-app - -``` -### Usage -``` - -up [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace upgrade - -This command upgrades pspace to the latest version. - -If you used a package manager like `brew` to install `pspace`, -you should use that to upgrade in order to avoid potential permissions -issues. For example, for `brew` you can upgrade by running: -``` - -brew upgrade pspace - -``` -If you installed `pspace` using the install script, you can upgrade by -running: -``` - -pspace upgrade - -``` -### Usage -``` - -upgrade [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace version - -Shows version information command, including version number and build date. - -### Usage -``` - -version [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands -``` diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md index 832c6cc..ab8cc9c 100644 --- a/.assets/pspace/public-ip.md +++ b/.assets/pspace/public-ip.md @@ -8,8 +8,8 @@ For more information, see https://docs.paperspace.com/networking/public-ips. ### Usage ``` -public-ip [command] -public-ip [flags] +pspace public-ip [command] +pspace public-ip [flags] ``` ### Flags @@ -36,7 +36,7 @@ Assign a public IP to a machine. ### Usage ``` -public-ip assign [arguments] [flags] +pspace public-ip assign [arguments] [flags] ``` ### Flags @@ -59,7 +59,7 @@ Claim a public IP for a team. ### Usage ``` -public-ip claim [flags] +pspace public-ip claim [flags] ``` ### Flags @@ -82,8 +82,8 @@ Show help for a public-ip command ### Usage ``` -public-ip help [command] -public-ip help [arguments] [flags] +pspace public-ip help [command] +pspace public-ip help [arguments] [flags] ``` ### Flags @@ -99,34 +99,6 @@ public-ip help [arguments] [flags] - [commands](#commands) -## pspace public-ip help commands - -List public-ip commands - -Example: - -``` -$ public-ip help commands commands -``` - -### Usage - -``` -public-ip help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace public-ip list List public IPs in your team or project. @@ -140,7 +112,7 @@ pspace public-ip list -F name -F dtModified ### Usage ``` -public-ip list [flags] +pspace public-ip list [flags] ``` ### Flags @@ -169,7 +141,7 @@ machine, if any. ### Usage ``` -public-ip release [arguments] [flags] +pspace public-ip release [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md index 6f6c4f3..b9553d2 100644 --- a/.assets/pspace/secret.md +++ b/.assets/pspace/secret.md @@ -15,8 +15,8 @@ For more information, see https://docs.paperspace.com/secrets. ### Usage ``` -secret [command] -secret [flags] +pspace secret [command] +pspace secret [flags] ``` ### Flags @@ -44,7 +44,7 @@ Create a secret in a project or team. ### Usage ``` -secret create [arguments] [arguments] [flags] +pspace secret create [arguments] [arguments] [flags] ``` ### Flags @@ -73,7 +73,7 @@ Delete a secret from a project or team. ### Usage ``` -secret delete [arguments] [flags] +pspace secret delete [arguments] [flags] ``` ### Flags @@ -102,7 +102,7 @@ Get a secret from a project or team. ### Usage ``` -secret get [arguments] [flags] +pspace secret get [arguments] [flags] ``` ### Flags @@ -132,8 +132,8 @@ Show help for a secret command ### Usage ``` -secret help [command] -secret help [arguments] [flags] +pspace secret help [command] +pspace secret help [arguments] [flags] ``` ### Flags @@ -149,34 +149,6 @@ secret help [arguments] [flags] - [commands](#commands) -## pspace secret help commands - -List secret commands - -Example: - -``` -$ secret help commands commands -``` - -### Usage - -``` -secret help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace secret list List secrets in your team or project. @@ -190,7 +162,7 @@ pspace secret list -F name -F dtModified ### Usage ``` -secret list [flags] +pspace secret list [flags] ``` ### Flags @@ -225,7 +197,7 @@ Update a secret in a project or team. ### Usage ``` -secret update [arguments] [arguments] [flags] +pspace secret update [arguments] [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md index 7dd8860..f4be149 100644 --- a/.assets/pspace/shared-drive.md +++ b/.assets/pspace/shared-drive.md @@ -9,8 +9,8 @@ For more information, see https://docs.paperspace.com/storage/shared-drives. ### Usage ``` -shared-drive [command] -shared-drive [flags] +pspace shared-drive [command] +pspace shared-drive [flags] ``` ### Flags @@ -37,7 +37,7 @@ Create a shared drive. ### Usage ``` -shared-drive create [flags] +pspace shared-drive create [flags] ``` ### Flags @@ -63,7 +63,7 @@ Delete a shared drive from a team. ### Usage ``` -shared-drive delete [arguments] [flags] +pspace shared-drive delete [arguments] [flags] ``` ### Flags @@ -85,7 +85,7 @@ Get a shared drive from a team. ### Usage ``` -shared-drive get [arguments] [flags] +pspace shared-drive get [arguments] [flags] ``` ### Flags @@ -107,8 +107,8 @@ Show help for a shared-drive command ### Usage ``` -shared-drive help [command] -shared-drive help [arguments] [flags] +pspace shared-drive help [command] +pspace shared-drive help [arguments] [flags] ``` ### Flags @@ -124,34 +124,6 @@ shared-drive help [arguments] [flags] - [commands](#commands) -## pspace shared-drive help commands - -List shared-drive commands - -Example: - -``` -$ shared-drive help commands commands -``` - -### Usage - -``` -shared-drive help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace shared-drive list List shared drives in your team or project. @@ -165,7 +137,7 @@ pspace shared-drive list -F name -F dtModified ### Usage ``` -shared-drive list [flags] +pspace shared-drive list [flags] ``` ### Flags diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md index 9ba9230..8889049 100644 --- a/.assets/pspace/signup.md +++ b/.assets/pspace/signup.md @@ -5,7 +5,7 @@ This command opens the Paperspace signup page in your browser. ### Usage ``` -signup [flags] +pspace signup [flags] ``` ### Flags diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md index 078295d..932eef2 100644 --- a/.assets/pspace/snapshot.md +++ b/.assets/pspace/snapshot.md @@ -10,8 +10,8 @@ For more information, see https://docs.paperspace.com/storage/snapshots. ### Usage ``` -snapshot [command] -snapshot [flags] +pspace snapshot [command] +pspace snapshot [flags] ``` ### Flags @@ -38,7 +38,7 @@ Create a snapshot from a machine. ### Usage ``` -snapshot create [flags] +pspace snapshot create [flags] ``` ### Flags @@ -62,7 +62,7 @@ Delete a snapshot from a team. ### Usage ``` -snapshot delete [arguments] [flags] +pspace snapshot delete [arguments] [flags] ``` ### Flags @@ -84,8 +84,8 @@ Show help for a snapshot command ### Usage ``` -snapshot help [command] -snapshot help [arguments] [flags] +pspace snapshot help [command] +pspace snapshot help [arguments] [flags] ``` ### Flags @@ -101,34 +101,6 @@ snapshot help [arguments] [flags] - [commands](#commands) -## pspace snapshot help commands - -List snapshot commands - -Example: - -``` -$ snapshot help commands commands -``` - -### Usage - -``` -snapshot help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace snapshot list List snapshots in your team. @@ -142,7 +114,7 @@ pspace snapshot list -F name -F dtModified ### Usage ``` -snapshot list [flags] +pspace snapshot list [flags] ``` ### Flags @@ -171,7 +143,7 @@ Restore a machine to a snapshot. ### Usage ``` -snapshot restore [arguments] [flags] +pspace snapshot restore [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md index c592d77..dcd18de 100644 --- a/.assets/pspace/startup-script.md +++ b/.assets/pspace/startup-script.md @@ -6,8 +6,8 @@ first boot or on every boot. ### Usage ``` -startup-script [command] -startup-script [flags] +pspace startup-script [command] +pspace startup-script [flags] ``` ### Flags @@ -37,7 +37,7 @@ Assign a startup script to a machine. ### Usage ``` -startup-script assign [arguments] [flags] +pspace startup-script assign [arguments] [flags] ``` ### Flags @@ -60,7 +60,7 @@ Create a startup script. ### Usage ``` -startup-script create [flags] +pspace startup-script create [flags] ``` ### Flags @@ -85,7 +85,7 @@ Delete a startup script from a team. ### Usage ``` -startup-script delete [arguments] [flags] +pspace startup-script delete [arguments] [flags] ``` ### Flags @@ -107,7 +107,7 @@ Get a startup script from a team. ### Usage ``` -startup-script get [arguments] [flags] +pspace startup-script get [arguments] [flags] ``` ### Flags @@ -129,8 +129,8 @@ Show help for a startup-script command ### Usage ``` -startup-script help [command] -startup-script help [arguments] [flags] +pspace startup-script help [command] +pspace startup-script help [arguments] [flags] ``` ### Flags @@ -146,34 +146,6 @@ startup-script help [arguments] [flags] - [commands](#commands) -## pspace startup-script help commands - -List startup-script commands - -Example: - -``` -$ startup-script help commands commands -``` - -### Usage - -``` -startup-script help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace startup-script list List startup scripts in your team. @@ -187,7 +159,7 @@ pspace startup-script list -F name -F dtCreated ### Usage ``` -startup-script list [flags] +pspace startup-script list [flags] ``` ### Flags @@ -215,7 +187,7 @@ Unassign a startup script from a machine. ### Usage ``` -startup-script unassign [arguments] [flags] +pspace startup-script unassign [arguments] [flags] ``` ### Flags @@ -238,7 +210,7 @@ Update a startup script. ### Usage ``` -startup-script update [arguments] [flags] +pspace startup-script update [arguments] [flags] ``` ### Flags diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md index a332d1e..670eecc 100644 --- a/.assets/pspace/storage-provider.md +++ b/.assets/pspace/storage-provider.md @@ -7,8 +7,8 @@ For more information, see https://docs.paperspace.com/storage/storageProviders. ### Usage ``` -storage-provider [command] -storage-provider [flags] +pspace storage-provider [command] +pspace storage-provider [flags] ``` ### Flags @@ -36,8 +36,8 @@ Create a storage provider. ### Usage ``` -storage-provider create [command] -storage-provider create [flags] +pspace storage-provider create [command] +pspace storage-provider create [flags] ``` ### Flags @@ -54,89 +54,6 @@ storage-provider create [flags] - [help](#help) - [s3](#s3) -## pspace storage-provider create help - -Show help for a create command - -### Usage - -``` -storage-provider create help [command] -storage-provider create help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace storage-provider create help commands - -List create commands - -Example: - -``` -$ storage-provider create help commands commands -``` - -### Usage - -``` -storage-provider create help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace storage-provider create s3 - -Create an S3 storage provider. - -### Usage - -``` -storage-provider create s3 [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - ## pspace storage-provider delete Delete a storage provider from a team. @@ -144,7 +61,7 @@ Delete a storage provider from a team. ### Usage ``` -storage-provider delete [arguments] [flags] +pspace storage-provider delete [arguments] [flags] ``` ### Flags @@ -166,7 +83,7 @@ Get a storage provider from a team. ### Usage ``` -storage-provider get [arguments] [flags] +pspace storage-provider get [arguments] [flags] ``` ### Flags @@ -188,8 +105,8 @@ Show help for a storage-provider command ### Usage ``` -storage-provider help [command] -storage-provider help [arguments] [flags] +pspace storage-provider help [command] +pspace storage-provider help [arguments] [flags] ``` ### Flags @@ -205,34 +122,6 @@ storage-provider help [arguments] [flags] - [commands](#commands) -## pspace storage-provider help commands - -List storage-provider commands - -Example: - -``` -$ storage-provider help commands commands -``` - -### Usage - -``` -storage-provider help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - ## pspace storage-provider list List storage providers in your team or project. @@ -246,7 +135,7 @@ pspace storage provider list -F name -F dtModified ### Usage ``` -storage-provider list [flags] +pspace storage-provider list [flags] ``` ### Flags @@ -273,8 +162,8 @@ Update a storage provider. ### Usage ``` -storage-provider update [command] -storage-provider update [flags] +pspace storage-provider update [command] +pspace storage-provider update [flags] ``` ### Flags @@ -290,86 +179,3 @@ storage-provider update [flags] - [help](#help) - [s3](#s3) - -## pspace storage-provider update help - -Show help for a update command - -### Usage - -``` -storage-provider update help [command] -storage-provider update help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace storage-provider update help commands - -List update commands - -Example: - -``` -$ storage-provider update help commands commands -``` - -### Usage - -``` -storage-provider update help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands - -## pspace storage-provider update s3 - -Update an S3 storage provider in a project or team. - -### Usage - -``` -storage-provider update s3 [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md index 177f907..d7109c8 100644 --- a/.assets/pspace/up.md +++ b/.assets/pspace/up.md @@ -25,7 +25,7 @@ $ pspace up --cwd ../my-app ### Usage ``` -up [flags] +pspace up [flags] ``` ### Flags diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md index 6cd3c3f..6c5c148 100644 --- a/.assets/pspace/upgrade.md +++ b/.assets/pspace/upgrade.md @@ -19,7 +19,7 @@ pspace upgrade ### Usage ``` -upgrade [flags] +pspace upgrade [flags] ``` ### Flags diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md index 1096a69..e927ffb 100644 --- a/.assets/pspace/version.md +++ b/.assets/pspace/version.md @@ -5,7 +5,7 @@ Shows version information command, including version number and build date. ### Usage ``` -version [flags] +pspace version [flags] ``` ### Flags diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index df07d55..1cf031d 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -14,7 +14,11 @@ await Deno.writeTextFile( let markdown = ""; // Also generate markdown for the CLI -async function renderCommand(path: string[], command: ZcliJsonCommand) { +async function renderCommand( + path: string[], + command: ZcliJsonCommand, + recursive = false, +) { markdown += `## ${path.join(" ")}\n\n`; markdown += command.description + "\n\n"; markdown += "### Usage\n\n"; @@ -36,8 +40,10 @@ async function renderCommand(path: string[], command: ZcliJsonCommand) { markdown += `- [${subcommand.name}](#${subcommand.name})\n`; } - for (const subcommand of command.commands) { - await renderCommand([...path, subcommand.name], subcommand); + if (recursive) { + for (const subcommand of command.commands) { + await renderCommand([...path, subcommand.name], subcommand); + } } } @@ -47,7 +53,7 @@ for (const command of json.commands) { }); for (const subcommand of command.commands) { markdown = ""; - await renderCommand([command.name, subcommand.name], subcommand); + await renderCommand([command.name, subcommand.name], subcommand, true); await Deno.writeTextFile( `.assets/${command.name}/${subcommand.name}.md`, markdown, diff --git a/.scripts/zcli-json.ts b/.scripts/zcli-json.ts index 6ed3695..8cf3e66 100644 --- a/.scripts/zcli-json.ts +++ b/.scripts/zcli-json.ts @@ -168,7 +168,7 @@ export async function zcliJson< description: root.long(ctx) || root.short(ctx) || "", summary: root.short(ctx) || "", }, - commands: [generateCommand(root, [])], + commands: [generateCommand(root, [root.name])], }; }); } From 0f05aff350e4f0f77496e0d09bec990085ec88ea Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Wed, 29 May 2024 18:12:42 +0000 Subject: [PATCH 09/10] updates --- .assets/pspace.json | 2 +- .assets/pspace/autoscaling-group.md | 196 ------------ .../autoscaling-group/autoscaling-group.md | 37 +++ .assets/pspace/autoscaling-group/create.md | 26 ++ .assets/pspace/autoscaling-group/delete.md | 17 ++ .assets/pspace/autoscaling-group/get.md | 17 ++ .../pspace/autoscaling-group/help/commands.md | 23 ++ .assets/pspace/autoscaling-group/help/help.md | 30 ++ .assets/pspace/autoscaling-group/list.md | 30 ++ .assets/pspace/autoscaling-group/update.md | 27 ++ .assets/pspace/completion.md | 184 ------------ .assets/pspace/completion/bash.md | 41 +++ .assets/pspace/completion/completion.md | 95 ++++++ .assets/pspace/completion/fish.md | 31 ++ .assets/pspace/completion/help/commands.md | 23 ++ .assets/pspace/completion/help/help.md | 30 ++ .assets/pspace/completion/zsh.md | 46 +++ .assets/pspace/config.md | 130 -------- .assets/pspace/config/config.md | 44 +++ .assets/pspace/config/delete.md | 16 + .assets/pspace/config/get.md | 23 ++ .assets/pspace/config/help/commands.md | 23 ++ .assets/pspace/config/help/help.md | 30 ++ .assets/pspace/config/set.md | 16 + .assets/pspace/console.md | 16 +- .assets/pspace/custom-template.md | 159 ---------- .assets/pspace/custom-template/create.md | 19 ++ .../pspace/custom-template/custom-template.md | 38 +++ .assets/pspace/custom-template/delete.md | 17 ++ .assets/pspace/custom-template/get.md | 17 ++ .../pspace/custom-template/help/commands.md | 23 ++ .assets/pspace/custom-template/help/help.md | 30 ++ .assets/pspace/custom-template/list.md | 31 ++ .assets/pspace/dataset.md | 213 ------------- .assets/pspace/dataset/create.md | 21 ++ .assets/pspace/dataset/dataset.md | 40 +++ .assets/pspace/dataset/delete.md | 17 ++ .assets/pspace/dataset/get.md | 17 ++ .assets/pspace/dataset/help/commands.md | 23 ++ .assets/pspace/dataset/help/help.md | 30 ++ .assets/pspace/dataset/list.md | 28 ++ .assets/pspace/dataset/update.md | 19 ++ .assets/pspace/dataset/versions/create.md | 19 ++ .assets/pspace/dataset/versions/delete.md | 18 ++ .assets/pspace/dataset/versions/get.md | 18 ++ .../pspace/dataset/versions/help/commands.md | 23 ++ .assets/pspace/dataset/versions/help/help.md | 30 ++ .assets/pspace/dataset/versions/list.md | 28 ++ .assets/pspace/dataset/versions/update.md | 19 ++ .assets/pspace/dataset/versions/versions.md | 40 +++ .assets/pspace/deployment.md | 205 ------------- .assets/pspace/deployment/delete.md | 21 ++ .assets/pspace/deployment/deployment.md | 79 +++++ .assets/pspace/deployment/get.md | 28 ++ .assets/pspace/deployment/help/commands.md | 23 ++ .assets/pspace/deployment/help/help.md | 30 ++ .assets/pspace/deployment/list.md | 28 ++ .assets/pspace/deployment/up.md | 57 ++++ .assets/pspace/docs.md | 16 +- .assets/pspace/help.md | 51 ---- .assets/pspace/help/commands.md | 23 ++ .assets/pspace/help/help.md | 30 ++ .assets/pspace/init.md | 20 +- .assets/pspace/login.md | 16 +- .assets/pspace/logout.md | 18 +- .assets/pspace/machine-event.md | 111 ------- .assets/pspace/machine-event/get.md | 17 ++ .assets/pspace/machine-event/help/commands.md | 23 ++ .assets/pspace/machine-event/help/help.md | 30 ++ .assets/pspace/machine-event/list.md | 30 ++ .assets/pspace/machine-event/machine-event.md | 37 +++ .assets/pspace/machine.md | 283 ------------------ .assets/pspace/machine/create.md | 38 +++ .assets/pspace/machine/delete.md | 17 ++ .assets/pspace/machine/get.md | 17 ++ .assets/pspace/machine/help/commands.md | 23 ++ .assets/pspace/machine/help/help.md | 30 ++ .assets/pspace/machine/list.md | 32 ++ .assets/pspace/machine/machine.md | 40 +++ .assets/pspace/machine/restart.md | 17 ++ .assets/pspace/machine/start.md | 17 ++ .assets/pspace/machine/stop.md | 17 ++ .assets/pspace/machine/update.md | 31 ++ .assets/pspace/model.md | 158 ---------- .assets/pspace/model/create.md | 23 ++ .assets/pspace/model/delete.md | 17 ++ .assets/pspace/model/get.md | 17 ++ .assets/pspace/model/help/commands.md | 23 ++ .assets/pspace/model/help/help.md | 30 ++ .assets/pspace/model/list.md | 28 ++ .assets/pspace/model/model.md | 37 +++ .assets/pspace/os-template.md | 85 ------ .assets/pspace/os-template/help/commands.md | 23 ++ .assets/pspace/os-template/help/help.md | 30 ++ .assets/pspace/os-template/list.md | 29 ++ .assets/pspace/os-template/os-template.md | 34 +++ .assets/pspace/private-network.md | 159 ---------- .assets/pspace/private-network/create.md | 19 ++ .assets/pspace/private-network/delete.md | 17 ++ .assets/pspace/private-network/get.md | 17 ++ .../pspace/private-network/help/commands.md | 23 ++ .assets/pspace/private-network/help/help.md | 30 ++ .assets/pspace/private-network/list.md | 30 ++ .../pspace/private-network/private-network.md | 39 +++ .assets/pspace/project.md | 226 -------------- .assets/pspace/project/create.md | 18 ++ .assets/pspace/project/delete.md | 18 ++ .assets/pspace/project/get.md | 18 ++ .assets/pspace/project/help/commands.md | 23 ++ .assets/pspace/project/help/help.md | 30 ++ .assets/pspace/project/link.md | 37 +++ .assets/pspace/project/list.md | 28 ++ .assets/pspace/project/project.md | 67 +++++ .assets/pspace/project/update.md | 24 ++ .assets/pspace/pspace.md | 195 +++++++++--- .assets/pspace/public-ip.md | 157 ---------- .assets/pspace/public-ip/assign.md | 18 ++ .assets/pspace/public-ip/claim.md | 18 ++ .assets/pspace/public-ip/help/commands.md | 23 ++ .assets/pspace/public-ip/help/help.md | 30 ++ .assets/pspace/public-ip/list.md | 29 ++ .assets/pspace/public-ip/public-ip.md | 37 +++ .assets/pspace/public-ip/release.md | 18 ++ .assets/pspace/secret.md | 220 -------------- .assets/pspace/secret/create.md | 24 ++ .assets/pspace/secret/delete.md | 24 ++ .assets/pspace/secret/get.md | 25 ++ .assets/pspace/secret/help/commands.md | 23 ++ .assets/pspace/secret/help/help.md | 30 ++ .assets/pspace/secret/list.md | 36 +++ .assets/pspace/secret/secret.md | 45 +++ .assets/pspace/secret/update.md | 24 ++ .assets/pspace/shared-drive.md | 160 ---------- .assets/pspace/shared-drive/create.md | 21 ++ .assets/pspace/shared-drive/delete.md | 17 ++ .assets/pspace/shared-drive/get.md | 17 ++ .assets/pspace/shared-drive/help/commands.md | 23 ++ .assets/pspace/shared-drive/help/help.md | 30 ++ .assets/pspace/shared-drive/list.md | 30 ++ .assets/pspace/shared-drive/shared-drive.md | 38 +++ .assets/pspace/signup.md | 16 +- .assets/pspace/snapshot.md | 160 ---------- .assets/pspace/snapshot/create.md | 19 ++ .assets/pspace/snapshot/delete.md | 17 ++ .assets/pspace/snapshot/help/commands.md | 23 ++ .assets/pspace/snapshot/help/help.md | 30 ++ .assets/pspace/snapshot/list.md | 30 ++ .assets/pspace/snapshot/restore.md | 18 ++ .assets/pspace/snapshot/snapshot.md | 39 +++ .assets/pspace/startup-script.md | 230 -------------- .assets/pspace/startup-script/assign.md | 18 ++ .assets/pspace/startup-script/create.md | 20 ++ .assets/pspace/startup-script/delete.md | 17 ++ .assets/pspace/startup-script/get.md | 17 ++ .../pspace/startup-script/help/commands.md | 23 ++ .assets/pspace/startup-script/help/help.md | 30 ++ .assets/pspace/startup-script/list.md | 29 ++ .../pspace/startup-script/startup-script.md | 38 +++ .assets/pspace/startup-script/unassign.md | 18 ++ .assets/pspace/startup-script/update.md | 21 ++ .assets/pspace/storage-provider.md | 181 ----------- .../pspace/storage-provider/create/create.md | 24 ++ .../storage-provider/create/help/commands.md | 23 ++ .../storage-provider/create/help/help.md | 30 ++ .assets/pspace/storage-provider/create/s3.md | 26 ++ .assets/pspace/storage-provider/delete.md | 17 ++ .assets/pspace/storage-provider/get.md | 17 ++ .../pspace/storage-provider/help/commands.md | 23 ++ .assets/pspace/storage-provider/help/help.md | 30 ++ .assets/pspace/storage-provider/list.md | 28 ++ .../storage-provider/storage-provider.md | 37 +++ .../storage-provider/update/help/commands.md | 23 ++ .../storage-provider/update/help/help.md | 30 ++ .assets/pspace/storage-provider/update/s3.md | 26 ++ .../pspace/storage-provider/update/update.md | 24 ++ .assets/pspace/up.md | 22 +- .assets/pspace/upgrade.md | 16 +- .assets/pspace/version.md | 16 +- .scripts/generate-docs.ts | 53 ++-- 179 files changed, 4242 insertions(+), 3431 deletions(-) delete mode 100644 .assets/pspace/autoscaling-group.md create mode 100644 .assets/pspace/autoscaling-group/autoscaling-group.md create mode 100644 .assets/pspace/autoscaling-group/create.md create mode 100644 .assets/pspace/autoscaling-group/delete.md create mode 100644 .assets/pspace/autoscaling-group/get.md create mode 100644 .assets/pspace/autoscaling-group/help/commands.md create mode 100644 .assets/pspace/autoscaling-group/help/help.md create mode 100644 .assets/pspace/autoscaling-group/list.md create mode 100644 .assets/pspace/autoscaling-group/update.md delete mode 100644 .assets/pspace/completion.md create mode 100644 .assets/pspace/completion/bash.md create mode 100644 .assets/pspace/completion/completion.md create mode 100644 .assets/pspace/completion/fish.md create mode 100644 .assets/pspace/completion/help/commands.md create mode 100644 .assets/pspace/completion/help/help.md create mode 100644 .assets/pspace/completion/zsh.md delete mode 100644 .assets/pspace/config.md create mode 100644 .assets/pspace/config/config.md create mode 100644 .assets/pspace/config/delete.md create mode 100644 .assets/pspace/config/get.md create mode 100644 .assets/pspace/config/help/commands.md create mode 100644 .assets/pspace/config/help/help.md create mode 100644 .assets/pspace/config/set.md delete mode 100644 .assets/pspace/custom-template.md create mode 100644 .assets/pspace/custom-template/create.md create mode 100644 .assets/pspace/custom-template/custom-template.md create mode 100644 .assets/pspace/custom-template/delete.md create mode 100644 .assets/pspace/custom-template/get.md create mode 100644 .assets/pspace/custom-template/help/commands.md create mode 100644 .assets/pspace/custom-template/help/help.md create mode 100644 .assets/pspace/custom-template/list.md delete mode 100644 .assets/pspace/dataset.md create mode 100644 .assets/pspace/dataset/create.md create mode 100644 .assets/pspace/dataset/dataset.md create mode 100644 .assets/pspace/dataset/delete.md create mode 100644 .assets/pspace/dataset/get.md create mode 100644 .assets/pspace/dataset/help/commands.md create mode 100644 .assets/pspace/dataset/help/help.md create mode 100644 .assets/pspace/dataset/list.md create mode 100644 .assets/pspace/dataset/update.md create mode 100644 .assets/pspace/dataset/versions/create.md create mode 100644 .assets/pspace/dataset/versions/delete.md create mode 100644 .assets/pspace/dataset/versions/get.md create mode 100644 .assets/pspace/dataset/versions/help/commands.md create mode 100644 .assets/pspace/dataset/versions/help/help.md create mode 100644 .assets/pspace/dataset/versions/list.md create mode 100644 .assets/pspace/dataset/versions/update.md create mode 100644 .assets/pspace/dataset/versions/versions.md delete mode 100644 .assets/pspace/deployment.md create mode 100644 .assets/pspace/deployment/delete.md create mode 100644 .assets/pspace/deployment/deployment.md create mode 100644 .assets/pspace/deployment/get.md create mode 100644 .assets/pspace/deployment/help/commands.md create mode 100644 .assets/pspace/deployment/help/help.md create mode 100644 .assets/pspace/deployment/list.md create mode 100644 .assets/pspace/deployment/up.md delete mode 100644 .assets/pspace/help.md create mode 100644 .assets/pspace/help/commands.md create mode 100644 .assets/pspace/help/help.md delete mode 100644 .assets/pspace/machine-event.md create mode 100644 .assets/pspace/machine-event/get.md create mode 100644 .assets/pspace/machine-event/help/commands.md create mode 100644 .assets/pspace/machine-event/help/help.md create mode 100644 .assets/pspace/machine-event/list.md create mode 100644 .assets/pspace/machine-event/machine-event.md delete mode 100644 .assets/pspace/machine.md create mode 100644 .assets/pspace/machine/create.md create mode 100644 .assets/pspace/machine/delete.md create mode 100644 .assets/pspace/machine/get.md create mode 100644 .assets/pspace/machine/help/commands.md create mode 100644 .assets/pspace/machine/help/help.md create mode 100644 .assets/pspace/machine/list.md create mode 100644 .assets/pspace/machine/machine.md create mode 100644 .assets/pspace/machine/restart.md create mode 100644 .assets/pspace/machine/start.md create mode 100644 .assets/pspace/machine/stop.md create mode 100644 .assets/pspace/machine/update.md delete mode 100644 .assets/pspace/model.md create mode 100644 .assets/pspace/model/create.md create mode 100644 .assets/pspace/model/delete.md create mode 100644 .assets/pspace/model/get.md create mode 100644 .assets/pspace/model/help/commands.md create mode 100644 .assets/pspace/model/help/help.md create mode 100644 .assets/pspace/model/list.md create mode 100644 .assets/pspace/model/model.md delete mode 100644 .assets/pspace/os-template.md create mode 100644 .assets/pspace/os-template/help/commands.md create mode 100644 .assets/pspace/os-template/help/help.md create mode 100644 .assets/pspace/os-template/list.md create mode 100644 .assets/pspace/os-template/os-template.md delete mode 100644 .assets/pspace/private-network.md create mode 100644 .assets/pspace/private-network/create.md create mode 100644 .assets/pspace/private-network/delete.md create mode 100644 .assets/pspace/private-network/get.md create mode 100644 .assets/pspace/private-network/help/commands.md create mode 100644 .assets/pspace/private-network/help/help.md create mode 100644 .assets/pspace/private-network/list.md create mode 100644 .assets/pspace/private-network/private-network.md delete mode 100644 .assets/pspace/project.md create mode 100644 .assets/pspace/project/create.md create mode 100644 .assets/pspace/project/delete.md create mode 100644 .assets/pspace/project/get.md create mode 100644 .assets/pspace/project/help/commands.md create mode 100644 .assets/pspace/project/help/help.md create mode 100644 .assets/pspace/project/link.md create mode 100644 .assets/pspace/project/list.md create mode 100644 .assets/pspace/project/project.md create mode 100644 .assets/pspace/project/update.md delete mode 100644 .assets/pspace/public-ip.md create mode 100644 .assets/pspace/public-ip/assign.md create mode 100644 .assets/pspace/public-ip/claim.md create mode 100644 .assets/pspace/public-ip/help/commands.md create mode 100644 .assets/pspace/public-ip/help/help.md create mode 100644 .assets/pspace/public-ip/list.md create mode 100644 .assets/pspace/public-ip/public-ip.md create mode 100644 .assets/pspace/public-ip/release.md delete mode 100644 .assets/pspace/secret.md create mode 100644 .assets/pspace/secret/create.md create mode 100644 .assets/pspace/secret/delete.md create mode 100644 .assets/pspace/secret/get.md create mode 100644 .assets/pspace/secret/help/commands.md create mode 100644 .assets/pspace/secret/help/help.md create mode 100644 .assets/pspace/secret/list.md create mode 100644 .assets/pspace/secret/secret.md create mode 100644 .assets/pspace/secret/update.md delete mode 100644 .assets/pspace/shared-drive.md create mode 100644 .assets/pspace/shared-drive/create.md create mode 100644 .assets/pspace/shared-drive/delete.md create mode 100644 .assets/pspace/shared-drive/get.md create mode 100644 .assets/pspace/shared-drive/help/commands.md create mode 100644 .assets/pspace/shared-drive/help/help.md create mode 100644 .assets/pspace/shared-drive/list.md create mode 100644 .assets/pspace/shared-drive/shared-drive.md delete mode 100644 .assets/pspace/snapshot.md create mode 100644 .assets/pspace/snapshot/create.md create mode 100644 .assets/pspace/snapshot/delete.md create mode 100644 .assets/pspace/snapshot/help/commands.md create mode 100644 .assets/pspace/snapshot/help/help.md create mode 100644 .assets/pspace/snapshot/list.md create mode 100644 .assets/pspace/snapshot/restore.md create mode 100644 .assets/pspace/snapshot/snapshot.md delete mode 100644 .assets/pspace/startup-script.md create mode 100644 .assets/pspace/startup-script/assign.md create mode 100644 .assets/pspace/startup-script/create.md create mode 100644 .assets/pspace/startup-script/delete.md create mode 100644 .assets/pspace/startup-script/get.md create mode 100644 .assets/pspace/startup-script/help/commands.md create mode 100644 .assets/pspace/startup-script/help/help.md create mode 100644 .assets/pspace/startup-script/list.md create mode 100644 .assets/pspace/startup-script/startup-script.md create mode 100644 .assets/pspace/startup-script/unassign.md create mode 100644 .assets/pspace/startup-script/update.md delete mode 100644 .assets/pspace/storage-provider.md create mode 100644 .assets/pspace/storage-provider/create/create.md create mode 100644 .assets/pspace/storage-provider/create/help/commands.md create mode 100644 .assets/pspace/storage-provider/create/help/help.md create mode 100644 .assets/pspace/storage-provider/create/s3.md create mode 100644 .assets/pspace/storage-provider/delete.md create mode 100644 .assets/pspace/storage-provider/get.md create mode 100644 .assets/pspace/storage-provider/help/commands.md create mode 100644 .assets/pspace/storage-provider/help/help.md create mode 100644 .assets/pspace/storage-provider/list.md create mode 100644 .assets/pspace/storage-provider/storage-provider.md create mode 100644 .assets/pspace/storage-provider/update/help/commands.md create mode 100644 .assets/pspace/storage-provider/update/help/help.md create mode 100644 .assets/pspace/storage-provider/update/s3.md create mode 100644 .assets/pspace/storage-provider/update/update.md diff --git a/.assets/pspace.json b/.assets/pspace.json index b5fc660..cacd3e3 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-23T22:39:21.821Z", + "buildDate": "2024-05-29T18:11:30.955Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md deleted file mode 100644 index ec680e8..0000000 --- a/.assets/pspace/autoscaling-group.md +++ /dev/null @@ -1,196 +0,0 @@ -## pspace autoscaling-group - -Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes -cluster-autoscaler to automatically scale your cluster. You can also autoscaling -groups as a primitive for your own autoscaler. - -### Usage - -``` -pspace autoscaling-group [command] -pspace autoscaling-group [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace autoscaling-group create - -Create an autoscaling group. - -### Usage - -``` -pspace autoscaling-group create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group delete - -Delete an autoscaling group from a team. - -### Usage - -``` -pspace autoscaling-group delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group get - -Get an autoscaling group from a team. - -### Usage - -``` -pspace autoscaling-group get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group help - -Show help for a autoscaling-group command - -### Usage - -``` -pspace autoscaling-group help [command] -pspace autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace autoscaling-group list - -List autoscaling groups in your team. - -Pick a subset of fields to display: - -``` -pspace autoscaling-group list -F name -F dtCreated -``` - -### Usage - -``` -pspace autoscaling-group list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------ | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace autoscaling-group update - -Update an autoscaling group. - -### Usage - -``` -pspace autoscaling-group update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/autoscaling-group/autoscaling-group.md b/.assets/pspace/autoscaling-group/autoscaling-group.md new file mode 100644 index 0000000..692d5d9 --- /dev/null +++ b/.assets/pspace/autoscaling-group/autoscaling-group.md @@ -0,0 +1,37 @@ +Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes +cluster-autoscaler to automatically scale your cluster. You can also autoscaling +groups as a primitive for your own autoscaler. + +### Usage + +``` +pspace autoscaling-group [command] +pspace autoscaling-group [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------------- | +| `create` | Create an autoscaling group. | +| `delete` | Delete an autoscaling group from a team. | +| `get` | Get an autoscaling group from a team. | +| `help` | Show help for a autoscaling-group command | +| `list` | List autoscaling groups in your team. | + +Pick a subset of fields to display: + +```` +pspace autoscaling-group list -F name -F dtCreated +``` | +| `update` | Update an autoscaling group. | +```` diff --git a/.assets/pspace/autoscaling-group/create.md b/.assets/pspace/autoscaling-group/create.md new file mode 100644 index 0000000..585e9bf --- /dev/null +++ b/.assets/pspace/autoscaling-group/create.md @@ -0,0 +1,26 @@ +Create an autoscaling group. + +### Usage + +``` +pspace autoscaling-group create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the autoscaling group | true | +| `cluster-id` | | The ID of the cluster | true | +| `machine-type` | | The machine type for the autoscaling group | true | +| `network-id` | | The ID of the network for the autoscaling group | true | +| `template-id` | | The ID of the template for the autoscaling group | true | +| `startup-script-id` | | The ID of the startup script for the autoscaling group | true | +| `max` | | The maximum number of active machines in the autoscaling group | true | +| `min` | | The minimum number of active machines in the autoscaling group | true | +| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/delete.md b/.assets/pspace/autoscaling-group/delete.md new file mode 100644 index 0000000..abf3102 --- /dev/null +++ b/.assets/pspace/autoscaling-group/delete.md @@ -0,0 +1,17 @@ +Delete an autoscaling group from a team. + +### Usage + +``` +pspace autoscaling-group delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/get.md b/.assets/pspace/autoscaling-group/get.md new file mode 100644 index 0000000..6714683 --- /dev/null +++ b/.assets/pspace/autoscaling-group/get.md @@ -0,0 +1,17 @@ +Get an autoscaling group from a team. + +### Usage + +``` +pspace autoscaling-group get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md new file mode 100644 index 0000000..f854ade --- /dev/null +++ b/.assets/pspace/autoscaling-group/help/commands.md @@ -0,0 +1,23 @@ +List autoscaling-group commands + +Example: + +``` +$ pspace autoscaling-group help commands commands +``` + +### Usage + +``` +pspace autoscaling-group help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/autoscaling-group/help/help.md b/.assets/pspace/autoscaling-group/help/help.md new file mode 100644 index 0000000..304c022 --- /dev/null +++ b/.assets/pspace/autoscaling-group/help/help.md @@ -0,0 +1,30 @@ +Show help for a autoscaling-group command + +### Usage + +``` +pspace autoscaling-group help [command] +pspace autoscaling-group help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------- | +| `commands` | List autoscaling-group commands | + +Example: + +```` +$ pspace autoscaling-group help commands commands +``` | +```` diff --git a/.assets/pspace/autoscaling-group/list.md b/.assets/pspace/autoscaling-group/list.md new file mode 100644 index 0000000..155f296 --- /dev/null +++ b/.assets/pspace/autoscaling-group/list.md @@ -0,0 +1,30 @@ +List autoscaling groups in your team. + +Pick a subset of fields to display: + +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +### Usage + +``` +pspace autoscaling-group list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `cluster-id` | | Filter by cluster ID. | false | +| `machine-type` | | Filter by machine type. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/update.md b/.assets/pspace/autoscaling-group/update.md new file mode 100644 index 0000000..fce5232 --- /dev/null +++ b/.assets/pspace/autoscaling-group/update.md @@ -0,0 +1,27 @@ +Update an autoscaling group. + +### Usage + +``` +pspace autoscaling-group update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the autoscaling group | false | +| `cluster-id` | | The ID of the cluster | false | +| `machine-type` | | The machine type for the autoscaling group | false | +| `network-id` | | The ID of the network for the autoscaling group | false | +| `template-id` | | The ID of the template for the autoscaling group | false | +| `startup-script-id` | | The ID of the startup script for the autoscaling group | false | +| `max` | | The maximum number of active machines in the autoscaling group | false | +| `min` | | The minimum number of active machines in the autoscaling group | false | +| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| `current` | | The desired number of active machines in the autoscaling group | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md deleted file mode 100644 index f4f6911..0000000 --- a/.assets/pspace/completion.md +++ /dev/null @@ -1,184 +0,0 @@ -## pspace completion - -Generate an autocompletion script for pspace in the specified shell. See each -sub-command's help for details on how to use the generated script. - -### Usage - -``` -pspace completion [command] -pspace completion [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [bash](#bash) -- [fish](#fish) -- [help](#help) -- [zsh](#zsh) - -## pspace completion bash - -Generate the autocompletion script for the bash shell. - -This script depends on the `bash-completion` package. If it is not installed -already, you can install it via your OS's package manager. - -To load completions in your current shell session: - -``` -$ source <(pspace completion bash bash) -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ pspace completion bash bash > /etc/bash_completion.d/pspace -``` - -macOS: - -``` -$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -pspace completion bash [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace completion fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - -``` -$ pspace completion fish fish | source -``` - -To load completions for every new session, execute once: - -``` -$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -pspace completion fish [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace completion help - -Show help for a completion command - -### Usage - -``` -pspace completion help [command] -pspace completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace completion zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need to -enable it. You can execute the following once: - -``` -$ echo "autoload -U compinit; compinit" >> ~/.zshrc -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ pspace completion zsh zsh > "${fpath[1]}/_pspace" -``` - -macOS: - -``` -$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace -``` - -Oh My Zsh: - -``` -$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -pspace completion zsh [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/completion/bash.md b/.assets/pspace/completion/bash.md new file mode 100644 index 0000000..b2ada56 --- /dev/null +++ b/.assets/pspace/completion/bash.md @@ -0,0 +1,41 @@ +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. + +To load completions in your current shell session: + +``` +$ source <(pspace completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: + +``` +$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion bash [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion/completion.md b/.assets/pspace/completion/completion.md new file mode 100644 index 0000000..6cabf78 --- /dev/null +++ b/.assets/pspace/completion/completion.md @@ -0,0 +1,95 @@ +Generate an autocompletion script for pspace in the specified shell. See each +sub-command's help for details on how to use the generated script. + +### Usage + +``` +pspace completion [command] +pspace completion [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------------------------ | +| `bash` | Generate the autocompletion script for the bash shell. | + +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. + +To load completions in your current shell session: + +``` +$ source <(pspace completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: + +``` +$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. | | `fish` | +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + +``` +$ pspace completion fish fish | source +``` + +To load completions for every new session, execute once: + +``` +$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. | | `help` | +Show help for a completion command | | `zsh` | Generate the autocompletion +script for the zsh shell. + +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: + +``` +$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: + +``` +$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. | diff --git a/.assets/pspace/completion/fish.md b/.assets/pspace/completion/fish.md new file mode 100644 index 0000000..faead47 --- /dev/null +++ b/.assets/pspace/completion/fish.md @@ -0,0 +1,31 @@ +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + +``` +$ pspace completion fish fish | source +``` + +To load completions for every new session, execute once: + +``` +$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion fish [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `no-descriptions` | | Disable completion descriptions | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md new file mode 100644 index 0000000..4500f6e --- /dev/null +++ b/.assets/pspace/completion/help/commands.md @@ -0,0 +1,23 @@ +List completion commands + +Example: + +``` +$ pspace completion help commands commands +``` + +### Usage + +``` +pspace completion help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/completion/help/help.md b/.assets/pspace/completion/help/help.md new file mode 100644 index 0000000..04dfc22 --- /dev/null +++ b/.assets/pspace/completion/help/help.md @@ -0,0 +1,30 @@ +Show help for a completion command + +### Usage + +``` +pspace completion help [command] +pspace completion help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------ | +| `commands` | List completion commands | + +Example: + +```` +$ pspace completion help commands commands +``` | +```` diff --git a/.assets/pspace/completion/zsh.md b/.assets/pspace/completion/zsh.md new file mode 100644 index 0000000..cecdb27 --- /dev/null +++ b/.assets/pspace/completion/zsh.md @@ -0,0 +1,46 @@ +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: + +``` +$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: + +``` +$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion zsh [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `no-descriptions` | | Disable completion descriptions | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md deleted file mode 100644 index 09ff3b0..0000000 --- a/.assets/pspace/config.md +++ /dev/null @@ -1,130 +0,0 @@ -## pspace config - -This command manages your Paperspace configuration. You can use it to set, get, -and delete configuration values. Running this command without any subcommands -will print your current configuration. - -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. - -For example, to set the current team, run: - -``` -pspace config set team "my-team" -``` - -### Usage - -``` -pspace config [command] -pspace config [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [set](#set) - -## pspace config delete - -Delete a configuration value. - -### Usage - -``` -pspace config delete [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace config get - -This command gets a configuration value. You can pass a key to get a specific -value, or you can pass no arguments to get all configuration values. - -For example, to get the current team run: - -``` -pspace config get team -``` - -### Usage - -``` -pspace config get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace config help - -Show help for a config command - -### Usage - -``` -pspace config help [command] -pspace config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace config set - -Set a configuration value. - -### Usage - -``` -pspace config set [arguments] [arguments...] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/config/config.md b/.assets/pspace/config/config.md new file mode 100644 index 0000000..8777cef --- /dev/null +++ b/.assets/pspace/config/config.md @@ -0,0 +1,44 @@ +This command manages your Paperspace configuration. You can use it to set, get, +and delete configuration values. Running this command without any subcommands +will print your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: + +``` +pspace config set team "my-team" +``` + +### Usage + +``` +pspace config [command] +pspace config [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `delete` | Delete a configuration value. | +| `get` | This command gets a configuration value. You can pass a key to get a specific | +| value, or you can pass no arguments to get all configuration values. | | + +For example, to get the current team run: + +```` +pspace config get team +``` | +| `help` | Show help for a config command | +| `set` | Set a configuration value. | +```` diff --git a/.assets/pspace/config/delete.md b/.assets/pspace/config/delete.md new file mode 100644 index 0000000..c48556d --- /dev/null +++ b/.assets/pspace/config/delete.md @@ -0,0 +1,16 @@ +Delete a configuration value. + +### Usage + +``` +pspace config delete [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config/get.md b/.assets/pspace/config/get.md new file mode 100644 index 0000000..aced795 --- /dev/null +++ b/.assets/pspace/config/get.md @@ -0,0 +1,23 @@ +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: + +``` +pspace config get team +``` + +### Usage + +``` +pspace config get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md new file mode 100644 index 0000000..6e8b19c --- /dev/null +++ b/.assets/pspace/config/help/commands.md @@ -0,0 +1,23 @@ +List config commands + +Example: + +``` +$ pspace config help commands commands +``` + +### Usage + +``` +pspace config help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/config/help/help.md b/.assets/pspace/config/help/help.md new file mode 100644 index 0000000..bf314ee --- /dev/null +++ b/.assets/pspace/config/help/help.md @@ -0,0 +1,30 @@ +Show help for a config command + +### Usage + +``` +pspace config help [command] +pspace config help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------- | +| `commands` | List config commands | + +Example: + +```` +$ pspace config help commands commands +``` | +```` diff --git a/.assets/pspace/config/set.md b/.assets/pspace/config/set.md new file mode 100644 index 0000000..7499101 --- /dev/null +++ b/.assets/pspace/config/set.md @@ -0,0 +1,16 @@ +Set a configuration value. + +### Usage + +``` +pspace config set [arguments] [arguments...] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md index 1034deb..3bc9af7 100644 --- a/.assets/pspace/console.md +++ b/.assets/pspace/console.md @@ -1,5 +1,3 @@ -## pspace console - This command opens the Paperspace web console in your browser. ### Usage @@ -10,11 +8,9 @@ pspace console [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md deleted file mode 100644 index 8af51ca..0000000 --- a/.assets/pspace/custom-template.md +++ /dev/null @@ -1,159 +0,0 @@ -## pspace custom-template - -Manage your custom templates. Custom templates are a backup of your machine's -disk. They can be used to create additional machines. You can use them to -prepopulate a machine with your desired software stack. - -For more information, see https://docs.paperspace.com/compute/custom-templates. - -### Usage - -``` -pspace custom-template [command] -pspace custom-template [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace custom-template create - -Create a custom template from a machine. - -### Usage - -``` -pspace custom-template create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template delete - -Delete a custom template from a team. - -### Usage - -``` -pspace custom-template delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template get - -Get a custom template from a team. - -### Usage - -``` -pspace custom-template get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace custom-template help - -Show help for a custom-template command - -### Usage - -``` -pspace custom-template help [command] -pspace custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace custom-template list - -List custom templates in your team. - -Pick a subset of fields to display: - -``` -pspace custom-template list -F name -F dtModified -``` - -### Usage - -``` -pspace custom-template list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/custom-template/create.md b/.assets/pspace/custom-template/create.md new file mode 100644 index 0000000..0ae3b78 --- /dev/null +++ b/.assets/pspace/custom-template/create.md @@ -0,0 +1,19 @@ +Create a custom template from a machine. + +### Usage + +``` +pspace custom-template create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the custom template | true | +| `machine-id` | m | The ID of the machine to create a custom template from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/custom-template.md b/.assets/pspace/custom-template/custom-template.md new file mode 100644 index 0000000..fc73db2 --- /dev/null +++ b/.assets/pspace/custom-template/custom-template.md @@ -0,0 +1,38 @@ +Manage your custom templates. Custom templates are a backup of your machine's +disk. They can be used to create additional machines. You can use them to +prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +### Usage + +``` +pspace custom-template [command] +pspace custom-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------------------------- | +| `create` | Create a custom template from a machine. | +| `delete` | Delete a custom template from a team. | +| `get` | Get a custom template from a team. | +| `help` | Show help for a custom-template command | +| `list` | List custom templates in your team. | + +Pick a subset of fields to display: + +```` +pspace custom-template list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/custom-template/delete.md b/.assets/pspace/custom-template/delete.md new file mode 100644 index 0000000..4696c75 --- /dev/null +++ b/.assets/pspace/custom-template/delete.md @@ -0,0 +1,17 @@ +Delete a custom template from a team. + +### Usage + +``` +pspace custom-template delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/get.md b/.assets/pspace/custom-template/get.md new file mode 100644 index 0000000..d174194 --- /dev/null +++ b/.assets/pspace/custom-template/get.md @@ -0,0 +1,17 @@ +Get a custom template from a team. + +### Usage + +``` +pspace custom-template get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md new file mode 100644 index 0000000..f2573c4 --- /dev/null +++ b/.assets/pspace/custom-template/help/commands.md @@ -0,0 +1,23 @@ +List custom-template commands + +Example: + +``` +$ pspace custom-template help commands commands +``` + +### Usage + +``` +pspace custom-template help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/custom-template/help/help.md b/.assets/pspace/custom-template/help/help.md new file mode 100644 index 0000000..a28c476 --- /dev/null +++ b/.assets/pspace/custom-template/help/help.md @@ -0,0 +1,30 @@ +Show help for a custom-template command + +### Usage + +``` +pspace custom-template help [command] +pspace custom-template help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------- | +| `commands` | List custom-template commands | + +Example: + +```` +$ pspace custom-template help commands commands +``` | +```` diff --git a/.assets/pspace/custom-template/list.md b/.assets/pspace/custom-template/list.md new file mode 100644 index 0000000..fb9e01f --- /dev/null +++ b/.assets/pspace/custom-template/list.md @@ -0,0 +1,31 @@ +List custom templates in your team. + +Pick a subset of fields to display: + +``` +pspace custom-template list -F name -F dtModified +``` + +### Usage + +``` +pspace custom-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md deleted file mode 100644 index c6fd0e6..0000000 --- a/.assets/pspace/dataset.md +++ /dev/null @@ -1,213 +0,0 @@ -## pspace dataset - -Manage your datasets. - -For more information, see https://docs.paperspace.com/storage/datasets. - -### Usage - -``` -pspace dataset [command] -pspace dataset [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -- [versions](#versions) - -## pspace dataset create - -Create a dataset. - -### Usage - -``` -pspace dataset create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset delete - -Delete a dataset from a team. - -### Usage - -``` -pspace dataset delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset get - -Get a dataset from a team. - -### Usage - -``` -pspace dataset get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset help - -Show help for a dataset command - -### Usage - -``` -pspace dataset help [command] -pspace dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace dataset list - -List datasets in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset list -F name -F dtModified -``` - -### Usage - -``` -pspace dataset list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset update - -Update a dataset in a project or team. - -### Usage - -``` -pspace dataset update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace dataset versions - -Manage your dataset versions. - -For more information, see https://docs.paperspace.com/storage/datasetVersions. - -### Usage - -``` -pspace dataset versions [command] -pspace dataset versions [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) diff --git a/.assets/pspace/dataset/create.md b/.assets/pspace/dataset/create.md new file mode 100644 index 0000000..c18285a --- /dev/null +++ b/.assets/pspace/dataset/create.md @@ -0,0 +1,21 @@ +Create a dataset. + +### Usage + +``` +pspace dataset create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the dataset | true | +| `description` | | The description of the dataset | false | +| `storage-provider-id` | | The ID of the storage provider to use for the dataset | false | +| `is-public` | | Whether the dataset is public | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/dataset.md b/.assets/pspace/dataset/dataset.md new file mode 100644 index 0000000..21eb311 --- /dev/null +++ b/.assets/pspace/dataset/dataset.md @@ -0,0 +1,40 @@ +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +### Usage + +``` +pspace dataset [command] +pspace dataset [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------------------------- | +| `create` | Create a dataset. | +| `delete` | Delete a dataset from a team. | +| `get` | Get a dataset from a team. | +| `help` | Show help for a dataset command | +| `list` | List datasets in your team or project. | + +Pick a subset of fields to display: + +```` +pspace dataset list -F name -F dtModified +``` | +| `update` | Update a dataset in a project or team. | +| `versions` | Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. | +```` diff --git a/.assets/pspace/dataset/delete.md b/.assets/pspace/dataset/delete.md new file mode 100644 index 0000000..4d8127b --- /dev/null +++ b/.assets/pspace/dataset/delete.md @@ -0,0 +1,17 @@ +Delete a dataset from a team. + +### Usage + +``` +pspace dataset delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/get.md b/.assets/pspace/dataset/get.md new file mode 100644 index 0000000..0d59800 --- /dev/null +++ b/.assets/pspace/dataset/get.md @@ -0,0 +1,17 @@ +Get a dataset from a team. + +### Usage + +``` +pspace dataset get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md new file mode 100644 index 0000000..a69e176 --- /dev/null +++ b/.assets/pspace/dataset/help/commands.md @@ -0,0 +1,23 @@ +List dataset commands + +Example: + +``` +$ pspace dataset help commands commands +``` + +### Usage + +``` +pspace dataset help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/help/help.md b/.assets/pspace/dataset/help/help.md new file mode 100644 index 0000000..1e6a334 --- /dev/null +++ b/.assets/pspace/dataset/help/help.md @@ -0,0 +1,30 @@ +Show help for a dataset command + +### Usage + +``` +pspace dataset help [command] +pspace dataset help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------- | +| `commands` | List dataset commands | + +Example: + +```` +$ pspace dataset help commands commands +``` | +```` diff --git a/.assets/pspace/dataset/list.md b/.assets/pspace/dataset/list.md new file mode 100644 index 0000000..d8dd614 --- /dev/null +++ b/.assets/pspace/dataset/list.md @@ -0,0 +1,28 @@ +List datasets in your team or project. + +Pick a subset of fields to display: + +``` +pspace dataset list -F name -F dtModified +``` + +### Usage + +``` +pspace dataset list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/update.md b/.assets/pspace/dataset/update.md new file mode 100644 index 0000000..cfb5855 --- /dev/null +++ b/.assets/pspace/dataset/update.md @@ -0,0 +1,19 @@ +Update a dataset in a project or team. + +### Usage + +``` +pspace dataset update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the dataset | true | +| `description` | | The description of the dataset | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/create.md b/.assets/pspace/dataset/versions/create.md new file mode 100644 index 0000000..63716c3 --- /dev/null +++ b/.assets/pspace/dataset/versions/create.md @@ -0,0 +1,19 @@ +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +### Usage + +``` +pspace dataset versions create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `tags` | | The tags for the version, comma-delimited | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/delete.md b/.assets/pspace/dataset/versions/delete.md new file mode 100644 index 0000000..2740ff4 --- /dev/null +++ b/.assets/pspace/dataset/versions/delete.md @@ -0,0 +1,18 @@ +Delete a dataset version from a team. This command will prompt you for an ID if +you don't provide one. + +### Usage + +``` +pspace dataset versions delete [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/get.md b/.assets/pspace/dataset/versions/get.md new file mode 100644 index 0000000..d9e84a4 --- /dev/null +++ b/.assets/pspace/dataset/versions/get.md @@ -0,0 +1,18 @@ +Get a dataset version from a team. This command will prompt you for an ID if you +don't provide one. + +### Usage + +``` +pspace dataset versions get [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md new file mode 100644 index 0000000..0c9ecb4 --- /dev/null +++ b/.assets/pspace/dataset/versions/help/commands.md @@ -0,0 +1,23 @@ +List versions commands + +Example: + +``` +$ pspace dataset versions help commands commands +``` + +### Usage + +``` +pspace dataset versions help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/versions/help/help.md b/.assets/pspace/dataset/versions/help/help.md new file mode 100644 index 0000000..9f171db --- /dev/null +++ b/.assets/pspace/dataset/versions/help/help.md @@ -0,0 +1,30 @@ +Show help for a versions command + +### Usage + +``` +pspace dataset versions help [command] +pspace dataset versions help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------- | +| `commands` | List versions commands | + +Example: + +```` +$ pspace dataset versions help commands commands +``` | +```` diff --git a/.assets/pspace/dataset/versions/list.md b/.assets/pspace/dataset/versions/list.md new file mode 100644 index 0000000..8d1fd63 --- /dev/null +++ b/.assets/pspace/dataset/versions/list.md @@ -0,0 +1,28 @@ +List dataset versions in your team or project. + +Pick a subset of fields to display: + +``` +pspace dataset versions list -F name -F dtModified +``` + +### Usage + +``` +pspace dataset versions list [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/update.md b/.assets/pspace/dataset/versions/update.md new file mode 100644 index 0000000..0d47770 --- /dev/null +++ b/.assets/pspace/dataset/versions/update.md @@ -0,0 +1,19 @@ +Update a dataset version in a project or team. + +### Usage + +``` +pspace dataset versions update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `message` | m | The description of the dataset version | true | +| `tags` | | The tags for the version, comma-delimited | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/versions.md b/.assets/pspace/dataset/versions/versions.md new file mode 100644 index 0000000..1dcee84 --- /dev/null +++ b/.assets/pspace/dataset/versions/versions.md @@ -0,0 +1,40 @@ +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +### Usage + +``` +pspace dataset versions [command] +pspace dataset versions [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ------------------------- | ----------------------------------------------------------------------------- | +| `create` | Create a dataset version. This command will prompt you for an ID if you don't | +| provide one. | | +| `delete` | Delete a dataset version from a team. This command will prompt you for an ID | +| if you don't provide one. | | +| `get` | Get a dataset version from a team. This command will prompt you for an ID | +| if you don't provide one. | | +| `help` | Show help for a versions command | +| `list` | List dataset versions in your team or project. | + +Pick a subset of fields to display: + +```` +pspace dataset versions list -F name -F dtModified +``` | +| `update` | Update a dataset version in a project or team. | +```` diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md deleted file mode 100644 index c5c3f2d..0000000 --- a/.assets/pspace/deployment.md +++ /dev/null @@ -1,205 +0,0 @@ -## pspace deployment - -Effortlessly deploy ML apps to Paperspace. - -### Usage - -``` -pspace deployment [command] -pspace deployment [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [up](#up) - -## pspace deployment delete - -Delete a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 -``` - -### Usage - -``` -pspace deployment delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment get - -Get a deployment by its ID. If you don't provide an ID, this command will prompt -you for one based on the deployments you have access to. - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -``` - -Pick a subset of fields to display: - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name -``` - -### Usage - -``` -pspace deployment get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment help - -Show help for a deployment command - -### Usage - -``` -pspace deployment help [command] -pspace deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace deployment list - -List deployments in your team. - -Pick a subset of fields to display: - -``` -pspace deployment list -F id -F name -``` - -### Usage - -``` -pspace deployment list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace deployment up - -This will create a new deployment for your app or update it if it already -exists. You can optionally specify a path to a config file. If no config file is -specified, the default config file paths will be tried. - -Create a new deployment for the app in the current directory. - -``` -$ pspace deployment create -``` - -Create a new deployment using a config file. - -``` -$ pspace deployment create -c paperspace.json -``` - -Create a new deployment for an app in a different directory. - -``` -$ pspace deployment create --cwd ../my-app -``` - -Create a new deployment for an app in a specific project. - -``` -$ pspace deployment create --project-id 1234 -``` - -### Usage - -``` -pspace deployment up [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------ | ------- | ----------------------------------------------------------------------- | -------- | -| config | c | The path to the config file. Defaults to our default config file paths. | | - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to - deploy to. | false | | cwd | | The directory to deploy the app from. Defaults - to the current directory. | false | | log-level | l | Enable debug logging. | - false | | json | j | Output JSON | false | | api-key | | A Paperspace public - API Key used for authenticating requests | false | | help | h | Show help for - a command | false | - -#### Subcommands diff --git a/.assets/pspace/deployment/delete.md b/.assets/pspace/deployment/delete.md new file mode 100644 index 0000000..c7e4bab --- /dev/null +++ b/.assets/pspace/deployment/delete.md @@ -0,0 +1,21 @@ +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +### Usage + +``` +pspace deployment delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/deployment.md b/.assets/pspace/deployment/deployment.md new file mode 100644 index 0000000..a163eaa --- /dev/null +++ b/.assets/pspace/deployment/deployment.md @@ -0,0 +1,79 @@ +Effortlessly deploy ML apps to Paperspace. + +### Usage + +``` +pspace deployment [command] +pspace deployment [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| --------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `delete` | Delete a deployment by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the deployments you have access to. | | + +```` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` | +| `get` | Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. +```` + +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 + +``` +Pick a subset of fields to display: +``` + +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name + +```| +| `help` | Show help for a deployment command | +| `list` | List deployments in your team. + +Pick a subset of fields to display: +``` + +pspace deployment list -F id -F name + +```| +| `up` | This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` + +$ pspace deployment create + +``` +Create a new deployment using a config file. +``` + +$ pspace deployment create -c paperspace.json + +``` +Create a new deployment for an app in a different directory. +``` + +$ pspace deployment create --cwd ../my-app + +``` +Create a new deployment for an app in a specific project. +``` + +$ pspace deployment create --project-id 1234 + +```| +``` diff --git a/.assets/pspace/deployment/get.md b/.assets/pspace/deployment/get.md new file mode 100644 index 0000000..855fabc --- /dev/null +++ b/.assets/pspace/deployment/get.md @@ -0,0 +1,28 @@ +Get a deployment by its ID. If you don't provide an ID, this command will prompt +you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +### Usage + +``` +pspace deployment get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md new file mode 100644 index 0000000..428ac20 --- /dev/null +++ b/.assets/pspace/deployment/help/commands.md @@ -0,0 +1,23 @@ +List deployment commands + +Example: + +``` +$ pspace deployment help commands commands +``` + +### Usage + +``` +pspace deployment help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/deployment/help/help.md b/.assets/pspace/deployment/help/help.md new file mode 100644 index 0000000..6d9eabd --- /dev/null +++ b/.assets/pspace/deployment/help/help.md @@ -0,0 +1,30 @@ +Show help for a deployment command + +### Usage + +``` +pspace deployment help [command] +pspace deployment help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------ | +| `commands` | List deployment commands | + +Example: + +```` +$ pspace deployment help commands commands +``` | +```` diff --git a/.assets/pspace/deployment/list.md b/.assets/pspace/deployment/list.md new file mode 100644 index 0000000..02723c4 --- /dev/null +++ b/.assets/pspace/deployment/list.md @@ -0,0 +1,28 @@ +List deployments in your team. + +Pick a subset of fields to display: + +``` +pspace deployment list -F id -F name +``` + +### Usage + +``` +pspace deployment list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/up.md b/.assets/pspace/deployment/up.md new file mode 100644 index 0000000..172c688 --- /dev/null +++ b/.assets/pspace/deployment/up.md @@ -0,0 +1,57 @@ +This will create a new deployment for your app or update it if it already +exists. You can optionally specify a path to a config file. If no config file is +specified, the default config file paths will be tried. + +Create a new deployment for the app in the current directory. + +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. + +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. + +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. + +``` +$ pspace deployment create --project-id 1234 +``` + +### Usage + +``` +pspace deployment up [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------- | ------- | ----------------------------------------------------------------------- | -------- | +| `config` | c | The path to the config file. Defaults to our default config file paths. | | + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | | `project-id` | p | The ID of the project to + deploy to. | false | | `cwd` | | The directory to deploy the app from. + Defaults to the current directory. | false | | `log-level` | l | Enable debug + logging. | false | | `json` | j | Output JSON | false | | `api-key` | | A + Paperspace public API Key used for authenticating requests | false | | `help` + | h | Show help for a command | false | diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md index a2888bd..554ed28 100644 --- a/.assets/pspace/docs.md +++ b/.assets/pspace/docs.md @@ -1,5 +1,3 @@ -## pspace docs - This command opens the Paperspace documentation in your browser. You can optionally pass an argument that will take you to a specific docs page. @@ -15,11 +13,9 @@ pspace docs [arguments] [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md deleted file mode 100644 index 53fe651..0000000 --- a/.assets/pspace/help.md +++ /dev/null @@ -1,51 +0,0 @@ -## pspace help - -Show help for a pspace command - -### Usage - -``` -pspace help [command] -pspace help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace help commands - -List pspace commands - -Example: - -``` -$ pspace help commands commands -``` - -### Usage - -``` -pspace help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -#### Subcommands diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md new file mode 100644 index 0000000..b28a19d --- /dev/null +++ b/.assets/pspace/help/commands.md @@ -0,0 +1,23 @@ +List pspace commands + +Example: + +``` +$ pspace help commands commands +``` + +### Usage + +``` +pspace help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/help/help.md b/.assets/pspace/help/help.md new file mode 100644 index 0000000..adbb1c9 --- /dev/null +++ b/.assets/pspace/help/help.md @@ -0,0 +1,30 @@ +Show help for a pspace command + +### Usage + +``` +pspace help [command] +pspace help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------- | +| `commands` | List pspace commands | + +Example: + +```` +$ pspace help commands commands +``` | +```` diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md index 3347799..cd3df50 100644 --- a/.assets/pspace/init.md +++ b/.assets/pspace/init.md @@ -1,5 +1,3 @@ -## pspace init - Create a new Paperspace app. This will create a new directory with a default app structure. You can optionally specify a name for the app and a template to use. If no template is specified, the default template will be used. @@ -33,7 +31,7 @@ pspace init [arguments] [flags] | Name | Aliases | Description | Required | | ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | -| template | t | A template to use when creating the app. This can be a URL | | +| `template` | t | A template to use when creating the app. This can be a URL | | | to a git repository or a shorthand template name. | | | | These templates are equivalent: @@ -68,16 +66,14 @@ user/repo#dev # branch user/repo#v1.2.3 # release tag user/repo#1234abcd # commit hash ``` | true | -| mode | m | The mode to use when creating the app. This can be either "git" or +| `mode` | m | The mode to use when creating the app. This can be either "git" or "tar". If "git" is specified, the template will be downloaded as a tarball. Note that "git" clones over SSH, so you must have a valid SSH key configured with GitHub, Bitbucket, or GitLab. | false | -| name | n | The name of the app. Defaults to the first argument current directory name. | false | -| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| `name` | n | The name of the app. Defaults to the first argument current directory name. | false | +| `clean` | c | Clean the Paperspace cache. This negates other args/flags. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | ```` diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md index 41e5a58..c32fbf3 100644 --- a/.assets/pspace/login.md +++ b/.assets/pspace/login.md @@ -1,5 +1,3 @@ -## pspace login - Log in to the CLI using your Paperspace API key or by opening the web console. ### Usage @@ -10,11 +8,9 @@ pspace login [arguments] [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md index a9fae65..00d0567 100644 --- a/.assets/pspace/logout.md +++ b/.assets/pspace/logout.md @@ -1,5 +1,3 @@ -## pspace logout - Log out of the CLI for the current team, a specific team, or all teams. ### Usage @@ -10,12 +8,10 @@ pspace logout [arguments...] [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| all | a | Log out of all teams. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `all` | a | Log out of all teams. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md deleted file mode 100644 index 019eecf..0000000 --- a/.assets/pspace/machine-event.md +++ /dev/null @@ -1,111 +0,0 @@ -## pspace machine-event - -Manage your machine events. Events are asynchronous tasks performed by our -system on your machines. Not all machine commands are asynchronous. For those -that are, a machine event will be returned which can be tracked using this -command. - -For more information, see https://docs.paperspace.com/machines. - -### Usage - -``` -pspace machine-event [command] -pspace machine-event [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace machine-event get - -Get a machine event from a team. - -### Usage - -``` -pspace machine-event get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine-event help - -Show help for a machine-event command - -### Usage - -``` -pspace machine-event help [command] -pspace machine-event help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace machine-event list - -List machine events in your team. - -Pick a subset of fields to display: - -``` -pspace machine-event list -F name -F dtModified -``` - -### Usage - -``` -pspace machine-event list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/machine-event/get.md b/.assets/pspace/machine-event/get.md new file mode 100644 index 0000000..bca1758 --- /dev/null +++ b/.assets/pspace/machine-event/get.md @@ -0,0 +1,17 @@ +Get a machine event from a team. + +### Usage + +``` +pspace machine-event get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md new file mode 100644 index 0000000..8dba525 --- /dev/null +++ b/.assets/pspace/machine-event/help/commands.md @@ -0,0 +1,23 @@ +List machine-event commands + +Example: + +``` +$ pspace machine-event help commands commands +``` + +### Usage + +``` +pspace machine-event help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine-event/help/help.md b/.assets/pspace/machine-event/help/help.md new file mode 100644 index 0000000..c90d420 --- /dev/null +++ b/.assets/pspace/machine-event/help/help.md @@ -0,0 +1,30 @@ +Show help for a machine-event command + +### Usage + +``` +pspace machine-event help [command] +pspace machine-event help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------- | +| `commands` | List machine-event commands | + +Example: + +```` +$ pspace machine-event help commands commands +``` | +```` diff --git a/.assets/pspace/machine-event/list.md b/.assets/pspace/machine-event/list.md new file mode 100644 index 0000000..0d503d2 --- /dev/null +++ b/.assets/pspace/machine-event/list.md @@ -0,0 +1,30 @@ +List machine events in your team. + +Pick a subset of fields to display: + +``` +pspace machine-event list -F name -F dtModified +``` + +### Usage + +``` +pspace machine-event list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event/machine-event.md b/.assets/pspace/machine-event/machine-event.md new file mode 100644 index 0000000..fb9f130 --- /dev/null +++ b/.assets/pspace/machine-event/machine-event.md @@ -0,0 +1,37 @@ +Manage your machine events. Events are asynchronous tasks performed by our +system on your machines. Not all machine commands are asynchronous. For those +that are, a machine event will be returned which can be tracked using this +command. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` +pspace machine-event [command] +pspace machine-event [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------- | +| `get` | Get a machine event from a team. | +| `help` | Show help for a machine-event command | +| `list` | List machine events in your team. | + +Pick a subset of fields to display: + +```` +pspace machine-event list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md deleted file mode 100644 index 5a4be99..0000000 --- a/.assets/pspace/machine.md +++ /dev/null @@ -1,283 +0,0 @@ -## pspace machine - -Manage your Paperspace machines. - -For more information, see https://docs.paperspace.com/machines. - -### Usage - -``` -pspace machine [command] -pspace machine [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [restart](#restart) -- [start](#start) -- [stop](#stop) -- [update](#update) - -## pspace machine create - -Create a machine. - -### Usage - -``` -pspace machine create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------------ | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine delete - -Delete a machine from a team. - -### Usage - -``` -pspace machine delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine get - -Get a machine from a team. - -### Usage - -``` -pspace machine get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine help - -Show help for a machine command - -### Usage - -``` -pspace machine help [command] -pspace machine help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace machine list - -List machines in your team. - -Pick a subset of fields to display: - -``` -pspace machine list -F name -F dtModified -``` - -### Usage - -``` -pspace machine list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------ | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine restart - -Restart a machine from a team. - -### Usage - -``` -pspace machine restart [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine start - -Start a machine from a team. - -### Usage - -``` -pspace machine start [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine stop - -Stop a machine from a team. - -### Usage - -``` -pspace machine stop [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace machine update - -Update a machine's settings. - -### Usage - -``` -pspace machine update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/machine/create.md b/.assets/pspace/machine/create.md new file mode 100644 index 0000000..36bfc51 --- /dev/null +++ b/.assets/pspace/machine/create.md @@ -0,0 +1,38 @@ +Create a machine. + +### Usage + +``` +pspace machine create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the machine | true | +| `machine-type` | | The machine type to create | true | +| `template-id` | | The ID of the template to create the machine from | true | +| `network-id` | | The ID of the network to create the machine in | false | +| `region` | | The region to create the machine in | true | +| `disk-size` | | The size of the machine's disk | true | +| `public-ip-type` | | The public IP type. | false | +| `auto-snapshot-enabled` | | Whether to enable auto snapshots. | false | +| `auto-snapshot-frequency` | | The auto snapshot frequency. | false | +| `auto-snapshot-save-count` | | The number of auto snapshots to save. | false | +| `auto-shutdown-enabled` | | Whether to enable auto shutdown. | false | +| `auto-shutdown-timeout` | | The auto shutdown timeout in hours. | false | +| `auto-shutdown-force` | | Whether to force shutdown the machine. | false | +| `take-initial-snapshot` | | Whether to take an initial snapshot. | false | +| `restore-point-enabled` | | Whether to use initial snapshot as a restore point. | false | +| `restore-point-frequency` | | The restore point frequency. | false | +| `startup-script-id` | | The startup script ID. | false | +| `email-password` | | Whether to email the password. | false | +| `start-on-create` | | Whether to start the machine on creation. | false | +| `enable-nvlink` | | Whether to enable NVLink. | false | +| `accessor-ids` | | The accessors of the machine. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/delete.md b/.assets/pspace/machine/delete.md new file mode 100644 index 0000000..ae9af25 --- /dev/null +++ b/.assets/pspace/machine/delete.md @@ -0,0 +1,17 @@ +Delete a machine from a team. + +### Usage + +``` +pspace machine delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/get.md b/.assets/pspace/machine/get.md new file mode 100644 index 0000000..540067a --- /dev/null +++ b/.assets/pspace/machine/get.md @@ -0,0 +1,17 @@ +Get a machine from a team. + +### Usage + +``` +pspace machine get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md new file mode 100644 index 0000000..9d681a7 --- /dev/null +++ b/.assets/pspace/machine/help/commands.md @@ -0,0 +1,23 @@ +List machine commands + +Example: + +``` +$ pspace machine help commands commands +``` + +### Usage + +``` +pspace machine help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine/help/help.md b/.assets/pspace/machine/help/help.md new file mode 100644 index 0000000..3c22d64 --- /dev/null +++ b/.assets/pspace/machine/help/help.md @@ -0,0 +1,30 @@ +Show help for a machine command + +### Usage + +``` +pspace machine help [command] +pspace machine help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------- | +| `commands` | List machine commands | + +Example: + +```` +$ pspace machine help commands commands +``` | +```` diff --git a/.assets/pspace/machine/list.md b/.assets/pspace/machine/list.md new file mode 100644 index 0000000..c6a6338 --- /dev/null +++ b/.assets/pspace/machine/list.md @@ -0,0 +1,32 @@ +List machines in your team. + +Pick a subset of fields to display: + +``` +pspace machine list -F name -F dtModified +``` + +### Usage + +``` +pspace machine list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `agent-type` | a | Filter by agent type. | false | +| `machine-type` | m | Filter by machine type. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/machine.md b/.assets/pspace/machine/machine.md new file mode 100644 index 0000000..77f7623 --- /dev/null +++ b/.assets/pspace/machine/machine.md @@ -0,0 +1,40 @@ +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` +pspace machine [command] +pspace machine [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------- | +| `create` | Create a machine. | +| `delete` | Delete a machine from a team. | +| `get` | Get a machine from a team. | +| `help` | Show help for a machine command | +| `list` | List machines in your team. | + +Pick a subset of fields to display: + +```` +pspace machine list -F name -F dtModified +``` | +| `restart` | Restart a machine from a team. | +| `start` | Start a machine from a team. | +| `stop` | Stop a machine from a team. | +| `update` | Update a machine's settings. | +```` diff --git a/.assets/pspace/machine/restart.md b/.assets/pspace/machine/restart.md new file mode 100644 index 0000000..de40f98 --- /dev/null +++ b/.assets/pspace/machine/restart.md @@ -0,0 +1,17 @@ +Restart a machine from a team. + +### Usage + +``` +pspace machine restart [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/start.md b/.assets/pspace/machine/start.md new file mode 100644 index 0000000..faa932f --- /dev/null +++ b/.assets/pspace/machine/start.md @@ -0,0 +1,17 @@ +Start a machine from a team. + +### Usage + +``` +pspace machine start [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/stop.md b/.assets/pspace/machine/stop.md new file mode 100644 index 0000000..18e36c2 --- /dev/null +++ b/.assets/pspace/machine/stop.md @@ -0,0 +1,17 @@ +Stop a machine from a team. + +### Usage + +``` +pspace machine stop [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/update.md b/.assets/pspace/machine/update.md new file mode 100644 index 0000000..e916ce6 --- /dev/null +++ b/.assets/pspace/machine/update.md @@ -0,0 +1,31 @@ +Update a machine's settings. + +### Usage + +``` +pspace machine update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the machine | true | +| `machine-type` | | The machine type to update to | true | +| `network-id` | | The ID of the network to create the machine in | false | +| `disk-size` | | The size of the machine's disk | true | +| `public-ip-type` | | The public IP type. | false | +| `auto-snapshot-enabled` | | Whether to enable auto snapshots. | false | +| `auto-snapshot-frequency` | | The auto snapshot frequency. | false | +| `auto-snapshot-save-count` | | The number of auto snapshots to save. | false | +| `auto-shutdown-enabled` | | Whether to enable auto shutdown. | false | +| `auto-shutdown-timeout` | | The auto shutdown timeout in hours. | false | +| `auto-shutdown-force` | | Whether to force shutdown the machine. | false | +| `restore-point-enabled` | | Whether to enable a restore point. | false | +| `restore-point-frequency` | | The restore point frequency. | false | +| `restore-point-snapshot-id` | | The ID of the snapshot to use as a restore point. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md deleted file mode 100644 index 93d236d..0000000 --- a/.assets/pspace/model.md +++ /dev/null @@ -1,158 +0,0 @@ -## pspace model - -Manage your Paperspace models. - -For more information, see https://docs.paperspace.com/deploying/models. - -### Usage - -``` -pspace model [command] -pspace model [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace model create - -Create a new model. This command will prompt you for a name if you don't provide -one. - -### Usage - -``` -pspace model create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model delete - -Delete a model from a team. - -### Usage - -``` -pspace model delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model get - -Get a model from a team. - -### Usage - -``` -pspace model get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace model help - -Show help for a model command - -### Usage - -``` -pspace model help [command] -pspace model help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace model list - -List models in your team. - -Pick a subset of fields to display: - -``` -pspace model list -F name -F dtModified -``` - -### Usage - -``` -pspace model list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/model/create.md b/.assets/pspace/model/create.md new file mode 100644 index 0000000..ed94b61 --- /dev/null +++ b/.assets/pspace/model/create.md @@ -0,0 +1,23 @@ +Create a new model. This command will prompt you for a name if you don't provide +one. + +### Usage + +``` +pspace model create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the model | false | +| `description` | d | The description of the model | false | +| `is-public` | | Whether the model is public | false | +| `storage-provider-id` | s | The ID of the storage provider to use for the model | false | +| `project-id` | p | The ID of the project to create the model in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/delete.md b/.assets/pspace/model/delete.md new file mode 100644 index 0000000..484ffeb --- /dev/null +++ b/.assets/pspace/model/delete.md @@ -0,0 +1,17 @@ +Delete a model from a team. + +### Usage + +``` +pspace model delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/get.md b/.assets/pspace/model/get.md new file mode 100644 index 0000000..e451c39 --- /dev/null +++ b/.assets/pspace/model/get.md @@ -0,0 +1,17 @@ +Get a model from a team. + +### Usage + +``` +pspace model get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md new file mode 100644 index 0000000..3293280 --- /dev/null +++ b/.assets/pspace/model/help/commands.md @@ -0,0 +1,23 @@ +List model commands + +Example: + +``` +$ pspace model help commands commands +``` + +### Usage + +``` +pspace model help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/model/help/help.md b/.assets/pspace/model/help/help.md new file mode 100644 index 0000000..96a0eeb --- /dev/null +++ b/.assets/pspace/model/help/help.md @@ -0,0 +1,30 @@ +Show help for a model command + +### Usage + +``` +pspace model help [command] +pspace model help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------- | +| `commands` | List model commands | + +Example: + +```` +$ pspace model help commands commands +``` | +```` diff --git a/.assets/pspace/model/list.md b/.assets/pspace/model/list.md new file mode 100644 index 0000000..6cd98a6 --- /dev/null +++ b/.assets/pspace/model/list.md @@ -0,0 +1,28 @@ +List models in your team. + +Pick a subset of fields to display: + +``` +pspace model list -F name -F dtModified +``` + +### Usage + +``` +pspace model list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/model.md b/.assets/pspace/model/model.md new file mode 100644 index 0000000..63e49d0 --- /dev/null +++ b/.assets/pspace/model/model.md @@ -0,0 +1,37 @@ +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +### Usage + +``` +pspace model [command] +pspace model [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ------------ | ------------------------------------------------------------------------ | +| `create` | Create a new model. This command will prompt you for a name if you don't | +| provide one. | | +| `delete` | Delete a model from a team. | +| `get` | Get a model from a team. | +| `help` | Show help for a model command | +| `list` | List models in your team. | + +Pick a subset of fields to display: + +```` +pspace model list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md deleted file mode 100644 index 4371205..0000000 --- a/.assets/pspace/os-template.md +++ /dev/null @@ -1,85 +0,0 @@ -## pspace os-template - -List OS templates. OS templates are pre-configured virtual machines that you can -use to create a new machine. - -For more information, see https://docs.paperspace.com/compute/os-templates. - -### Usage - -``` -pspace os-template [command] -pspace os-template [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [list](#list) - -## pspace os-template help - -Show help for a os-template command - -### Usage - -``` -pspace os-template help [command] -pspace os-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace os-template list - -List OS templates. - -Pick a subset of fields to display: - -``` -pspace os-template list -F name -``` - -### Usage - -``` -pspace os-template list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md new file mode 100644 index 0000000..feaa79b --- /dev/null +++ b/.assets/pspace/os-template/help/commands.md @@ -0,0 +1,23 @@ +List os-template commands + +Example: + +``` +$ pspace os-template help commands commands +``` + +### Usage + +``` +pspace os-template help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/os-template/help/help.md b/.assets/pspace/os-template/help/help.md new file mode 100644 index 0000000..6ebc649 --- /dev/null +++ b/.assets/pspace/os-template/help/help.md @@ -0,0 +1,30 @@ +Show help for a os-template command + +### Usage + +``` +pspace os-template help [command] +pspace os-template help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------- | +| `commands` | List os-template commands | + +Example: + +```` +$ pspace os-template help commands commands +``` | +```` diff --git a/.assets/pspace/os-template/list.md b/.assets/pspace/os-template/list.md new file mode 100644 index 0000000..73eb05d --- /dev/null +++ b/.assets/pspace/os-template/list.md @@ -0,0 +1,29 @@ +List OS templates. + +Pick a subset of fields to display: + +``` +pspace os-template list -F name +``` + +### Usage + +``` +pspace os-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/os-template/os-template.md b/.assets/pspace/os-template/os-template.md new file mode 100644 index 0000000..f7ef7fa --- /dev/null +++ b/.assets/pspace/os-template/os-template.md @@ -0,0 +1,34 @@ +List OS templates. OS templates are pre-configured virtual machines that you can +use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +### Usage + +``` +pspace os-template [command] +pspace os-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------- | +| `help` | Show help for a os-template command | +| `list` | List OS templates. | + +Pick a subset of fields to display: + +```` +pspace os-template list -F name +``` | +```` diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md deleted file mode 100644 index bf474a2..0000000 --- a/.assets/pspace/private-network.md +++ /dev/null @@ -1,159 +0,0 @@ -## pspace private-network - -Manage your private networks. Private networks are logically isolated networks -for your machines and shared drives. They can also be used for site-to-site VPNs -and direct connections to your on-premise network. - -For more information, see -https://docs.paperspace.com/networking/private-networks. - -### Usage - -``` -pspace private-network [command] -pspace private-network [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace private-network create - -Create a private network. - -### Usage - -``` -pspace private-network create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network delete - -Delete a private network from a team. - -### Usage - -``` -pspace private-network delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network get - -Get a private network from a team. - -### Usage - -``` -pspace private-network get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace private-network help - -Show help for a private-network command - -### Usage - -``` -pspace private-network help [command] -pspace private-network help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace private-network list - -List private networks in your team. - -Pick a subset of fields to display: - -``` -pspace private-network list -F name -F dtModified -``` - -### Usage - -``` -pspace private-network list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/private-network/create.md b/.assets/pspace/private-network/create.md new file mode 100644 index 0000000..0e47206 --- /dev/null +++ b/.assets/pspace/private-network/create.md @@ -0,0 +1,19 @@ +Create a private network. + +### Usage + +``` +pspace private-network create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the private network | true | +| `region` | | The region to create the private network in | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/delete.md b/.assets/pspace/private-network/delete.md new file mode 100644 index 0000000..07daa54 --- /dev/null +++ b/.assets/pspace/private-network/delete.md @@ -0,0 +1,17 @@ +Delete a private network from a team. + +### Usage + +``` +pspace private-network delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/get.md b/.assets/pspace/private-network/get.md new file mode 100644 index 0000000..58b89b1 --- /dev/null +++ b/.assets/pspace/private-network/get.md @@ -0,0 +1,17 @@ +Get a private network from a team. + +### Usage + +``` +pspace private-network get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md new file mode 100644 index 0000000..6b78e84 --- /dev/null +++ b/.assets/pspace/private-network/help/commands.md @@ -0,0 +1,23 @@ +List private-network commands + +Example: + +``` +$ pspace private-network help commands commands +``` + +### Usage + +``` +pspace private-network help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/private-network/help/help.md b/.assets/pspace/private-network/help/help.md new file mode 100644 index 0000000..a92eff8 --- /dev/null +++ b/.assets/pspace/private-network/help/help.md @@ -0,0 +1,30 @@ +Show help for a private-network command + +### Usage + +``` +pspace private-network help [command] +pspace private-network help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------- | +| `commands` | List private-network commands | + +Example: + +```` +$ pspace private-network help commands commands +``` | +```` diff --git a/.assets/pspace/private-network/list.md b/.assets/pspace/private-network/list.md new file mode 100644 index 0000000..e4e019c --- /dev/null +++ b/.assets/pspace/private-network/list.md @@ -0,0 +1,30 @@ +List private networks in your team. + +Pick a subset of fields to display: + +``` +pspace private-network list -F name -F dtModified +``` + +### Usage + +``` +pspace private-network list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/private-network.md b/.assets/pspace/private-network/private-network.md new file mode 100644 index 0000000..7e27262 --- /dev/null +++ b/.assets/pspace/private-network/private-network.md @@ -0,0 +1,39 @@ +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see +https://docs.paperspace.com/networking/private-networks. + +### Usage + +``` +pspace private-network [command] +pspace private-network [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------- | +| `create` | Create a private network. | +| `delete` | Delete a private network from a team. | +| `get` | Get a private network from a team. | +| `help` | Show help for a private-network command | +| `list` | List private networks in your team. | + +Pick a subset of fields to display: + +```` +pspace private-network list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md deleted file mode 100644 index 5f89484..0000000 --- a/.assets/pspace/project.md +++ /dev/null @@ -1,226 +0,0 @@ -## pspace project - -Manage your Paperspace projects. - -### Usage - -``` -pspace project [command] -pspace project [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [link](#link) -- [list](#list) -- [update](#update) - -## pspace project create - -Create a new project. This command will prompt you for a name if you don't -provide one. - -### Usage - -``` -pspace project create [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project delete - -Delete a project by its ID. If you don't provide an ID, this command will prompt -you for one based on the projects you have access to. - -### Usage - -``` -pspace project delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project get - -Get a project by its ID. If you don't provide an ID, this command will prompt -you for one based on the projects you have access to. - -### Usage - -``` -pspace project get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project help - -Show help for a project command - -### Usage - -``` -pspace project help [command] -pspace project help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace project link - -This will link a remote project to a local directory. Commands that depend on a -project ID will use the project ID of the linked project when communicating with -the Paperspace API. - -Link a project to the current directory. - -``` -$ pspace link -``` - -Link a project to a different directory. - -``` -$ pspace link --cwd ../my-app -``` - -Link a project and specify a project ID. - -``` -$ pspace link pzwf2g05ubegj -``` - -### Usage - -``` -pspace project link [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------------------ | -------- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project list - -List projects in your team. - -Pick a subset of fields to display: - -``` -pspace project list -F id -F name -F dtCreated -``` - -### Usage - -``` -pspace project list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace project update - -Update an existing project. - -Example: - -``` -pspace project update psukfyemho7 --name my-cool-project -``` - -### Usage - -``` -pspace project update [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/project/create.md b/.assets/pspace/project/create.md new file mode 100644 index 0000000..a8b7105 --- /dev/null +++ b/.assets/pspace/project/create.md @@ -0,0 +1,18 @@ +Create a new project. This command will prompt you for a name if you don't +provide one. + +### Usage + +``` +pspace project create [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/delete.md b/.assets/pspace/project/delete.md new file mode 100644 index 0000000..c270de1 --- /dev/null +++ b/.assets/pspace/project/delete.md @@ -0,0 +1,18 @@ +Delete a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. + +### Usage + +``` +pspace project delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/get.md b/.assets/pspace/project/get.md new file mode 100644 index 0000000..863b4b2 --- /dev/null +++ b/.assets/pspace/project/get.md @@ -0,0 +1,18 @@ +Get a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. + +### Usage + +``` +pspace project get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md new file mode 100644 index 0000000..92d5b65 --- /dev/null +++ b/.assets/pspace/project/help/commands.md @@ -0,0 +1,23 @@ +List project commands + +Example: + +``` +$ pspace project help commands commands +``` + +### Usage + +``` +pspace project help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/project/help/help.md b/.assets/pspace/project/help/help.md new file mode 100644 index 0000000..8766139 --- /dev/null +++ b/.assets/pspace/project/help/help.md @@ -0,0 +1,30 @@ +Show help for a project command + +### Usage + +``` +pspace project help [command] +pspace project help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------- | +| `commands` | List project commands | + +Example: + +```` +$ pspace project help commands commands +``` | +```` diff --git a/.assets/pspace/project/link.md b/.assets/pspace/project/link.md new file mode 100644 index 0000000..4a2d38a --- /dev/null +++ b/.assets/pspace/project/link.md @@ -0,0 +1,37 @@ +This will link a remote project to a local directory. Commands that depend on a +project ID will use the project ID of the linked project when communicating with +the Paperspace API. + +Link a project to the current directory. + +``` +$ pspace link +``` + +Link a project to a different directory. + +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. + +``` +$ pspace link pzwf2g05ubegj +``` + +### Usage + +``` +pspace project link [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------------------ | -------- | +| `cwd` | | The directory to link the project to. Defaults to the current directory. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/list.md b/.assets/pspace/project/list.md new file mode 100644 index 0000000..528c7db --- /dev/null +++ b/.assets/pspace/project/list.md @@ -0,0 +1,28 @@ +List projects in your team. + +Pick a subset of fields to display: + +``` +pspace project list -F id -F name -F dtCreated +``` + +### Usage + +``` +pspace project list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/project.md b/.assets/pspace/project/project.md new file mode 100644 index 0000000..634c53f --- /dev/null +++ b/.assets/pspace/project/project.md @@ -0,0 +1,67 @@ +Manage your Paperspace projects. + +### Usage + +``` +pspace project [command] +pspace project [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `create` | Create a new project. This command will prompt you for a name if you don't | +| provide one. | | +| `delete` | Delete a project by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the projects you have access to. | | +| `get` | Get a project by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the projects you have access to. | | +| `help` | Show help for a project command | +| `link` | This will link a remote project to a local directory. Commands that | +| depend on a project ID will use the project ID of the linked project | | +| when communicating with the Paperspace API. | | + +Link a project to the current directory. + +``` +$ pspace link +``` + +Link a project to a different directory. + +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. + +```` +$ pspace link pzwf2g05ubegj +``` | +| `list` | List projects in your team. + +Pick a subset of fields to display: +```` + +pspace project list -F id -F name -F dtCreated + +```| +| `update` | Update an existing project. + +Example: +``` + +pspace project update psukfyemho7 --name my-cool-project + +```| +``` diff --git a/.assets/pspace/project/update.md b/.assets/pspace/project/update.md new file mode 100644 index 0000000..e8c636a --- /dev/null +++ b/.assets/pspace/project/update.md @@ -0,0 +1,24 @@ +Update an existing project. + +Example: + +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +### Usage + +``` +pspace project update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `name` | | The new name for the project. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md index 65e61a9..01ee358 100644 --- a/.assets/pspace/pspace.md +++ b/.assets/pspace/pspace.md @@ -1,5 +1,3 @@ -## pspace - A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. @@ -19,40 +17,165 @@ pspace [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | #### Subcommands -- [autoscaling-group](#autoscaling-group) -- [completion](#completion) -- [config](#config) -- [console](#console) -- [custom-template](#custom-template) -- [dataset](#dataset) -- [deployment](#deployment) -- [docs](#docs) -- [help](#help) -- [init](#init) -- [login](#login) -- [logout](#logout) -- [machine](#machine) -- [machine-event](#machine-event) -- [model](#model) -- [os-template](#os-template) -- [private-network](#private-network) -- [project](#project) -- [public-ip](#public-ip) -- [secret](#secret) -- [shared-drive](#shared-drive) -- [signup](#signup) -- [snapshot](#snapshot) -- [startup-script](#startup-script) -- [storage-provider](#storage-provider) -- [up](#up) -- [upgrade](#upgrade) -- [version](#version) +| Subcommand | Description | +| ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | +| `autoscaling-group` | Manage your autoscaling groups. Autoscaling groups enable using | +| the Kubernetes cluster-autoscaler to automatically scale your cluster. | | +| You can also autoscaling groups as a primitive for your own autoscaler. | | +| `completion` | Generate an autocompletion script for pspace in the specified shell. | +| See each sub-command's help for details on how to use the generated script. | | +| `config` | This command manages your Paperspace configuration. You can use it to set, get, and | +| delete configuration values. Running this command without any subcommands will print | | +| your current configuration. | | + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: + +```` +pspace config set team "my-team" +``` | +| `console` | This command opens the Paperspace web console in your browser. | +| `custom-template` | Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. | +| `dataset` | Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. | +| `deployment` | Effortlessly deploy ML apps to Paperspace. | +| `docs` | This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` | +| `help` | Show help for a pspace command | +| `init` | Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +```` + +$ pspace init + +``` +Create a new app named "my-app" relative to the current directory. +``` + +$ pspace init my-app + +``` +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` + +$ pspace init my-app -t Paperspace/gradio-demo + +```| +| `login` | Log in to the CLI using your Paperspace API key or by opening the web console. | +| `logout` | Log out of the CLI for the current team, a specific team, or all teams. | +| `machine` | Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. | +| `machine-event` | Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. | +| `model` | Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. | +| `os-template` | List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. | +| `private-network` | Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. | +| `project` | Manage your Paperspace projects. | +| `public-ip` | Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. | +| `secret` | Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. | +| `shared-drive` | Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. | +| `signup` | This command opens the Paperspace signup page in your browser. | +| `snapshot` | Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. | +| `startup-script` | Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. | +| `storage-provider` | Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. | +| `up` | This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` + +$ pspace up + +``` +Deploy the app using a config file. +``` + +$ pspace up -c paperspace.json + +``` +Deploy an app in a different directory. +``` + +$ pspace up --cwd ../my-app + +```| +| `upgrade` | This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` + +brew upgrade pspace + +``` +If you installed `pspace` using the install script, you can upgrade by +running: +``` + +pspace upgrade + +```| +| `version` | Shows version information command, including version number and build date. | +``` diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md deleted file mode 100644 index ab8cc9c..0000000 --- a/.assets/pspace/public-ip.md +++ /dev/null @@ -1,157 +0,0 @@ -## pspace public-ip - -Manage your public IPs. Public IP addresses allow your compute machines to be -reachable over the internet. - -For more information, see https://docs.paperspace.com/networking/public-ips. - -### Usage - -``` -pspace public-ip [command] -pspace public-ip [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [assign](#assign) -- [claim](#claim) -- [help](#help) -- [list](#list) -- [release](#release) - -## pspace public-ip assign - -Assign a public IP to a machine. - -### Usage - -``` -pspace public-ip assign [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip claim - -Claim a public IP for a team. - -### Usage - -``` -pspace public-ip claim [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip help - -Show help for a public-ip command - -### Usage - -``` -pspace public-ip help [command] -pspace public-ip help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace public-ip list - -List public IPs in your team or project. - -Pick a subset of fields to display: - -``` -pspace public-ip list -F name -F dtModified -``` - -### Usage - -``` -pspace public-ip list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace public-ip release - -Release a public IP from a team. This will unassign it from its assigned -machine, if any. - -### Usage - -``` -pspace public-ip release [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/public-ip/assign.md b/.assets/pspace/public-ip/assign.md new file mode 100644 index 0000000..5c1e190 --- /dev/null +++ b/.assets/pspace/public-ip/assign.md @@ -0,0 +1,18 @@ +Assign a public IP to a machine. + +### Usage + +``` +pspace public-ip assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine to assign the public IP to | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/claim.md b/.assets/pspace/public-ip/claim.md new file mode 100644 index 0000000..6c89fb3 --- /dev/null +++ b/.assets/pspace/public-ip/claim.md @@ -0,0 +1,18 @@ +Claim a public IP for a team. + +### Usage + +``` +pspace public-ip claim [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `region` | r | The region to claim the public IP in | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md new file mode 100644 index 0000000..a2211e8 --- /dev/null +++ b/.assets/pspace/public-ip/help/commands.md @@ -0,0 +1,23 @@ +List public-ip commands + +Example: + +``` +$ pspace public-ip help commands commands +``` + +### Usage + +``` +pspace public-ip help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/public-ip/help/help.md b/.assets/pspace/public-ip/help/help.md new file mode 100644 index 0000000..d4b8e0f --- /dev/null +++ b/.assets/pspace/public-ip/help/help.md @@ -0,0 +1,30 @@ +Show help for a public-ip command + +### Usage + +``` +pspace public-ip help [command] +pspace public-ip help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------- | +| `commands` | List public-ip commands | + +Example: + +```` +$ pspace public-ip help commands commands +``` | +```` diff --git a/.assets/pspace/public-ip/list.md b/.assets/pspace/public-ip/list.md new file mode 100644 index 0000000..07d8f9e --- /dev/null +++ b/.assets/pspace/public-ip/list.md @@ -0,0 +1,29 @@ +List public IPs in your team or project. + +Pick a subset of fields to display: + +``` +pspace public-ip list -F name -F dtModified +``` + +### Usage + +``` +pspace public-ip list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/public-ip.md b/.assets/pspace/public-ip/public-ip.md new file mode 100644 index 0000000..e57b151 --- /dev/null +++ b/.assets/pspace/public-ip/public-ip.md @@ -0,0 +1,37 @@ +Manage your public IPs. Public IP addresses allow your compute machines to be +reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +### Usage + +``` +pspace public-ip [command] +pspace public-ip [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------------------------- | +| `assign` | Assign a public IP to a machine. | +| `claim` | Claim a public IP for a team. | +| `help` | Show help for a public-ip command | +| `list` | List public IPs in your team or project. | + +Pick a subset of fields to display: + +```` +pspace public-ip list -F name -F dtModified +``` | +| `release` | Release a public IP from a team. This will unassign it from its assigned machine, if any. | +```` diff --git a/.assets/pspace/public-ip/release.md b/.assets/pspace/public-ip/release.md new file mode 100644 index 0000000..da4e4d0 --- /dev/null +++ b/.assets/pspace/public-ip/release.md @@ -0,0 +1,18 @@ +Release a public IP from a team. This will unassign it from its assigned +machine, if any. + +### Usage + +``` +pspace public-ip release [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md deleted file mode 100644 index b9553d2..0000000 --- a/.assets/pspace/secret.md +++ /dev/null @@ -1,220 +0,0 @@ -## pspace secret - -Manage your Paperspace secrets. Secrets are used to store sensitive information -such as API keys, passwords, and other credentials. Secrets can be safely -injected into workloads as environment variables. An environment variable that -uses a Secret will not reveal the contents of the secret itself. - -Secrets can be created at the following levels: - -- Project (default): these secrets are applied to all resources in a project -- Global: these secrets can be applied to all resources on your current team - -For more information, see https://docs.paperspace.com/secrets. - -### Usage - -``` -pspace secret [command] -pspace secret [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace secret create - -Create a secret in a project or team. - -### Usage - -``` -pspace secret create [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | -| project-id | p | The ID of the project the secret is in. If not specified, the | | -| secret will be created in the project linked to your current working | | | | -| directory. If you are not in a project directory, you will be prompted | | | | -| to select a project. | false | | | -| global | g | Manage a secret that is available to the entire team you are | | -| currently logged into. By default, secrets are only available to | | | | -| a project. | false | | | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret delete - -Delete a secret from a project or team. - -### Usage - -``` -pspace secret delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | -| project-id | p | The ID of the project the secret is in. If not specified, the | | -| secret will be created in the project linked to your current working | | | | -| directory. If you are not in a project directory, you will be prompted | | | | -| to select a project. | false | | | -| global | g | Manage a secret that is available to the entire team you are | | -| currently logged into. By default, secrets are only available to | | | | -| a project. | false | | | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret get - -Get a secret from a project or team. - -### Usage - -``` -pspace secret get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | -| project-id | p | The ID of the project the secret is in. If not specified, the | | -| secret will be created in the project linked to your current working | | | | -| directory. If you are not in a project directory, you will be prompted | | | | -| to select a project. | false | | | -| global | g | Manage a secret that is available to the entire team you are | | -| currently logged into. By default, secrets are only available to | | | | -| a project. | false | | | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret help - -Show help for a secret command - -### Usage - -``` -pspace secret help [command] -pspace secret help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace secret list - -List secrets in your team or project. - -Pick a subset of fields to display: - -``` -pspace secret list -F name -F dtModified -``` - -### Usage - -``` -pspace secret list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the | | -| secret will be created in the project linked to your current working | | | | -| directory. If you are not in a project directory, you will be prompted | | | | -| to select a project. | false | | | -| global | g | Manage a secret that is available to the entire team you are | | -| currently logged into. By default, secrets are only available to | | | | -| a project. | false | | | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace secret update - -Update a secret in a project or team. - -### Usage - -``` -pspace secret update [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | -| project-id | p | The ID of the project the secret is in. If not specified, the | | -| secret will be created in the project linked to your current working | | | | -| directory. If you are not in a project directory, you will be prompted | | | | -| to select a project. | false | | | -| global | g | Manage a secret that is available to the entire team you are | | -| currently logged into. By default, secrets are only available to | | | | -| a project. | false | | | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/secret/create.md b/.assets/pspace/secret/create.md new file mode 100644 index 0000000..b942578 --- /dev/null +++ b/.assets/pspace/secret/create.md @@ -0,0 +1,24 @@ +Create a secret in a project or team. + +### Usage + +``` +pspace secret create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/delete.md b/.assets/pspace/secret/delete.md new file mode 100644 index 0000000..1815f7c --- /dev/null +++ b/.assets/pspace/secret/delete.md @@ -0,0 +1,24 @@ +Delete a secret from a project or team. + +### Usage + +``` +pspace secret delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/get.md b/.assets/pspace/secret/get.md new file mode 100644 index 0000000..262d9ec --- /dev/null +++ b/.assets/pspace/secret/get.md @@ -0,0 +1,25 @@ +Get a secret from a project or team. + +### Usage + +``` +pspace secret get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md new file mode 100644 index 0000000..a0b48e7 --- /dev/null +++ b/.assets/pspace/secret/help/commands.md @@ -0,0 +1,23 @@ +List secret commands + +Example: + +``` +$ pspace secret help commands commands +``` + +### Usage + +``` +pspace secret help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/secret/help/help.md b/.assets/pspace/secret/help/help.md new file mode 100644 index 0000000..067e6d7 --- /dev/null +++ b/.assets/pspace/secret/help/help.md @@ -0,0 +1,30 @@ +Show help for a secret command + +### Usage + +``` +pspace secret help [command] +pspace secret help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------- | +| `commands` | List secret commands | + +Example: + +```` +$ pspace secret help commands commands +``` | +```` diff --git a/.assets/pspace/secret/list.md b/.assets/pspace/secret/list.md new file mode 100644 index 0000000..bac3ca3 --- /dev/null +++ b/.assets/pspace/secret/list.md @@ -0,0 +1,36 @@ +List secrets in your team or project. + +Pick a subset of fields to display: + +``` +pspace secret list -F name -F dtModified +``` + +### Usage + +``` +pspace secret list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/secret.md b/.assets/pspace/secret/secret.md new file mode 100644 index 0000000..8ad12ab --- /dev/null +++ b/.assets/pspace/secret/secret.md @@ -0,0 +1,45 @@ +Manage your Paperspace secrets. Secrets are used to store sensitive information +such as API keys, passwords, and other credentials. Secrets can be safely +injected into workloads as environment variables. An environment variable that +uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +### Usage + +``` +pspace secret [command] +pspace secret [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------- | +| `create` | Create a secret in a project or team. | +| `delete` | Delete a secret from a project or team. | +| `get` | Get a secret from a project or team. | +| `help` | Show help for a secret command | +| `list` | List secrets in your team or project. | + +Pick a subset of fields to display: + +```` +pspace secret list -F name -F dtModified +``` | +| `update` | Update a secret in a project or team. | +```` diff --git a/.assets/pspace/secret/update.md b/.assets/pspace/secret/update.md new file mode 100644 index 0000000..edf4a7f --- /dev/null +++ b/.assets/pspace/secret/update.md @@ -0,0 +1,24 @@ +Update a secret in a project or team. + +### Usage + +``` +pspace secret update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md deleted file mode 100644 index f4be149..0000000 --- a/.assets/pspace/shared-drive.md +++ /dev/null @@ -1,160 +0,0 @@ -## pspace shared-drive - -Manage your shared drives. Shared drives are used to centralize data used by -your team. Shared drives can be mounted on any Paperspace machine in the same -private network. - -For more information, see https://docs.paperspace.com/storage/shared-drives. - -### Usage - -``` -pspace shared-drive [command] -pspace shared-drive [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace shared-drive create - -Create a shared drive. - -### Usage - -``` -pspace shared-drive create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive delete - -Delete a shared drive from a team. - -### Usage - -``` -pspace shared-drive delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive get - -Get a shared drive from a team. - -### Usage - -``` -pspace shared-drive get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace shared-drive help - -Show help for a shared-drive command - -### Usage - -``` -pspace shared-drive help [command] -pspace shared-drive help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace shared-drive list - -List shared drives in your team or project. - -Pick a subset of fields to display: - -``` -pspace shared-drive list -F name -F dtModified -``` - -### Usage - -``` -pspace shared-drive list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/shared-drive/create.md b/.assets/pspace/shared-drive/create.md new file mode 100644 index 0000000..e8beea9 --- /dev/null +++ b/.assets/pspace/shared-drive/create.md @@ -0,0 +1,21 @@ +Create a shared drive. + +### Usage + +``` +pspace shared-drive create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the shared drive | true | +| `network-id` | | The ID of the network to create the shared drive in | true | +| `region` | | The region to create the shared drive in | true | +| `size` | | The size of the shared drive | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/delete.md b/.assets/pspace/shared-drive/delete.md new file mode 100644 index 0000000..0592cb1 --- /dev/null +++ b/.assets/pspace/shared-drive/delete.md @@ -0,0 +1,17 @@ +Delete a shared drive from a team. + +### Usage + +``` +pspace shared-drive delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/get.md b/.assets/pspace/shared-drive/get.md new file mode 100644 index 0000000..a999983 --- /dev/null +++ b/.assets/pspace/shared-drive/get.md @@ -0,0 +1,17 @@ +Get a shared drive from a team. + +### Usage + +``` +pspace shared-drive get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md new file mode 100644 index 0000000..50b4c4e --- /dev/null +++ b/.assets/pspace/shared-drive/help/commands.md @@ -0,0 +1,23 @@ +List shared-drive commands + +Example: + +``` +$ pspace shared-drive help commands commands +``` + +### Usage + +``` +pspace shared-drive help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/shared-drive/help/help.md b/.assets/pspace/shared-drive/help/help.md new file mode 100644 index 0000000..84ff740 --- /dev/null +++ b/.assets/pspace/shared-drive/help/help.md @@ -0,0 +1,30 @@ +Show help for a shared-drive command + +### Usage + +``` +pspace shared-drive help [command] +pspace shared-drive help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------------- | +| `commands` | List shared-drive commands | + +Example: + +```` +$ pspace shared-drive help commands commands +``` | +```` diff --git a/.assets/pspace/shared-drive/list.md b/.assets/pspace/shared-drive/list.md new file mode 100644 index 0000000..3481e8a --- /dev/null +++ b/.assets/pspace/shared-drive/list.md @@ -0,0 +1,30 @@ +List shared drives in your team or project. + +Pick a subset of fields to display: + +``` +pspace shared-drive list -F name -F dtModified +``` + +### Usage + +``` +pspace shared-drive list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/shared-drive.md b/.assets/pspace/shared-drive/shared-drive.md new file mode 100644 index 0000000..5a9b8e6 --- /dev/null +++ b/.assets/pspace/shared-drive/shared-drive.md @@ -0,0 +1,38 @@ +Manage your shared drives. Shared drives are used to centralize data used by +your team. Shared drives can be mounted on any Paperspace machine in the same +private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +### Usage + +``` +pspace shared-drive [command] +pspace shared-drive [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------------- | +| `create` | Create a shared drive. | +| `delete` | Delete a shared drive from a team. | +| `get` | Get a shared drive from a team. | +| `help` | Show help for a shared-drive command | +| `list` | List shared drives in your team or project. | + +Pick a subset of fields to display: + +```` +pspace shared-drive list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md index 8889049..cc630fd 100644 --- a/.assets/pspace/signup.md +++ b/.assets/pspace/signup.md @@ -1,5 +1,3 @@ -## pspace signup - This command opens the Paperspace signup page in your browser. ### Usage @@ -10,11 +8,9 @@ pspace signup [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md deleted file mode 100644 index 932eef2..0000000 --- a/.assets/pspace/snapshot.md +++ /dev/null @@ -1,160 +0,0 @@ -## pspace snapshot - -Manage your snapshots. Snapshots are copies of your machine's disk at a point in -time. They can be used to restore the machine to its previous state. Using -snapshots is recommended before taking any action that could affect the -usability of the machine or its network connection. - -For more information, see https://docs.paperspace.com/storage/snapshots. - -### Usage - -``` -pspace snapshot [command] -pspace snapshot [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [help](#help) -- [list](#list) -- [restore](#restore) - -## pspace snapshot create - -Create a snapshot from a machine. - -### Usage - -``` -pspace snapshot create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot delete - -Delete a snapshot from a team. - -### Usage - -``` -pspace snapshot delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot help - -Show help for a snapshot command - -### Usage - -``` -pspace snapshot help [command] -pspace snapshot help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace snapshot list - -List snapshots in your team. - -Pick a subset of fields to display: - -``` -pspace snapshot list -F name -F dtModified -``` - -### Usage - -``` -pspace snapshot list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace snapshot restore - -Restore a machine to a snapshot. - -### Usage - -``` -pspace snapshot restore [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/snapshot/create.md b/.assets/pspace/snapshot/create.md new file mode 100644 index 0000000..f9b3d78 --- /dev/null +++ b/.assets/pspace/snapshot/create.md @@ -0,0 +1,19 @@ +Create a snapshot from a machine. + +### Usage + +``` +pspace snapshot create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the snapshot | true | +| `machine-id` | m | The ID of the machine to create a snapshot from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/delete.md b/.assets/pspace/snapshot/delete.md new file mode 100644 index 0000000..c73a590 --- /dev/null +++ b/.assets/pspace/snapshot/delete.md @@ -0,0 +1,17 @@ +Delete a snapshot from a team. + +### Usage + +``` +pspace snapshot delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md new file mode 100644 index 0000000..ee51087 --- /dev/null +++ b/.assets/pspace/snapshot/help/commands.md @@ -0,0 +1,23 @@ +List snapshot commands + +Example: + +``` +$ pspace snapshot help commands commands +``` + +### Usage + +``` +pspace snapshot help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/snapshot/help/help.md b/.assets/pspace/snapshot/help/help.md new file mode 100644 index 0000000..c56ba17 --- /dev/null +++ b/.assets/pspace/snapshot/help/help.md @@ -0,0 +1,30 @@ +Show help for a snapshot command + +### Usage + +``` +pspace snapshot help [command] +pspace snapshot help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------- | +| `commands` | List snapshot commands | + +Example: + +```` +$ pspace snapshot help commands commands +``` | +```` diff --git a/.assets/pspace/snapshot/list.md b/.assets/pspace/snapshot/list.md new file mode 100644 index 0000000..080e11f --- /dev/null +++ b/.assets/pspace/snapshot/list.md @@ -0,0 +1,30 @@ +List snapshots in your team. + +Pick a subset of fields to display: + +``` +pspace snapshot list -F name -F dtModified +``` + +### Usage + +``` +pspace snapshot list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/restore.md b/.assets/pspace/snapshot/restore.md new file mode 100644 index 0000000..da87532 --- /dev/null +++ b/.assets/pspace/snapshot/restore.md @@ -0,0 +1,18 @@ +Restore a machine to a snapshot. + +### Usage + +``` +pspace snapshot restore [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `create-snapshot` | | Create an additional snapshot before restore | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/snapshot.md b/.assets/pspace/snapshot/snapshot.md new file mode 100644 index 0000000..69011d9 --- /dev/null +++ b/.assets/pspace/snapshot/snapshot.md @@ -0,0 +1,39 @@ +Manage your snapshots. Snapshots are copies of your machine's disk at a point in +time. They can be used to restore the machine to its previous state. Using +snapshots is recommended before taking any action that could affect the +usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +### Usage + +``` +pspace snapshot [command] +pspace snapshot [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------- | +| `create` | Create a snapshot from a machine. | +| `delete` | Delete a snapshot from a team. | +| `help` | Show help for a snapshot command | +| `list` | List snapshots in your team. | + +Pick a subset of fields to display: + +```` +pspace snapshot list -F name -F dtModified +``` | +| `restore` | Restore a machine to a snapshot. | +```` diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md deleted file mode 100644 index dcd18de..0000000 --- a/.assets/pspace/startup-script.md +++ /dev/null @@ -1,230 +0,0 @@ -## pspace startup-script - -Manage your startup scripts. Startup scripts allow you to configure a machine on -first boot or on every boot. - -### Usage - -``` -pspace startup-script [command] -pspace startup-script [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [assign](#assign) -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [unassign](#unassign) -- [update](#update) - -## pspace startup-script assign - -Assign a startup script to a machine. - -### Usage - -``` -pspace startup-script assign [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script create - -Create a startup script. - -### Usage - -``` -pspace startup-script create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script delete - -Delete a startup script from a team. - -### Usage - -``` -pspace startup-script delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script get - -Get a startup script from a team. - -### Usage - -``` -pspace startup-script get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script help - -Show help for a startup-script command - -### Usage - -``` -pspace startup-script help [command] -pspace startup-script help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace startup-script list - -List startup scripts in your team. - -Pick a subset of fields to display: - -``` -pspace startup-script list -F name -F dtCreated -``` - -### Usage - -``` -pspace startup-script list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script unassign - -Unassign a startup script from a machine. - -### Usage - -``` -pspace startup-script unassign [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace startup-script update - -Update a startup script. - -### Usage - -``` -pspace startup-script update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands diff --git a/.assets/pspace/startup-script/assign.md b/.assets/pspace/startup-script/assign.md new file mode 100644 index 0000000..f1b084d --- /dev/null +++ b/.assets/pspace/startup-script/assign.md @@ -0,0 +1,18 @@ +Assign a startup script to a machine. + +### Usage + +``` +pspace startup-script assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | | The ID of the machine to assign the startup script to | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/create.md b/.assets/pspace/startup-script/create.md new file mode 100644 index 0000000..4d542ba --- /dev/null +++ b/.assets/pspace/startup-script/create.md @@ -0,0 +1,20 @@ +Create a startup script. + +### Usage + +``` +pspace startup-script create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the startup script | true | +| `script` | | The script to run | true | +| `run-once` | | Whether to run once or on every boot | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/delete.md b/.assets/pspace/startup-script/delete.md new file mode 100644 index 0000000..8252f5b --- /dev/null +++ b/.assets/pspace/startup-script/delete.md @@ -0,0 +1,17 @@ +Delete a startup script from a team. + +### Usage + +``` +pspace startup-script delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/get.md b/.assets/pspace/startup-script/get.md new file mode 100644 index 0000000..631a4db --- /dev/null +++ b/.assets/pspace/startup-script/get.md @@ -0,0 +1,17 @@ +Get a startup script from a team. + +### Usage + +``` +pspace startup-script get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md new file mode 100644 index 0000000..f3e8248 --- /dev/null +++ b/.assets/pspace/startup-script/help/commands.md @@ -0,0 +1,23 @@ +List startup-script commands + +Example: + +``` +$ pspace startup-script help commands commands +``` + +### Usage + +``` +pspace startup-script help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/startup-script/help/help.md b/.assets/pspace/startup-script/help/help.md new file mode 100644 index 0000000..43f8e5a --- /dev/null +++ b/.assets/pspace/startup-script/help/help.md @@ -0,0 +1,30 @@ +Show help for a startup-script command + +### Usage + +``` +pspace startup-script help [command] +pspace startup-script help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------------- | +| `commands` | List startup-script commands | + +Example: + +```` +$ pspace startup-script help commands commands +``` | +```` diff --git a/.assets/pspace/startup-script/list.md b/.assets/pspace/startup-script/list.md new file mode 100644 index 0000000..0d1ef3c --- /dev/null +++ b/.assets/pspace/startup-script/list.md @@ -0,0 +1,29 @@ +List startup scripts in your team. + +Pick a subset of fields to display: + +``` +pspace startup-script list -F name -F dtCreated +``` + +### Usage + +``` +pspace startup-script list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/startup-script.md b/.assets/pspace/startup-script/startup-script.md new file mode 100644 index 0000000..7b3d002 --- /dev/null +++ b/.assets/pspace/startup-script/startup-script.md @@ -0,0 +1,38 @@ +Manage your startup scripts. Startup scripts allow you to configure a machine on +first boot or on every boot. + +### Usage + +``` +pspace startup-script [command] +pspace startup-script [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------------------------- | +| `assign` | Assign a startup script to a machine. | +| `create` | Create a startup script. | +| `delete` | Delete a startup script from a team. | +| `get` | Get a startup script from a team. | +| `help` | Show help for a startup-script command | +| `list` | List startup scripts in your team. | + +Pick a subset of fields to display: + +```` +pspace startup-script list -F name -F dtCreated +``` | +| `unassign` | Unassign a startup script from a machine. | +| `update` | Update a startup script. | +```` diff --git a/.assets/pspace/startup-script/unassign.md b/.assets/pspace/startup-script/unassign.md new file mode 100644 index 0000000..1f80cca --- /dev/null +++ b/.assets/pspace/startup-script/unassign.md @@ -0,0 +1,18 @@ +Unassign a startup script from a machine. + +### Usage + +``` +pspace startup-script unassign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | | The ID of the machine to unassign the startup script from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/update.md b/.assets/pspace/startup-script/update.md new file mode 100644 index 0000000..3e61324 --- /dev/null +++ b/.assets/pspace/startup-script/update.md @@ -0,0 +1,21 @@ +Update a startup script. + +### Usage + +``` +pspace startup-script update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the startup script | false | +| `script` | | The script to run | false | +| `run-once` | | Whether to run once or on every boot | false | +| `enabled` | | Whether the startup script is enabled or not | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md deleted file mode 100644 index 670eecc..0000000 --- a/.assets/pspace/storage-provider.md +++ /dev/null @@ -1,181 +0,0 @@ -## pspace storage-provider - -Manage your storage providers. - -For more information, see https://docs.paperspace.com/storage/storageProviders. - -### Usage - -``` -pspace storage-provider [command] -pspace storage-provider [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace storage-provider create - -Create a storage provider. - -### Usage - -``` -pspace storage-provider create [command] -pspace storage-provider create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [s3](#s3) - -## pspace storage-provider delete - -Delete a storage provider from a team. - -### Usage - -``` -pspace storage-provider delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider get - -Get a storage provider from a team. - -### Usage - -``` -pspace storage-provider get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider help - -Show help for a storage-provider command - -### Usage - -``` -pspace storage-provider help [command] -pspace storage-provider help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [commands](#commands) - -## pspace storage-provider list - -List storage providers in your team or project. - -Pick a subset of fields to display: - -``` -pspace storage provider list -F name -F dtModified -``` - -### Usage - -``` -pspace storage-provider list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -## pspace storage-provider update - -Update a storage provider. - -### Usage - -``` -pspace storage-provider update [command] -pspace storage-provider update [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands - -- [help](#help) -- [s3](#s3) diff --git a/.assets/pspace/storage-provider/create/create.md b/.assets/pspace/storage-provider/create/create.md new file mode 100644 index 0000000..cdbd6ee --- /dev/null +++ b/.assets/pspace/storage-provider/create/create.md @@ -0,0 +1,24 @@ +Create a storage provider. + +### Usage + +``` +pspace storage-provider create [command] +pspace storage-provider create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------ | +| `help` | Show help for a create command | +| `s3` | Create an S3 storage provider. | diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md new file mode 100644 index 0000000..538e85d --- /dev/null +++ b/.assets/pspace/storage-provider/create/help/commands.md @@ -0,0 +1,23 @@ +List create commands + +Example: + +``` +$ pspace storage-provider create help commands commands +``` + +### Usage + +``` +pspace storage-provider create help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/create/help/help.md b/.assets/pspace/storage-provider/create/help/help.md new file mode 100644 index 0000000..293b79e --- /dev/null +++ b/.assets/pspace/storage-provider/create/help/help.md @@ -0,0 +1,30 @@ +Show help for a create command + +### Usage + +``` +pspace storage-provider create help [command] +pspace storage-provider create help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------- | +| `commands` | List create commands | + +Example: + +```` +$ pspace storage-provider create help commands commands +``` | +```` diff --git a/.assets/pspace/storage-provider/create/s3.md b/.assets/pspace/storage-provider/create/s3.md new file mode 100644 index 0000000..fa96d0e --- /dev/null +++ b/.assets/pspace/storage-provider/create/s3.md @@ -0,0 +1,26 @@ +Create an S3 storage provider. + +### Usage + +``` +pspace storage-provider create s3 [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the storage provider | true | +| `is-team-default` | | Whether the storage provider is the team's default provider | false | +| `endpoint` | | The endpoint of the storage provider | false | +| `bucket` | | The bucket of the storage provider | true | +| `region` | | The region of the storage provider | false | +| `access-key` | | The access key of the storage provider | true | +| `secret-access-key` | | The secret access key of the storage provider | true | +| `signature-version` | | The signature version of the storage provider | false | +| `retain-data` | | Whether to retain data in the storage provider | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/delete.md b/.assets/pspace/storage-provider/delete.md new file mode 100644 index 0000000..9298952 --- /dev/null +++ b/.assets/pspace/storage-provider/delete.md @@ -0,0 +1,17 @@ +Delete a storage provider from a team. + +### Usage + +``` +pspace storage-provider delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/get.md b/.assets/pspace/storage-provider/get.md new file mode 100644 index 0000000..45d4fe9 --- /dev/null +++ b/.assets/pspace/storage-provider/get.md @@ -0,0 +1,17 @@ +Get a storage provider from a team. + +### Usage + +``` +pspace storage-provider get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md new file mode 100644 index 0000000..ea477d1 --- /dev/null +++ b/.assets/pspace/storage-provider/help/commands.md @@ -0,0 +1,23 @@ +List storage-provider commands + +Example: + +``` +$ pspace storage-provider help commands commands +``` + +### Usage + +``` +pspace storage-provider help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/help/help.md b/.assets/pspace/storage-provider/help/help.md new file mode 100644 index 0000000..e5c4c06 --- /dev/null +++ b/.assets/pspace/storage-provider/help/help.md @@ -0,0 +1,30 @@ +Show help for a storage-provider command + +### Usage + +``` +pspace storage-provider help [command] +pspace storage-provider help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------ | +| `commands` | List storage-provider commands | + +Example: + +```` +$ pspace storage-provider help commands commands +``` | +```` diff --git a/.assets/pspace/storage-provider/list.md b/.assets/pspace/storage-provider/list.md new file mode 100644 index 0000000..88de7b9 --- /dev/null +++ b/.assets/pspace/storage-provider/list.md @@ -0,0 +1,28 @@ +List storage providers in your team or project. + +Pick a subset of fields to display: + +``` +pspace storage provider list -F name -F dtModified +``` + +### Usage + +``` +pspace storage-provider list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/storage-provider.md b/.assets/pspace/storage-provider/storage-provider.md new file mode 100644 index 0000000..91805cd --- /dev/null +++ b/.assets/pspace/storage-provider/storage-provider.md @@ -0,0 +1,37 @@ +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +### Usage + +``` +pspace storage-provider [command] +pspace storage-provider [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------------------- | +| `create` | Create a storage provider. | +| `delete` | Delete a storage provider from a team. | +| `get` | Get a storage provider from a team. | +| `help` | Show help for a storage-provider command | +| `list` | List storage providers in your team or project. | + +Pick a subset of fields to display: + +```` +pspace storage provider list -F name -F dtModified +``` | +| `update` | Update a storage provider. | +```` diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md new file mode 100644 index 0000000..089f831 --- /dev/null +++ b/.assets/pspace/storage-provider/update/help/commands.md @@ -0,0 +1,23 @@ +List update commands + +Example: + +``` +$ pspace storage-provider update help commands commands +``` + +### Usage + +``` +pspace storage-provider update help commands [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | +| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/update/help/help.md b/.assets/pspace/storage-provider/update/help/help.md new file mode 100644 index 0000000..23be338 --- /dev/null +++ b/.assets/pspace/storage-provider/update/help/help.md @@ -0,0 +1,30 @@ +Show help for a update command + +### Usage + +``` +pspace storage-provider update help [command] +pspace storage-provider update help [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------- | +| `commands` | List update commands | + +Example: + +```` +$ pspace storage-provider update help commands commands +``` | +```` diff --git a/.assets/pspace/storage-provider/update/s3.md b/.assets/pspace/storage-provider/update/s3.md new file mode 100644 index 0000000..2758434 --- /dev/null +++ b/.assets/pspace/storage-provider/update/s3.md @@ -0,0 +1,26 @@ +Update an S3 storage provider in a project or team. + +### Usage + +``` +pspace storage-provider update s3 [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the storage provider | true | +| `is-team-default` | | Whether the storage provider is the team's default provider | true | +| `endpoint` | | The endpoint of the storage provider | false | +| `bucket` | | The bucket of the storage provider | true | +| `region` | | The region of the storage provider | false | +| `access-key` | | The access key of the storage provider | true | +| `secret-access-key` | | The secret access key of the storage provider | true | +| `signature-version` | | The signature version of the storage provider | false | +| `retain-data` | | Whether to retain data in the storage provider | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/update/update.md b/.assets/pspace/storage-provider/update/update.md new file mode 100644 index 0000000..ba40090 --- /dev/null +++ b/.assets/pspace/storage-provider/update/update.md @@ -0,0 +1,24 @@ +Update a storage provider. + +### Usage + +``` +pspace storage-provider update [command] +pspace storage-provider update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------------------- | +| `help` | Show help for a update command | +| `s3` | Update an S3 storage provider in a project or team. | diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md index d7109c8..18c7fc0 100644 --- a/.assets/pspace/up.md +++ b/.assets/pspace/up.md @@ -1,5 +1,3 @@ -## pspace up - This will upsert an app config and deploy your app to Paperspace. You can optionally specify a path to a config file. If no config file is specified, the default config file paths will be tried. @@ -30,9 +28,9 @@ pspace up [flags] ### Flags -| Name | Aliases | Description | Required | -| ------ | ------- | ----------------------------------------------------------------------- | -------- | -| config | c | The path to the config file. Defaults to our default config file paths. | | +| Name | Aliases | Description | Required | +| -------- | ------- | ----------------------------------------------------------------------- | -------- | +| `config` | c | The path to the config file. Defaults to our default config file paths. | | The default config file paths are in order of precedence: @@ -45,11 +43,9 @@ The default config file paths are in order of precedence: - `.paperspace/app.yml` - `.paperspace/app.json` - `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to - deploy to. | false | | cwd | | The directory to deploy the app from. Defaults - to the current directory. | false | | log-level | l | Enable debug logging. | - false | | json | j | Output JSON | false | | api-key | | A Paperspace public - API Key used for authenticating requests | false | | help | h | Show help for - a command | false | - -#### Subcommands +- `.paperspace/app.toml` | false | | `project-id` | p | The ID of the project to + deploy to. | false | | `cwd` | | The directory to deploy the app from. + Defaults to the current directory. | false | | `log-level` | l | Enable debug + logging. | false | | `json` | j | Output JSON | false | | `api-key` | | A + Paperspace public API Key used for authenticating requests | false | | `help` + | h | Show help for a command | false | diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md index 6c5c148..c2963df 100644 --- a/.assets/pspace/upgrade.md +++ b/.assets/pspace/upgrade.md @@ -1,5 +1,3 @@ -## pspace upgrade - This command upgrades pspace to the latest version. If you used a package manager like `brew` to install `pspace`, you should use @@ -24,11 +22,9 @@ pspace upgrade [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md index e927ffb..df947a1 100644 --- a/.assets/pspace/version.md +++ b/.assets/pspace/version.md @@ -1,5 +1,3 @@ -## pspace version - Shows version information command, including version number and build date. ### Usage @@ -10,11 +8,9 @@ pspace version [flags] ### Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -#### Subcommands +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index 1cf031d..4d703aa 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -11,15 +11,12 @@ await Deno.writeTextFile( JSON.stringify(json, null, 2), ); -let markdown = ""; - // Also generate markdown for the CLI async function renderCommand( path: string[], command: ZcliJsonCommand, - recursive = false, ) { - markdown += `## ${path.join(" ")}\n\n`; + let markdown = ""; markdown += command.description + "\n\n"; markdown += "### Usage\n\n"; markdown += `\`\`\`\n`; @@ -29,47 +26,43 @@ async function renderCommand( markdown += "| Name | Aliases | Description | Required |\n"; markdown += "| --- | --- | --- | --- |\n"; for (const flag of command.flags) { - markdown += `| ${flag.name} | ${ + markdown += `| \`${flag.name}\` | ${ flag.aliases.join(", ") } | ${flag.description} | ${flag.required} |\n`; } markdown += "\n"; - markdown += "#### Subcommands\n\n"; - for (const subcommand of command.commands) { - markdown += `- [${subcommand.name}](#${subcommand.name})\n`; - } + const hasSubcommands = command.commands.length > 0; - if (recursive) { + if (hasSubcommands) { + markdown += "#### Subcommands\n\n"; + markdown += "| Subcommand | Description |\n"; + markdown += "| --- | --- |\n"; for (const subcommand of command.commands) { - await renderCommand([...path, subcommand.name], subcommand); + markdown += `| \`${subcommand.name}\` | ${subcommand.description} |\n`; } + markdown += "\n"; } -} -for (const command of json.commands) { - await Deno.mkdir(`.assets/${command.name}`, { - recursive: true, - }); - for (const subcommand of command.commands) { - markdown = ""; - await renderCommand([command.name, subcommand.name], subcommand, true); - await Deno.writeTextFile( - `.assets/${command.name}/${subcommand.name}.md`, - markdown, - { - create: true, - }, - ); - } - markdown = ""; - await renderCommand([command.name], command); + const dir = path.slice(0, path.length - (hasSubcommands ? 0 : 1)); + const writePath = [ + ...dir, + command.name + ".md", + ].join("/"); + await Deno.mkdir(`.assets/${dir.join("/")}`, { recursive: true }); await Deno.writeTextFile( // edge case, put pspace in pspace/pspace.md - `.assets/${command.name}/${command.name}.md`, + `.assets/${writePath}`, markdown, { create: true, }, ); + for (const subcommand of command.commands) { + await renderCommand([...path, subcommand.name], subcommand); + } +} + +for (const command of json.commands) { + await renderCommand([command.name], command); } From cc545792adef8f5a401cdc7502425f91e82d3418 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Thu, 30 May 2024 13:51:32 +0000 Subject: [PATCH 10/10] remove help --- .assets/pspace.json | 2 +- .../pspace/autoscaling-group/help/commands.md | 23 -------------- .assets/pspace/autoscaling-group/help/help.md | 30 ------------------- .assets/pspace/completion/help/commands.md | 23 -------------- .assets/pspace/completion/help/help.md | 30 ------------------- .assets/pspace/config/help/commands.md | 23 -------------- .assets/pspace/config/help/help.md | 30 ------------------- .../pspace/custom-template/help/commands.md | 23 -------------- .assets/pspace/custom-template/help/help.md | 30 ------------------- .assets/pspace/dataset/help/commands.md | 23 -------------- .assets/pspace/dataset/help/help.md | 30 ------------------- .../pspace/dataset/versions/help/commands.md | 23 -------------- .assets/pspace/dataset/versions/help/help.md | 30 ------------------- .assets/pspace/deployment/help/commands.md | 23 -------------- .assets/pspace/deployment/help/help.md | 30 ------------------- .assets/pspace/help/commands.md | 23 -------------- .assets/pspace/help/help.md | 30 ------------------- .assets/pspace/machine-event/help/commands.md | 23 -------------- .assets/pspace/machine-event/help/help.md | 30 ------------------- .assets/pspace/machine/help/commands.md | 23 -------------- .assets/pspace/machine/help/help.md | 30 ------------------- .assets/pspace/model/help/commands.md | 23 -------------- .assets/pspace/model/help/help.md | 30 ------------------- .assets/pspace/os-template/help/commands.md | 23 -------------- .assets/pspace/os-template/help/help.md | 30 ------------------- .../pspace/private-network/help/commands.md | 23 -------------- .assets/pspace/private-network/help/help.md | 30 ------------------- .assets/pspace/project/help/commands.md | 23 -------------- .assets/pspace/project/help/help.md | 30 ------------------- .assets/pspace/public-ip/help/commands.md | 23 -------------- .assets/pspace/public-ip/help/help.md | 30 ------------------- .assets/pspace/secret/help/commands.md | 23 -------------- .assets/pspace/secret/help/help.md | 30 ------------------- .assets/pspace/shared-drive/help/commands.md | 23 -------------- .assets/pspace/shared-drive/help/help.md | 30 ------------------- .assets/pspace/snapshot/help/commands.md | 23 -------------- .assets/pspace/snapshot/help/help.md | 30 ------------------- .../pspace/startup-script/help/commands.md | 23 -------------- .assets/pspace/startup-script/help/help.md | 30 ------------------- .../storage-provider/create/help/commands.md | 23 -------------- .../storage-provider/create/help/help.md | 30 ------------------- .../pspace/storage-provider/help/commands.md | 23 -------------- .assets/pspace/storage-provider/help/help.md | 30 ------------------- .../storage-provider/update/help/commands.md | 23 -------------- .../storage-provider/update/help/help.md | 30 ------------------- .scripts/generate-docs.ts | 3 ++ 46 files changed, 4 insertions(+), 1167 deletions(-) delete mode 100644 .assets/pspace/autoscaling-group/help/commands.md delete mode 100644 .assets/pspace/autoscaling-group/help/help.md delete mode 100644 .assets/pspace/completion/help/commands.md delete mode 100644 .assets/pspace/completion/help/help.md delete mode 100644 .assets/pspace/config/help/commands.md delete mode 100644 .assets/pspace/config/help/help.md delete mode 100644 .assets/pspace/custom-template/help/commands.md delete mode 100644 .assets/pspace/custom-template/help/help.md delete mode 100644 .assets/pspace/dataset/help/commands.md delete mode 100644 .assets/pspace/dataset/help/help.md delete mode 100644 .assets/pspace/dataset/versions/help/commands.md delete mode 100644 .assets/pspace/dataset/versions/help/help.md delete mode 100644 .assets/pspace/deployment/help/commands.md delete mode 100644 .assets/pspace/deployment/help/help.md delete mode 100644 .assets/pspace/help/commands.md delete mode 100644 .assets/pspace/help/help.md delete mode 100644 .assets/pspace/machine-event/help/commands.md delete mode 100644 .assets/pspace/machine-event/help/help.md delete mode 100644 .assets/pspace/machine/help/commands.md delete mode 100644 .assets/pspace/machine/help/help.md delete mode 100644 .assets/pspace/model/help/commands.md delete mode 100644 .assets/pspace/model/help/help.md delete mode 100644 .assets/pspace/os-template/help/commands.md delete mode 100644 .assets/pspace/os-template/help/help.md delete mode 100644 .assets/pspace/private-network/help/commands.md delete mode 100644 .assets/pspace/private-network/help/help.md delete mode 100644 .assets/pspace/project/help/commands.md delete mode 100644 .assets/pspace/project/help/help.md delete mode 100644 .assets/pspace/public-ip/help/commands.md delete mode 100644 .assets/pspace/public-ip/help/help.md delete mode 100644 .assets/pspace/secret/help/commands.md delete mode 100644 .assets/pspace/secret/help/help.md delete mode 100644 .assets/pspace/shared-drive/help/commands.md delete mode 100644 .assets/pspace/shared-drive/help/help.md delete mode 100644 .assets/pspace/snapshot/help/commands.md delete mode 100644 .assets/pspace/snapshot/help/help.md delete mode 100644 .assets/pspace/startup-script/help/commands.md delete mode 100644 .assets/pspace/startup-script/help/help.md delete mode 100644 .assets/pspace/storage-provider/create/help/commands.md delete mode 100644 .assets/pspace/storage-provider/create/help/help.md delete mode 100644 .assets/pspace/storage-provider/help/commands.md delete mode 100644 .assets/pspace/storage-provider/help/help.md delete mode 100644 .assets/pspace/storage-provider/update/help/commands.md delete mode 100644 .assets/pspace/storage-provider/update/help/help.md diff --git a/.assets/pspace.json b/.assets/pspace.json index cacd3e3..d3cb1d6 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-29T18:11:30.955Z", + "buildDate": "2024-05-30T13:51:15.604Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md deleted file mode 100644 index f854ade..0000000 --- a/.assets/pspace/autoscaling-group/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List autoscaling-group commands - -Example: - -``` -$ pspace autoscaling-group help commands commands -``` - -### Usage - -``` -pspace autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/autoscaling-group/help/help.md b/.assets/pspace/autoscaling-group/help/help.md deleted file mode 100644 index 304c022..0000000 --- a/.assets/pspace/autoscaling-group/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a autoscaling-group command - -### Usage - -``` -pspace autoscaling-group help [command] -pspace autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------------- | -| `commands` | List autoscaling-group commands | - -Example: - -```` -$ pspace autoscaling-group help commands commands -``` | -```` diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md deleted file mode 100644 index 4500f6e..0000000 --- a/.assets/pspace/completion/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List completion commands - -Example: - -``` -$ pspace completion help commands commands -``` - -### Usage - -``` -pspace completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/completion/help/help.md b/.assets/pspace/completion/help/help.md deleted file mode 100644 index 04dfc22..0000000 --- a/.assets/pspace/completion/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a completion command - -### Usage - -``` -pspace completion help [command] -pspace completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------ | -| `commands` | List completion commands | - -Example: - -```` -$ pspace completion help commands commands -``` | -```` diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md deleted file mode 100644 index 6e8b19c..0000000 --- a/.assets/pspace/config/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List config commands - -Example: - -``` -$ pspace config help commands commands -``` - -### Usage - -``` -pspace config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/config/help/help.md b/.assets/pspace/config/help/help.md deleted file mode 100644 index bf314ee..0000000 --- a/.assets/pspace/config/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a config command - -### Usage - -``` -pspace config help [command] -pspace config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List config commands | - -Example: - -```` -$ pspace config help commands commands -``` | -```` diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md deleted file mode 100644 index f2573c4..0000000 --- a/.assets/pspace/custom-template/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List custom-template commands - -Example: - -``` -$ pspace custom-template help commands commands -``` - -### Usage - -``` -pspace custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/custom-template/help/help.md b/.assets/pspace/custom-template/help/help.md deleted file mode 100644 index a28c476..0000000 --- a/.assets/pspace/custom-template/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a custom-template command - -### Usage - -``` -pspace custom-template help [command] -pspace custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------------- | -| `commands` | List custom-template commands | - -Example: - -```` -$ pspace custom-template help commands commands -``` | -```` diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md deleted file mode 100644 index a69e176..0000000 --- a/.assets/pspace/dataset/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List dataset commands - -Example: - -``` -$ pspace dataset help commands commands -``` - -### Usage - -``` -pspace dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/help/help.md b/.assets/pspace/dataset/help/help.md deleted file mode 100644 index 1e6a334..0000000 --- a/.assets/pspace/dataset/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a dataset command - -### Usage - -``` -pspace dataset help [command] -pspace dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List dataset commands | - -Example: - -```` -$ pspace dataset help commands commands -``` | -```` diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md deleted file mode 100644 index 0c9ecb4..0000000 --- a/.assets/pspace/dataset/versions/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List versions commands - -Example: - -``` -$ pspace dataset versions help commands commands -``` - -### Usage - -``` -pspace dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/versions/help/help.md b/.assets/pspace/dataset/versions/help/help.md deleted file mode 100644 index 9f171db..0000000 --- a/.assets/pspace/dataset/versions/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a versions command - -### Usage - -``` -pspace dataset versions help [command] -pspace dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------- | -| `commands` | List versions commands | - -Example: - -```` -$ pspace dataset versions help commands commands -``` | -```` diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md deleted file mode 100644 index 428ac20..0000000 --- a/.assets/pspace/deployment/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List deployment commands - -Example: - -``` -$ pspace deployment help commands commands -``` - -### Usage - -``` -pspace deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/deployment/help/help.md b/.assets/pspace/deployment/help/help.md deleted file mode 100644 index 6d9eabd..0000000 --- a/.assets/pspace/deployment/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a deployment command - -### Usage - -``` -pspace deployment help [command] -pspace deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------ | -| `commands` | List deployment commands | - -Example: - -```` -$ pspace deployment help commands commands -``` | -```` diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md deleted file mode 100644 index b28a19d..0000000 --- a/.assets/pspace/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List pspace commands - -Example: - -``` -$ pspace help commands commands -``` - -### Usage - -``` -pspace help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/help/help.md b/.assets/pspace/help/help.md deleted file mode 100644 index adbb1c9..0000000 --- a/.assets/pspace/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a pspace command - -### Usage - -``` -pspace help [command] -pspace help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List pspace commands | - -Example: - -```` -$ pspace help commands commands -``` | -```` diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md deleted file mode 100644 index 8dba525..0000000 --- a/.assets/pspace/machine-event/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List machine-event commands - -Example: - -``` -$ pspace machine-event help commands commands -``` - -### Usage - -``` -pspace machine-event help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine-event/help/help.md b/.assets/pspace/machine-event/help/help.md deleted file mode 100644 index c90d420..0000000 --- a/.assets/pspace/machine-event/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a machine-event command - -### Usage - -``` -pspace machine-event help [command] -pspace machine-event help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------------- | -| `commands` | List machine-event commands | - -Example: - -```` -$ pspace machine-event help commands commands -``` | -```` diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md deleted file mode 100644 index 9d681a7..0000000 --- a/.assets/pspace/machine/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List machine commands - -Example: - -``` -$ pspace machine help commands commands -``` - -### Usage - -``` -pspace machine help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine/help/help.md b/.assets/pspace/machine/help/help.md deleted file mode 100644 index 3c22d64..0000000 --- a/.assets/pspace/machine/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a machine command - -### Usage - -``` -pspace machine help [command] -pspace machine help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List machine commands | - -Example: - -```` -$ pspace machine help commands commands -``` | -```` diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md deleted file mode 100644 index 3293280..0000000 --- a/.assets/pspace/model/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List model commands - -Example: - -``` -$ pspace model help commands commands -``` - -### Usage - -``` -pspace model help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/model/help/help.md b/.assets/pspace/model/help/help.md deleted file mode 100644 index 96a0eeb..0000000 --- a/.assets/pspace/model/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a model command - -### Usage - -``` -pspace model help [command] -pspace model help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------- | -| `commands` | List model commands | - -Example: - -```` -$ pspace model help commands commands -``` | -```` diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md deleted file mode 100644 index feaa79b..0000000 --- a/.assets/pspace/os-template/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List os-template commands - -Example: - -``` -$ pspace os-template help commands commands -``` - -### Usage - -``` -pspace os-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/os-template/help/help.md b/.assets/pspace/os-template/help/help.md deleted file mode 100644 index 6ebc649..0000000 --- a/.assets/pspace/os-template/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a os-template command - -### Usage - -``` -pspace os-template help [command] -pspace os-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------- | -| `commands` | List os-template commands | - -Example: - -```` -$ pspace os-template help commands commands -``` | -```` diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md deleted file mode 100644 index 6b78e84..0000000 --- a/.assets/pspace/private-network/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List private-network commands - -Example: - -``` -$ pspace private-network help commands commands -``` - -### Usage - -``` -pspace private-network help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/private-network/help/help.md b/.assets/pspace/private-network/help/help.md deleted file mode 100644 index a92eff8..0000000 --- a/.assets/pspace/private-network/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a private-network command - -### Usage - -``` -pspace private-network help [command] -pspace private-network help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------------- | -| `commands` | List private-network commands | - -Example: - -```` -$ pspace private-network help commands commands -``` | -```` diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md deleted file mode 100644 index 92d5b65..0000000 --- a/.assets/pspace/project/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List project commands - -Example: - -``` -$ pspace project help commands commands -``` - -### Usage - -``` -pspace project help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/project/help/help.md b/.assets/pspace/project/help/help.md deleted file mode 100644 index 8766139..0000000 --- a/.assets/pspace/project/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a project command - -### Usage - -``` -pspace project help [command] -pspace project help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List project commands | - -Example: - -```` -$ pspace project help commands commands -``` | -```` diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md deleted file mode 100644 index a2211e8..0000000 --- a/.assets/pspace/public-ip/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List public-ip commands - -Example: - -``` -$ pspace public-ip help commands commands -``` - -### Usage - -``` -pspace public-ip help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/public-ip/help/help.md b/.assets/pspace/public-ip/help/help.md deleted file mode 100644 index d4b8e0f..0000000 --- a/.assets/pspace/public-ip/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a public-ip command - -### Usage - -``` -pspace public-ip help [command] -pspace public-ip help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------- | -| `commands` | List public-ip commands | - -Example: - -```` -$ pspace public-ip help commands commands -``` | -```` diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md deleted file mode 100644 index a0b48e7..0000000 --- a/.assets/pspace/secret/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List secret commands - -Example: - -``` -$ pspace secret help commands commands -``` - -### Usage - -``` -pspace secret help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/secret/help/help.md b/.assets/pspace/secret/help/help.md deleted file mode 100644 index 067e6d7..0000000 --- a/.assets/pspace/secret/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a secret command - -### Usage - -``` -pspace secret help [command] -pspace secret help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List secret commands | - -Example: - -```` -$ pspace secret help commands commands -``` | -```` diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md deleted file mode 100644 index 50b4c4e..0000000 --- a/.assets/pspace/shared-drive/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List shared-drive commands - -Example: - -``` -$ pspace shared-drive help commands commands -``` - -### Usage - -``` -pspace shared-drive help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/shared-drive/help/help.md b/.assets/pspace/shared-drive/help/help.md deleted file mode 100644 index 84ff740..0000000 --- a/.assets/pspace/shared-drive/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a shared-drive command - -### Usage - -``` -pspace shared-drive help [command] -pspace shared-drive help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------------- | -| `commands` | List shared-drive commands | - -Example: - -```` -$ pspace shared-drive help commands commands -``` | -```` diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md deleted file mode 100644 index ee51087..0000000 --- a/.assets/pspace/snapshot/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List snapshot commands - -Example: - -``` -$ pspace snapshot help commands commands -``` - -### Usage - -``` -pspace snapshot help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/snapshot/help/help.md b/.assets/pspace/snapshot/help/help.md deleted file mode 100644 index c56ba17..0000000 --- a/.assets/pspace/snapshot/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a snapshot command - -### Usage - -``` -pspace snapshot help [command] -pspace snapshot help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------- | -| `commands` | List snapshot commands | - -Example: - -```` -$ pspace snapshot help commands commands -``` | -```` diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md deleted file mode 100644 index f3e8248..0000000 --- a/.assets/pspace/startup-script/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List startup-script commands - -Example: - -``` -$ pspace startup-script help commands commands -``` - -### Usage - -``` -pspace startup-script help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/startup-script/help/help.md b/.assets/pspace/startup-script/help/help.md deleted file mode 100644 index 43f8e5a..0000000 --- a/.assets/pspace/startup-script/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a startup-script command - -### Usage - -``` -pspace startup-script help [command] -pspace startup-script help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------------- | -| `commands` | List startup-script commands | - -Example: - -```` -$ pspace startup-script help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md deleted file mode 100644 index 538e85d..0000000 --- a/.assets/pspace/storage-provider/create/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List create commands - -Example: - -``` -$ pspace storage-provider create help commands commands -``` - -### Usage - -``` -pspace storage-provider create help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/create/help/help.md b/.assets/pspace/storage-provider/create/help/help.md deleted file mode 100644 index 293b79e..0000000 --- a/.assets/pspace/storage-provider/create/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a create command - -### Usage - -``` -pspace storage-provider create help [command] -pspace storage-provider create help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List create commands | - -Example: - -```` -$ pspace storage-provider create help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md deleted file mode 100644 index ea477d1..0000000 --- a/.assets/pspace/storage-provider/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List storage-provider commands - -Example: - -``` -$ pspace storage-provider help commands commands -``` - -### Usage - -``` -pspace storage-provider help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/help/help.md b/.assets/pspace/storage-provider/help/help.md deleted file mode 100644 index e5c4c06..0000000 --- a/.assets/pspace/storage-provider/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a storage-provider command - -### Usage - -``` -pspace storage-provider help [command] -pspace storage-provider help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------------ | -| `commands` | List storage-provider commands | - -Example: - -```` -$ pspace storage-provider help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md deleted file mode 100644 index 089f831..0000000 --- a/.assets/pspace/storage-provider/update/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List update commands - -Example: - -``` -$ pspace storage-provider update help commands commands -``` - -### Usage - -``` -pspace storage-provider update help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/update/help/help.md b/.assets/pspace/storage-provider/update/help/help.md deleted file mode 100644 index 23be338..0000000 --- a/.assets/pspace/storage-provider/update/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a update command - -### Usage - -``` -pspace storage-provider update help [command] -pspace storage-provider update help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List update commands | - -Example: - -```` -$ pspace storage-provider update help commands commands -``` | -```` diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index 4d703aa..7f9bf4d 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -16,6 +16,9 @@ async function renderCommand( path: string[], command: ZcliJsonCommand, ) { + if (command.name === "help") { + return; + } let markdown = ""; markdown += command.description + "\n\n"; markdown += "### Usage\n\n";