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); }