From bd4221b323350fa39055c08514161864645cac57 Mon Sep 17 00:00:00 2001 From: Kevin Wang Date: Wed, 22 May 2024 11:41:17 -0400 Subject: [PATCH] fix --- .assets/pspace.json | 4 +- .assets/pspace.md | 4428 +---------------- .assets/pspace/autoscaling-group.md | 30 + .assets/pspace/autoscaling-group/create.md | 31 + .assets/pspace/autoscaling-group/delete.md | 22 + .assets/pspace/autoscaling-group/get.md | 22 + .assets/pspace/autoscaling-group/help.md | 23 + .../pspace/autoscaling-group/help/commands.md | 27 + .assets/pspace/autoscaling-group/list.md | 34 + .assets/pspace/autoscaling-group/update.md | 32 + .assets/pspace/completion.md | 27 + .assets/pspace/completion/bash.md | 43 + .assets/pspace/completion/fish.md | 34 + .assets/pspace/completion/help.md | 23 + .assets/pspace/completion/help/commands.md | 27 + .assets/pspace/completion/zsh.md | 48 + .assets/pspace/config.md | 35 + .assets/pspace/config/delete.md | 21 + .assets/pspace/config/get.md | 27 + .assets/pspace/config/help.md | 23 + .assets/pspace/config/help/commands.md | 27 + .assets/pspace/config/set.md | 21 + .assets/pspace/console.md | 21 + .assets/pspace/custom-template.md | 31 + .assets/pspace/custom-template/create.md | 24 + .assets/pspace/custom-template/delete.md | 22 + .assets/pspace/custom-template/get.md | 22 + .assets/pspace/custom-template/help.md | 23 + .../pspace/custom-template/help/commands.md | 27 + .assets/pspace/custom-template/list.md | 35 + .assets/pspace/dataset.md | 31 + .assets/pspace/dataset/create.md | 26 + .assets/pspace/dataset/delete.md | 22 + .assets/pspace/dataset/get.md | 22 + .assets/pspace/dataset/help.md | 23 + .assets/pspace/dataset/help/commands.md | 27 + .assets/pspace/dataset/list.md | 32 + .assets/pspace/dataset/update.md | 24 + .assets/pspace/dataset/versions.md | 30 + .assets/pspace/dataset/versions/create.md | 24 + .assets/pspace/dataset/versions/delete.md | 23 + .assets/pspace/dataset/versions/get.md | 23 + .assets/pspace/dataset/versions/help.md | 23 + .../pspace/dataset/versions/help/commands.md | 27 + .assets/pspace/dataset/versions/list.md | 32 + .assets/pspace/dataset/versions/update.md | 24 + .assets/pspace/deployment.md | 27 + .assets/pspace/deployment/delete.md | 26 + .assets/pspace/deployment/get.md | 32 + .assets/pspace/deployment/help.md | 23 + .assets/pspace/deployment/help/commands.md | 27 + .assets/pspace/deployment/list.md | 32 + .assets/pspace/deployment/up.md | 59 + .assets/pspace/docs.md | 26 + .assets/pspace/help.md | 23 + .assets/pspace/help/commands.md | 27 + .assets/pspace/init.md | 77 + .assets/pspace/login.md | 21 + .assets/pspace/logout.md | 22 + .assets/pspace/machine-event.md | 29 + .assets/pspace/machine-event/get.md | 22 + .assets/pspace/machine-event/help.md | 23 + .assets/pspace/machine-event/help/commands.md | 27 + .assets/pspace/machine-event/list.md | 34 + .assets/pspace/machine.md | 33 + .assets/pspace/machine/create.md | 43 + .assets/pspace/machine/delete.md | 22 + .assets/pspace/machine/get.md | 22 + .assets/pspace/machine/help.md | 23 + .assets/pspace/machine/help/commands.md | 27 + .assets/pspace/machine/list.md | 36 + .assets/pspace/machine/restart.md | 22 + .assets/pspace/machine/start.md | 22 + .assets/pspace/machine/stop.md | 22 + .assets/pspace/machine/update.md | 36 + .assets/pspace/model.md | 29 + .assets/pspace/model/create.md | 28 + .assets/pspace/model/delete.md | 22 + .assets/pspace/model/get.md | 22 + .assets/pspace/model/help.md | 23 + .assets/pspace/model/help/commands.md | 27 + .assets/pspace/model/list.md | 32 + .assets/pspace/os-template.md | 27 + .assets/pspace/os-template/help.md | 23 + .assets/pspace/os-template/help/commands.md | 27 + .assets/pspace/os-template/list.md | 33 + .assets/pspace/private-network.md | 31 + .assets/pspace/private-network/create.md | 24 + .assets/pspace/private-network/delete.md | 22 + .assets/pspace/private-network/get.md | 22 + .assets/pspace/private-network/help.md | 23 + .../pspace/private-network/help/commands.md | 27 + .assets/pspace/private-network/list.md | 34 + .assets/pspace/project.md | 29 + .assets/pspace/project/create.md | 23 + .assets/pspace/project/delete.md | 23 + .assets/pspace/project/get.md | 23 + .assets/pspace/project/help.md | 23 + .assets/pspace/project/help/commands.md | 27 + .assets/pspace/project/link.md | 39 + .assets/pspace/project/list.md | 32 + .assets/pspace/project/update.md | 28 + .assets/pspace/public-ip.md | 29 + .assets/pspace/public-ip/assign.md | 23 + .assets/pspace/public-ip/claim.md | 23 + .assets/pspace/public-ip/help.md | 23 + .assets/pspace/public-ip/help/commands.md | 27 + .assets/pspace/public-ip/list.md | 33 + .assets/pspace/public-ip/release.md | 22 + .assets/pspace/secret.md | 38 + .assets/pspace/secret/create.md | 29 + .assets/pspace/secret/delete.md | 29 + .assets/pspace/secret/get.md | 30 + .assets/pspace/secret/help.md | 23 + .assets/pspace/secret/help/commands.md | 27 + .assets/pspace/secret/list.md | 40 + .assets/pspace/secret/update.md | 29 + .assets/pspace/shared-drive.md | 31 + .assets/pspace/shared-drive/create.md | 26 + .assets/pspace/shared-drive/delete.md | 22 + .assets/pspace/shared-drive/get.md | 22 + .assets/pspace/shared-drive/help.md | 23 + .assets/pspace/shared-drive/help/commands.md | 27 + .assets/pspace/shared-drive/list.md | 34 + .assets/pspace/signup.md | 21 + .assets/pspace/snapshot.md | 31 + .assets/pspace/snapshot/create.md | 24 + .assets/pspace/snapshot/delete.md | 22 + .assets/pspace/snapshot/help.md | 23 + .assets/pspace/snapshot/help/commands.md | 27 + .assets/pspace/snapshot/list.md | 34 + .assets/pspace/snapshot/restore.md | 23 + .assets/pspace/startup-script.md | 31 + .assets/pspace/startup-script/assign.md | 23 + .assets/pspace/startup-script/create.md | 25 + .assets/pspace/startup-script/delete.md | 22 + .assets/pspace/startup-script/get.md | 22 + .assets/pspace/startup-script/help.md | 23 + .../pspace/startup-script/help/commands.md | 27 + .assets/pspace/startup-script/list.md | 33 + .assets/pspace/startup-script/unassign.md | 23 + .assets/pspace/startup-script/update.md | 26 + .assets/pspace/storage-provider.md | 30 + .assets/pspace/storage-provider/create.md | 24 + .../pspace/storage-provider/create/help.md | 23 + .../storage-provider/create/help/commands.md | 27 + .assets/pspace/storage-provider/create/s3.md | 31 + .assets/pspace/storage-provider/delete.md | 22 + .assets/pspace/storage-provider/get.md | 22 + .assets/pspace/storage-provider/help.md | 23 + .../pspace/storage-provider/help/commands.md | 27 + .assets/pspace/storage-provider/list.md | 32 + .assets/pspace/storage-provider/update.md | 24 + .../pspace/storage-provider/update/help.md | 23 + .../storage-provider/update/help/commands.md | 27 + .assets/pspace/storage-provider/update/s3.md | 31 + .assets/pspace/up.md | 54 + .assets/pspace/upgrade.md | 34 + .assets/pspace/version.md | 21 + .scripts/generate-docs.ts | 33 +- .scripts/zcli-json.ts | 228 + deno.lock | 201 +- 162 files changed, 4595 insertions(+), 4627 deletions(-) create mode 100644 .assets/pspace/autoscaling-group.md create mode 100644 .assets/pspace/autoscaling-group/create.md create mode 100644 .assets/pspace/autoscaling-group/delete.md create mode 100644 .assets/pspace/autoscaling-group/get.md create mode 100644 .assets/pspace/autoscaling-group/help.md create mode 100644 .assets/pspace/autoscaling-group/help/commands.md create mode 100644 .assets/pspace/autoscaling-group/list.md create mode 100644 .assets/pspace/autoscaling-group/update.md create mode 100644 .assets/pspace/completion.md create mode 100644 .assets/pspace/completion/bash.md create mode 100644 .assets/pspace/completion/fish.md create mode 100644 .assets/pspace/completion/help.md create mode 100644 .assets/pspace/completion/help/commands.md create mode 100644 .assets/pspace/completion/zsh.md create mode 100644 .assets/pspace/config.md create mode 100644 .assets/pspace/config/delete.md create mode 100644 .assets/pspace/config/get.md create mode 100644 .assets/pspace/config/help.md create mode 100644 .assets/pspace/config/help/commands.md create mode 100644 .assets/pspace/config/set.md create mode 100644 .assets/pspace/console.md create mode 100644 .assets/pspace/custom-template.md create mode 100644 .assets/pspace/custom-template/create.md create mode 100644 .assets/pspace/custom-template/delete.md create mode 100644 .assets/pspace/custom-template/get.md create mode 100644 .assets/pspace/custom-template/help.md create mode 100644 .assets/pspace/custom-template/help/commands.md create mode 100644 .assets/pspace/custom-template/list.md create mode 100644 .assets/pspace/dataset.md create mode 100644 .assets/pspace/dataset/create.md create mode 100644 .assets/pspace/dataset/delete.md create mode 100644 .assets/pspace/dataset/get.md create mode 100644 .assets/pspace/dataset/help.md create mode 100644 .assets/pspace/dataset/help/commands.md create mode 100644 .assets/pspace/dataset/list.md create mode 100644 .assets/pspace/dataset/update.md create mode 100644 .assets/pspace/dataset/versions.md create mode 100644 .assets/pspace/dataset/versions/create.md create mode 100644 .assets/pspace/dataset/versions/delete.md create mode 100644 .assets/pspace/dataset/versions/get.md create mode 100644 .assets/pspace/dataset/versions/help.md create mode 100644 .assets/pspace/dataset/versions/help/commands.md create mode 100644 .assets/pspace/dataset/versions/list.md create mode 100644 .assets/pspace/dataset/versions/update.md create mode 100644 .assets/pspace/deployment.md create mode 100644 .assets/pspace/deployment/delete.md create mode 100644 .assets/pspace/deployment/get.md create mode 100644 .assets/pspace/deployment/help.md create mode 100644 .assets/pspace/deployment/help/commands.md create mode 100644 .assets/pspace/deployment/list.md create mode 100644 .assets/pspace/deployment/up.md create mode 100644 .assets/pspace/docs.md create mode 100644 .assets/pspace/help.md create mode 100644 .assets/pspace/help/commands.md create mode 100644 .assets/pspace/init.md create mode 100644 .assets/pspace/login.md create mode 100644 .assets/pspace/logout.md create mode 100644 .assets/pspace/machine-event.md create mode 100644 .assets/pspace/machine-event/get.md create mode 100644 .assets/pspace/machine-event/help.md create mode 100644 .assets/pspace/machine-event/help/commands.md create mode 100644 .assets/pspace/machine-event/list.md create mode 100644 .assets/pspace/machine.md create mode 100644 .assets/pspace/machine/create.md create mode 100644 .assets/pspace/machine/delete.md create mode 100644 .assets/pspace/machine/get.md create mode 100644 .assets/pspace/machine/help.md create mode 100644 .assets/pspace/machine/help/commands.md create mode 100644 .assets/pspace/machine/list.md create mode 100644 .assets/pspace/machine/restart.md create mode 100644 .assets/pspace/machine/start.md create mode 100644 .assets/pspace/machine/stop.md create mode 100644 .assets/pspace/machine/update.md create mode 100644 .assets/pspace/model.md create mode 100644 .assets/pspace/model/create.md create mode 100644 .assets/pspace/model/delete.md create mode 100644 .assets/pspace/model/get.md create mode 100644 .assets/pspace/model/help.md create mode 100644 .assets/pspace/model/help/commands.md create mode 100644 .assets/pspace/model/list.md create mode 100644 .assets/pspace/os-template.md create mode 100644 .assets/pspace/os-template/help.md create mode 100644 .assets/pspace/os-template/help/commands.md create mode 100644 .assets/pspace/os-template/list.md create mode 100644 .assets/pspace/private-network.md create mode 100644 .assets/pspace/private-network/create.md create mode 100644 .assets/pspace/private-network/delete.md create mode 100644 .assets/pspace/private-network/get.md create mode 100644 .assets/pspace/private-network/help.md create mode 100644 .assets/pspace/private-network/help/commands.md create mode 100644 .assets/pspace/private-network/list.md create mode 100644 .assets/pspace/project.md create mode 100644 .assets/pspace/project/create.md create mode 100644 .assets/pspace/project/delete.md create mode 100644 .assets/pspace/project/get.md create mode 100644 .assets/pspace/project/help.md create mode 100644 .assets/pspace/project/help/commands.md create mode 100644 .assets/pspace/project/link.md create mode 100644 .assets/pspace/project/list.md create mode 100644 .assets/pspace/project/update.md create mode 100644 .assets/pspace/public-ip.md create mode 100644 .assets/pspace/public-ip/assign.md create mode 100644 .assets/pspace/public-ip/claim.md create mode 100644 .assets/pspace/public-ip/help.md create mode 100644 .assets/pspace/public-ip/help/commands.md create mode 100644 .assets/pspace/public-ip/list.md create mode 100644 .assets/pspace/public-ip/release.md create mode 100644 .assets/pspace/secret.md create mode 100644 .assets/pspace/secret/create.md create mode 100644 .assets/pspace/secret/delete.md create mode 100644 .assets/pspace/secret/get.md create mode 100644 .assets/pspace/secret/help.md create mode 100644 .assets/pspace/secret/help/commands.md create mode 100644 .assets/pspace/secret/list.md create mode 100644 .assets/pspace/secret/update.md create mode 100644 .assets/pspace/shared-drive.md create mode 100644 .assets/pspace/shared-drive/create.md create mode 100644 .assets/pspace/shared-drive/delete.md create mode 100644 .assets/pspace/shared-drive/get.md create mode 100644 .assets/pspace/shared-drive/help.md create mode 100644 .assets/pspace/shared-drive/help/commands.md create mode 100644 .assets/pspace/shared-drive/list.md create mode 100644 .assets/pspace/signup.md create mode 100644 .assets/pspace/snapshot.md create mode 100644 .assets/pspace/snapshot/create.md create mode 100644 .assets/pspace/snapshot/delete.md create mode 100644 .assets/pspace/snapshot/help.md create mode 100644 .assets/pspace/snapshot/help/commands.md create mode 100644 .assets/pspace/snapshot/list.md create mode 100644 .assets/pspace/snapshot/restore.md create mode 100644 .assets/pspace/startup-script.md create mode 100644 .assets/pspace/startup-script/assign.md create mode 100644 .assets/pspace/startup-script/create.md create mode 100644 .assets/pspace/startup-script/delete.md create mode 100644 .assets/pspace/startup-script/get.md create mode 100644 .assets/pspace/startup-script/help.md create mode 100644 .assets/pspace/startup-script/help/commands.md create mode 100644 .assets/pspace/startup-script/list.md create mode 100644 .assets/pspace/startup-script/unassign.md create mode 100644 .assets/pspace/startup-script/update.md create mode 100644 .assets/pspace/storage-provider.md create mode 100644 .assets/pspace/storage-provider/create.md create mode 100644 .assets/pspace/storage-provider/create/help.md create mode 100644 .assets/pspace/storage-provider/create/help/commands.md create mode 100644 .assets/pspace/storage-provider/create/s3.md create mode 100644 .assets/pspace/storage-provider/delete.md create mode 100644 .assets/pspace/storage-provider/get.md create mode 100644 .assets/pspace/storage-provider/help.md create mode 100644 .assets/pspace/storage-provider/help/commands.md create mode 100644 .assets/pspace/storage-provider/list.md create mode 100644 .assets/pspace/storage-provider/update.md create mode 100644 .assets/pspace/storage-provider/update/help.md create mode 100644 .assets/pspace/storage-provider/update/help/commands.md create mode 100644 .assets/pspace/storage-provider/update/s3.md create mode 100644 .assets/pspace/up.md create mode 100644 .assets/pspace/upgrade.md create mode 100644 .assets/pspace/version.md create mode 100644 .scripts/zcli-json.ts diff --git a/.assets/pspace.json b/.assets/pspace.json index c7f485f..923da56 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-14T05:02:13.799Z", + "buildDate": "2024-05-22T15:40:50.043Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, @@ -19207,4 +19207,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/.assets/pspace.md b/.assets/pspace.md index 24f8766..7028821 100644 --- a/.assets/pspace.md +++ b/.assets/pspace.md @@ -1,42 +1,30 @@ -# Paperspace CLI +# pspace -A CLI for using the Paperspace API. +A CLI for using the Paperspace API. It allows you to authenticate, launch deployments, do logging, and more. -- Deploy an ML app with the `deployment` command -- View a deployed app with the `deployment open` command -- Check the status of a deployment with the `deployment status` command +* Deploy an ML app with the `deployment` command +* View a deployed app with the `deployment open` command +* Check the status of a deployment with the `deployment status` command Read the full documentation at: https://docs.paperspace.com/ -## pspace - -A CLI for using the Paperspace API. - -It allows you to authenticate, launch deployments, do logging, and more. - -- Deploy an ML app with the `deployment` command -- View a deployed app with the `deployment open` command -- Check the status of a deployment with the `deployment status` command - -Read the full documentation at: https://docs.paperspace.com/ - -### Usage +## Usage ``` -pspace [command] -pspace [flags] + pspace [command] + pspace [flags] ``` -### Flags +## Flags -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | ### Subcommands @@ -68,4389 +56,3 @@ pspace [flags] - [up](#up) - [upgrade](#upgrade) - [version](#version) - -## pspace autoscaling-group - -Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes -cluster-autoscaler to automatically scale your cluster. You can also autoscaling -groups as a primitive for your own autoscaler. - -### Usage - -``` -autoscaling-group [command] -autoscaling-group [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace autoscaling-group create - -Create an autoscaling group. - -### Usage - -``` -autoscaling-group create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | true | -| cluster-id | | The ID of the cluster | true | -| machine-type | | The machine type for the autoscaling group | true | -| network-id | | The ID of the network for the autoscaling group | true | -| template-id | | The ID of the template for the autoscaling group | true | -| startup-script-id | | The ID of the startup script for the autoscaling group | true | -| max | | The maximum number of active machines in the autoscaling group | true | -| min | | The minimum number of active machines in the autoscaling group | true | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group delete - -Delete an autoscaling group from a team. - -### Usage - -``` -autoscaling-group delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group get - -Get an autoscaling group from a team. - -### Usage - -``` -autoscaling-group get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group help - -Show help for a autoscaling-group command - -### Usage - -``` -autoscaling-group help [command] -autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace autoscaling-group help commands - -List autoscaling-group commands - -Example: - -``` -$ autoscaling-group help commands commands -``` - -### Usage - -``` -autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace autoscaling-group list - -List autoscaling groups in your team. - -Pick a subset of fields to display: - -``` -pspace autoscaling-group list -F name -F dtCreated -``` - -### Usage - -``` -autoscaling-group list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------ | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| cluster-id | | Filter by cluster ID. | false | -| machine-type | | Filter by machine type. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace autoscaling-group update - -Update an autoscaling group. - -### Usage - -``` -autoscaling-group update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| -------------------- | ------- | -------------------------------------------------------------------------- | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the autoscaling group | false | -| cluster-id | | The ID of the cluster | false | -| machine-type | | The machine type for the autoscaling group | false | -| network-id | | The ID of the network for the autoscaling group | false | -| template-id | | The ID of the template for the autoscaling group | false | -| startup-script-id | | The ID of the startup script for the autoscaling group | false | -| max | | The maximum number of active machines in the autoscaling group | false | -| min | | The minimum number of active machines in the autoscaling group | false | -| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | -| current | | The desired number of active machines in the autoscaling group | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion - -Generate an autocompletion script for pspace in the specified shell. See each -sub-command's help for details on how to use the generated script. - -### Usage - -``` -completion [command] -completion [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [bash](#bash) -- [fish](#fish) -- [help](#help) -- [zsh](#zsh) - -## pspace completion bash - -Generate the autocompletion script for the bash shell. - -This script depends on the `bash-completion` package. If it is not installed -already, you can install it via your OS's package manager. - -To load completions in your current shell session: - -``` -$ source <(completion bash bash) -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion bash bash > /etc/bash_completion.d/pspace -``` - -macOS: - -``` -$ completion bash bash > /usr/local/etc/bash_completion.d/pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion bash [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion fish - -Generate the autocompletion script for the fish shell. - -To load completions in your current shell session: - -``` -$ completion fish fish | source -``` - -To load completions for every new session, execute once: - -``` -$ completion fish fish > ~/.config/fish/completions/pspace.fish -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion fish [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace completion help - -Show help for a completion command - -### Usage - -``` -completion help [command] -completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace completion help commands - -List completion commands - -Example: - -``` -$ completion help commands commands -``` - -### Usage - -``` -completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace completion zsh - -Generate the autocompletion script for the zsh shell. - -If shell completion is not already enabled in your environment you will need to -enable it. You can execute the following once: - -``` -$ echo "autoload -U compinit; compinit" >> ~/.zshrc -``` - -To load completions for every new session, execute once: - -Linux: - -``` -$ completion zsh zsh > "${fpath[1]}/_pspace" -``` - -macOS: - -``` -$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace -``` - -Oh My Zsh: - -``` -$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace -``` - -You will need to start a new shell for this setup to take effect. - -### Usage - -``` -completion zsh [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------------- | ------- | ------------------------------------------------------------ | -------- | -| no-descriptions | | Disable completion descriptions | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config - -This command manages your Paperspace configuration. You can use it to set, get, -and delete configuration values. Running this command without any subcommands -will print your current configuration. - -Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. - -For example, to set the current team, run: - -``` -pspace config set team "my-team" -``` - -### Usage - -``` -config [command] -config [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [set](#set) - -## pspace config delete - -Delete a configuration value. - -### Usage - -``` -config delete [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config get - -This command gets a configuration value. You can pass a key to get a specific -value, or you can pass no arguments to get all configuration values. - -For example, to get the current team run: - -``` -pspace config get team -``` - -### Usage - -``` -config get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace config help - -Show help for a config command - -### Usage - -``` -config help [command] -config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace config help commands - -List config commands - -Example: - -``` -$ config help commands commands -``` - -### Usage - -``` -config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace config set - -Set a configuration value. - -### Usage - -``` -config set [arguments] [arguments...] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace console - -This command opens the Paperspace web console in your browser. - -### Usage - -``` -console [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template - -Manage your custom templates. Custom templates are a backup of your machine's -disk. They can be used to create additional machines. You can use them to -prepopulate a machine with your desired software stack. - -For more information, see https://docs.paperspace.com/compute/custom-templates. - -### Usage - -``` -custom-template [command] -custom-template [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) - -## pspace custom-template create - -Create a custom template from a machine. - -### Usage - -``` -custom-template create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ---------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the custom template | true | -| machine-id | m | The ID of the machine to create a custom template from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template delete - -Delete a custom template from a team. - -### Usage - -``` -custom-template delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template get - -Get a custom template from a team. - -### Usage - -``` -custom-template get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace custom-template help - -Show help for a custom-template command - -### Usage - -``` -custom-template help [command] -custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace custom-template help commands - -List custom-template commands - -Example: - -``` -$ custom-template help commands commands -``` - -### Usage - -``` -custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace custom-template list - -List custom templates in your team. - -Pick a subset of fields to display: - -``` -pspace custom-template list -F name -F dtModified -``` - -### Usage - -``` -custom-template list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------------- | ------- | -------------------------------------------------------------------- | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events | | -| will be returned. | false | | | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset - -Manage your datasets. - -For more information, see https://docs.paperspace.com/storage/datasets. - -### Usage - -``` -dataset [command] -dataset [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -- [versions](#versions) - -## pspace dataset create - -Create a dataset. - -### Usage - -``` -dataset create [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| storage-provider-id | | The ID of the storage provider to use for the dataset | false | -| is-public | | Whether the dataset is public | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset delete - -Delete a dataset from a team. - -### Usage - -``` -dataset delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset get - -Get a dataset from a team. - -### Usage - -``` -dataset get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset help - -Show help for a dataset command - -### Usage - -``` -dataset help [command] -dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace dataset help commands - -List dataset commands - -Example: - -``` -$ dataset help commands commands -``` - -### Usage - -``` -dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace dataset list - -List datasets in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset list -F name -F dtModified -``` - -### Usage - -``` -dataset list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset update - -Update a dataset in a project or team. - -### Usage - -``` -dataset update [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the dataset | true | -| description | | The description of the dataset | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions - -Manage your dataset versions. - -For more information, see https://docs.paperspace.com/storage/datasetVersions. - -### Usage - -``` -dataset versions [command] -dataset versions [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) - -## pspace dataset versions create - -Create a dataset version. This command will prompt you for an ID if you don't -provide one. - -### Usage - -``` -dataset versions create [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions delete - -Delete a dataset version from a team. This command will prompt you for an ID if -you don't provide one. - -### Usage - -``` -dataset versions delete [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions get - -Get a dataset version from a team. This command will prompt you for an ID if you -don't provide one. - -### Usage - -``` -dataset versions get [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions help - -Show help for a versions command - -### Usage - -``` -dataset versions help [command] -dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace dataset versions help commands - -List versions commands - -Example: - -``` -$ dataset versions help commands commands -``` - -### Usage - -``` -dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace dataset versions list - -List dataset versions in your team or project. - -Pick a subset of fields to display: - -``` -pspace dataset versions list -F name -F dtModified -``` - -### Usage - -``` -dataset versions list [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace dataset versions update - -Update a dataset version in a project or team. - -### Usage - -``` -dataset versions update [arguments] [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| message | m | The description of the dataset version | true | -| tags | | The tags for the version, comma-delimited | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment - -Effortlessly deploy ML apps to Paperspace. - -### Usage - -``` -deployment [command] -deployment [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [up](#up) - -## pspace deployment delete - -Delete a deployment by its ID. If you don't provide an ID, this command will -prompt you for one based on the deployments you have access to. - -``` -pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 -``` - -### Usage - -``` -deployment delete [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment get - -Get a deployment by its ID. If you don't provide an ID, this command will prompt -you for one based on the deployments you have access to. - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -``` - -Pick a subset of fields to display: - -``` -pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name -``` - -### Usage - -``` -deployment get [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment help - -Show help for a deployment command - -### Usage - -``` -deployment help [command] -deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace deployment help commands - -List deployment commands - -Example: - -``` -$ deployment help commands commands -``` - -### Usage - -``` -deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace deployment list - -List deployments in your team. - -Pick a subset of fields to display: - -``` -pspace deployment list -F id -F name -``` - -### Usage - -``` -deployment list [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace deployment up - -This will create a new deployment for your app or update it if it already -exists. You can optionally specify a path to a config file. If no config file is -specified, the default config file paths will be tried. - -Create a new deployment for the app in the current directory. - -``` -$ pspace deployment create -``` - -Create a new deployment using a config file. - -``` -$ pspace deployment create -c paperspace.json -``` - -Create a new deployment for an app in a different directory. - -``` -$ pspace deployment create --cwd ../my-app -``` - -Create a new deployment for an app in a specific project. - -``` -$ pspace deployment create --project-id 1234 -``` - -### Usage - -``` -deployment up [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------ | ------- | ----------------------------------------------------------------------- | -------- | -| config | c | The path to the config file. Defaults to our default config file paths. | | - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | | project-id | p | The ID of the project to - deploy to. | false | | cwd | | The directory to deploy the app from. Defaults - to the current directory. | false | | log-level | l | Enable debug logging. | - false | | json | j | Output JSON | false | | api-key | | A Paperspace public - API Key used for authenticating requests | false | | help | h | Show help for - a command | false | - -### Subcommands - -## pspace docs - -This command opens the Paperspace documentation in your browser. You can -optionally pass an argument that will take you to a specific docs page. - -Valid pages are: - -- `d`, `deployment` - -### Usage - -``` -docs [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace help - -Show help for a pspace command - -### Usage - -``` -help [command] -help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) - -## pspace help commands - -List pspace commands - -Example: - -``` -$ help commands commands -``` - -### Usage - -``` -help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| --------- | ------- | ------------------------------------------------------------ | -------- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace init - -Create a new Paperspace app. This will create a new directory with a default app -structure. You can optionally specify a name for the app and a template to use. -If no template is specified, the default template will be used. - -Create a new app in the current directory. - -``` -$ pspace init -``` - -Create a new app named "my-app" relative to the current directory. - -``` -$ pspace init my-app -``` - -Create a new app named "my-app" relative to the current directory using a -template from the Paperspace GitHub organization. - -``` -$ pspace init my-app -t Paperspace/gradio-demo -``` - -### Usage - -``` -init [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ------------------------------------------------- | ------- | ---------------------------------------------------------- | -------- | -| template | t | A template to use when creating the app. This can be a URL | | -| to a git repository or a shorthand template name. | | | | - -These templates are equivalent: - -``` -user/repo -github:user/repo -git@github.com:user/repo -https://github.com/user/repo -``` - -Download from GitLab: - -``` -gitlab:user/repo -git@gitlab.com:user/repo -https://gitlab.com/user/repo -``` - -Download from Bitbucket - -``` -bitbucket:user/repo -git@bitbucket.org:user/repo -https://bitbucket.org/user/repo -``` - -Specify a tag or branch: - -```` -user/repo#dev # branch -user/repo#v1.2.3 # release tag -user/repo#1234abcd # commit hash -``` | true | -| mode | m | The mode to use when creating the app. This can be either "git" or -"tar". If "git" is specified, the template will be downloaded as a -tarball. Note that "git" clones over SSH, so you must have a valid -SSH key configured with GitHub, Bitbucket, or GitLab. | false | -| name | n | The name of the app. Defaults to the first argument current directory name. | false | -| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace login - -Log in to the CLI using your Paperspace API key or by opening the web console. - -### Usage -```` - -login [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace logout - -Log out of the CLI for the current team, a specific team, or all teams. - -### Usage -``` - -logout [arguments...] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| all | a | Log out of all teams. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine - -Manage your Paperspace machines. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine [command] machine [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [restart](#restart) -- [start](#start) -- [stop](#stop) -- [update](#update) -## pspace machine create - -Create a machine. - -### Usage -``` - -machine create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to create | true | -| template-id | | The ID of the template to create the machine from | true | -| network-id | | The ID of the network to create the machine in | false | -| region | | The region to create the machine in | true | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| take-initial-snapshot | | Whether to take an initial snapshot. | false | -| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| startup-script-id | | The startup script ID. | false | -| email-password | | Whether to email the password. | false | -| start-on-create | | Whether to start the machine on creation. | false | -| enable-nvlink | | Whether to enable NVLink. | false | -| accessor-ids | | The accessors of the machine. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine delete - -Delete a machine from a team. - -### Usage -``` - -machine delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine get - -Get a machine from a team. - -### Usage -``` - -machine get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine help - -Show help for a machine command - -### Usage -``` - -machine help [command] machine help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace machine help commands - -List machine commands - -Example: -``` - -$ machine help commands commands - -``` -### Usage -``` - -machine help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace machine list - -List machines in your team. - -Pick a subset of fields to display: -``` - -pspace machine list -F name -F dtModified - -``` -### Usage -``` - -machine list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| agent-type | a | Filter by agent type. | false | -| machine-type | m | Filter by machine type. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine restart - -Restart a machine from a team. - -### Usage -``` - -machine restart [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine start - -Start a machine from a team. - -### Usage -``` - -machine start [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine stop - -Stop a machine from a team. - -### Usage -``` - -machine stop [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine update - -Update a machine's settings. - -### Usage -``` - -machine update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the machine | true | -| machine-type | | The machine type to update to | true | -| network-id | | The ID of the network to create the machine in | false | -| disk-size | | The size of the machine's disk | true | -| public-ip-type | | The public IP type. | false | -| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | -| auto-snapshot-frequency | | The auto snapshot frequency. | false | -| auto-snapshot-save-count | | The number of auto snapshots to save. | false | -| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | -| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | -| auto-shutdown-force | | Whether to force shutdown the machine. | false | -| restore-point-enabled | | Whether to enable a restore point. | false | -| restore-point-frequency | | The restore point frequency. | false | -| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine-event - -Manage your machine events. Events are asynchronous tasks performed by our system on your machines. -Not all machine commands are asynchronous. For those that are, a machine event will be returned -which can be tracked using this command. - -For more information, see https://docs.paperspace.com/machines. - -### Usage -``` - -machine-event [command] machine-event [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [get](#get) -- [help](#help) -- [list](#list) -## pspace machine-event get - -Get a machine event from a team. - -### Usage -``` - -machine-event get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace machine-event help - -Show help for a machine-event command - -### Usage -``` - -machine-event help [command] machine-event help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace machine-event help commands - -List machine-event commands - -Example: -``` - -$ machine-event help commands commands - -``` -### Usage -``` - -machine-event help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace machine-event list - -List machine events in your team. - -Pick a subset of fields to display: -``` - -pspace machine-event list -F name -F dtModified - -``` -### Usage -``` - -machine-event list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model - -Manage your Paperspace models. - -For more information, see https://docs.paperspace.com/deploying/models. - -### Usage -``` - -model [command] model [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace model create - -Create a new model. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -model create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the model | false | -| description | d | The description of the model | false | -| is-public | | Whether the model is public | false | -| storage-provider-id | s | The ID of the storage provider to use for the model | false | -| project-id | p | The ID of the project to create the model in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model delete - -Delete a model from a team. - -### Usage -``` - -model delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model get - -Get a model from a team. - -### Usage -``` - -model get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace model help - -Show help for a model command - -### Usage -``` - -model help [command] model help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace model help commands - -List model commands - -Example: -``` - -$ model help commands commands - -``` -### Usage -``` - -model help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace model list - -List models in your team. - -Pick a subset of fields to display: -``` - -pspace model list -F name -F dtModified - -``` -### Usage -``` - -model list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace os-template - -List OS templates. OS templates are pre-configured virtual machines that -you can use to create a new machine. - -For more information, see https://docs.paperspace.com/compute/os-templates. - -### Usage -``` - -os-template [command] os-template [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [list](#list) -## pspace os-template help - -Show help for a os-template command - -### Usage -``` - -os-template help [command] os-template help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace os-template help commands - -List os-template commands - -Example: -``` - -$ os-template help commands commands - -``` -### Usage -``` - -os-template help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace os-template list - -List OS templates. - -Pick a subset of fields to display: -``` - -pspace os-template list -F name - -``` -### Usage -``` - -os-template list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network - -Manage your private networks. Private networks are logically isolated networks -for your machines and shared drives. They can also be used for site-to-site VPNs -and direct connections to your on-premise network. - -For more information, see https://docs.paperspace.com/networking/private-networks. - -### Usage -``` - -private-network [command] private-network [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace private-network create - -Create a private network. - -### Usage -``` - -private-network create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the private network | true | -| region | | The region to create the private network in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network delete - -Delete a private network from a team. - -### Usage -``` - -private-network delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network get - -Get a private network from a team. - -### Usage -``` - -private-network get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace private-network help - -Show help for a private-network command - -### Usage -``` - -private-network help [command] private-network help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace private-network help commands - -List private-network commands - -Example: -``` - -$ private-network help commands commands - -``` -### Usage -``` - -private-network help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace private-network list - -List private networks in your team. - -Pick a subset of fields to display: -``` - -pspace private-network list -F name -F dtModified - -``` -### Usage -``` - -private-network list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project - -Manage your Paperspace projects. - -### Usage -``` - -project [command] project [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [link](#link) -- [list](#list) -- [update](#update) -## pspace project create - -Create a new project. This command will prompt you for a name if you don't -provide one. - -### Usage -``` - -project create [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project delete - -Delete a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project get - -Get a project by its ID. If you don't provide an ID, this command will -prompt you for one based on the projects you have access to. - -### Usage -``` - -project get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project help - -Show help for a project command - -### Usage -``` - -project help [command] project help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace project help commands - -List project commands - -Example: -``` - -$ project help commands commands - -``` -### Usage -``` - -project help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace project link - -This will link a remote project to a local directory. Commands that -depend on a project ID will use the project ID of the linked project -when communicating with the Paperspace API. - -Link a project to the current directory. -``` - -$ pspace link - -``` -Link a project to a different directory. -``` - -$ pspace link --cwd ../my-app - -``` -Link a project and specify a project ID. -``` - -$ pspace link pzwf2g05ubegj - -``` -### Usage -``` - -project link [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| cwd | | The directory to link the project to. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project list - -List projects in your team. - -Pick a subset of fields to display: -``` - -pspace project list -F id -F name -F dtCreated - -``` -### Usage -``` - -project list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace project update - -Update an existing project. - -Example: -``` - -pspace project update psukfyemho7 --name my-cool-project - -``` -### Usage -``` - -pspace project update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| name | | The new name for the project. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip - -Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. - -For more information, see https://docs.paperspace.com/networking/public-ips. - -### Usage -``` - -public-ip [command] public-ip [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [assign](#assign) -- [claim](#claim) -- [help](#help) -- [list](#list) -- [release](#release) -## pspace public-ip assign - -Assign a public IP to a machine. - -### Usage -``` - -public-ip assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine to assign the public IP to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip claim - -Claim a public IP for a team. - -### Usage -``` - -public-ip claim [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| region | r | The region to claim the public IP in | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip help - -Show help for a public-ip command - -### Usage -``` - -public-ip help [command] public-ip help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace public-ip help commands - -List public-ip commands - -Example: -``` - -$ public-ip help commands commands - -``` -### Usage -``` - -public-ip help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace public-ip list - -List public IPs in your team or project. - -Pick a subset of fields to display: -``` - -pspace public-ip list -F name -F dtModified - -``` -### Usage -``` - -public-ip list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace public-ip release - -Release a public IP from a team. This will unassign it from its assigned machine, if any. - -### Usage -``` - -public-ip release [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret - -Manage your Paperspace secrets. Secrets are used to store sensitive -information such as API keys, passwords, and other credentials. Secrets -can be safely injected into workloads as environment variables. An environment -variable that uses a Secret will not reveal the contents of the secret itself. - -Secrets can be created at the following levels: - -- Project (default): these secrets are applied to all resources in a project -- Global: these secrets can be applied to all resources on your current team - -For more information, see https://docs.paperspace.com/secrets. - -### Usage -``` - -secret [command] secret [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace secret create - -Create a secret in a project or team. - -### Usage -``` - -secret create [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret delete - -Delete a secret from a project or team. - -### Usage -``` - -secret delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret get - -Get a secret from a project or team. - -### Usage -``` - -secret get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret help - -Show help for a secret command - -### Usage -``` - -secret help [command] secret help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace secret help commands - -List secret commands - -Example: -``` - -$ secret help commands commands - -``` -### Usage -``` - -secret help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace secret list - -List secrets in your team or project. - -Pick a subset of fields to display: -``` - -pspace secret list -F name -F dtModified - -``` -### Usage -``` - -secret list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace secret update - -Update a secret in a project or team. - -### Usage -``` - -secret update [arguments] [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| project-id | p | The ID of the project the secret is in. If not specified, the -secret will be created in the project linked to your current working -directory. If you are not in a project directory, you will be prompted -to select a project. | false | -| global | g | Manage a secret that is available to the entire team you are -currently logged into. By default, secrets are only available to -a project. | false | -| cwd | | The directory to create the secret in | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive - -Manage your shared drives. Shared drives are used to centralize data -used by your team. Shared drives can be mounted on any Paperspace machine -in the same private network. - -For more information, see https://docs.paperspace.com/storage/shared-drives. - -### Usage -``` - -shared-drive [command] shared-drive [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -## pspace shared-drive create - -Create a shared drive. - -### Usage -``` - -shared-drive create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the shared drive | true | -| network-id | | The ID of the network to create the shared drive in | true | -| region | | The region to create the shared drive in | true | -| size | | The size of the shared drive | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive delete - -Delete a shared drive from a team. - -### Usage -``` - -shared-drive delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive get - -Get a shared drive from a team. - -### Usage -``` - -shared-drive get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace shared-drive help - -Show help for a shared-drive command - -### Usage -``` - -shared-drive help [command] shared-drive help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace shared-drive help commands - -List shared-drive commands - -Example: -``` - -$ shared-drive help commands commands - -``` -### Usage -``` - -shared-drive help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace shared-drive list - -List shared drives in your team or project. - -Pick a subset of fields to display: -``` - -pspace shared-drive list -F name -F dtModified - -``` -### Usage -``` - -shared-drive list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| region | r | Filter by region. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace signup - -This command opens the Paperspace signup page in your browser. - -### Usage -``` - -signup [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot - -Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. -They can be used to restore the machine to its previous state. Using snapshots is recommended -before taking any action that could affect the usability of the machine or its network connection. - -For more information, see https://docs.paperspace.com/storage/snapshots. - -### Usage -``` - -snapshot [command] snapshot [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [help](#help) -- [list](#list) -- [restore](#restore) -## pspace snapshot create - -Create a snapshot from a machine. - -### Usage -``` - -snapshot create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the snapshot | true | -| machine-id | m | The ID of the machine to create a snapshot from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot delete - -Delete a snapshot from a team. - -### Usage -``` - -snapshot delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot help - -Show help for a snapshot command - -### Usage -``` - -snapshot help [command] snapshot help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace snapshot help commands - -List snapshot commands - -Example: -``` - -$ snapshot help commands commands - -``` -### Usage -``` - -snapshot help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace snapshot list - -List snapshots in your team. - -Pick a subset of fields to display: -``` - -pspace snapshot list -F name -F dtModified - -``` -### Usage -``` - -snapshot list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| machine-id | m | The ID of the machine the event is for. If not specified, all events -will be returned. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace snapshot restore - -Restore a machine to a snapshot. - -### Usage -``` - -snapshot restore [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| create-snapshot | | Create an additional snapshot before restore | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script - -Manage your startup scripts. Startup scripts allow you to configure a machine -on first boot or on every boot. - -### Usage -``` - -startup-script [command] startup-script [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [assign](#assign) -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [unassign](#unassign) -- [update](#update) -## pspace startup-script assign - -Assign a startup script to a machine. - -### Usage -``` - -startup-script assign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to assign the startup script to | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script create - -Create a startup script. - -### Usage -``` - -startup-script create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | true | -| script | | The script to run | true | -| run-once | | Whether to run once or on every boot | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script delete - -Delete a startup script from a team. - -### Usage -``` - -startup-script delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script get - -Get a startup script from a team. - -### Usage -``` - -startup-script get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script help - -Show help for a startup-script command - -### Usage -``` - -startup-script help [command] startup-script help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace startup-script help commands - -List startup-script commands - -Example: -``` - -$ startup-script help commands commands - -``` -### Usage -``` - -startup-script help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace startup-script list - -List startup scripts in your team. - -Pick a subset of fields to display: -``` - -pspace startup-script list -F name -F dtCreated - -``` -### Usage -``` - -startup-script list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| name | n | Filter by name. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script unassign - -Unassign a startup script from a machine. - -### Usage -``` - -startup-script unassign [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| machine-id | | The ID of the machine to unassign the startup script from | true | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace startup-script update - -Update a startup script. - -### Usage -``` - -startup-script update [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the startup script | false | -| script | | The script to run | false | -| run-once | | Whether to run once or on every boot | false | -| enabled | | Whether the startup script is enabled or not | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider - -Manage your storage providers. - -For more information, see https://docs.paperspace.com/storage/storageProviders. - -### Usage -``` - -storage-provider [command] storage-provider [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [create](#create) -- [delete](#delete) -- [get](#get) -- [help](#help) -- [list](#list) -- [update](#update) -## pspace storage-provider create - -Create a storage provider. - -### Usage -``` - -storage-provider create [command] storage-provider create [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider create help - -Show help for a create command - -### Usage -``` - -storage-provider create help [command] storage-provider create help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider create help commands - -List create commands - -Example: -``` - -$ storage-provider create help commands commands - -``` -### Usage -``` - -storage-provider create help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider create s3 - -Create an S3 storage provider. - -### Usage -``` - -storage-provider create s3 [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | false | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider delete - -Delete a storage provider from a team. - -### Usage -``` - -storage-provider delete [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider get - -Get a storage provider from a team. - -### Usage -``` - -storage-provider get [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider help - -Show help for a storage-provider command - -### Usage -``` - -storage-provider help [command] storage-provider help [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider help commands - -List storage-provider commands - -Example: -``` - -$ storage-provider help commands commands - -``` -### Usage -``` - -storage-provider help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider list - -List storage providers in your team or project. - -Pick a subset of fields to display: -``` - -pspace storage provider list -F name -F dtModified - -``` -### Usage -``` - -storage-provider list [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| limit | | The number of items to return in the next page. | false | -| after | | The cursor to fetch the next results from. | false | -| orderBy | | The field to order items by. | false | -| asc | | Whether to order items ascending. | false | -| desc | | Whether to order items descending. | false | -| fields | F | The fields to include in the response. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace storage-provider update - -Update a storage provider. - -### Usage -``` - -storage-provider update [command] storage-provider update [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [help](#help) -- [s3](#s3) -## pspace storage-provider update help - -Show help for a update command - -### Usage -``` - -storage-provider update help [command] storage-provider update help [arguments] -[flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -- [commands](#commands) -## pspace storage-provider update help commands - -List update commands - -Example: -``` - -$ storage-provider update help commands commands - -``` -### Usage -``` - -storage-provider update help commands [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | -| all | a | Show all commands, including hidden ones | false | - -### Subcommands - -## pspace storage-provider update s3 - -Update an S3 storage provider in a project or team. - -### Usage -``` - -storage-provider update s3 [arguments] [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| fields | F | The fields to include in the response. | false | -| name | n | The name of the storage provider | true | -| is-team-default | | Whether the storage provider is the team's default provider | true | -| endpoint | | The endpoint of the storage provider | false | -| bucket | | The bucket of the storage provider | true | -| region | | The region of the storage provider | false | -| access-key | | The access key of the storage provider | true | -| secret-access-key | | The secret access key of the storage provider | true | -| signature-version | | The signature version of the storage provider | false | -| retain-data | | Whether to retain data in the storage provider | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace up - -This will upsert an app config and deploy your app to Paperspace. You can optionally -specify a path to a config file. If no config file is specified, the default -config file paths will be tried. - -Deploy the app in the current directory. -``` - -$ pspace up - -``` -Deploy the app using a config file. -``` - -$ pspace up -c paperspace.json - -``` -Deploy an app in a different directory. -``` - -$ pspace up --cwd ../my-app - -``` -### Usage -``` - -up [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| config | c | The path to the config file. Defaults to our default config file paths. - -The default config file paths are in order of precedence: - -- `paperspace.yaml` -- `paperspace.yml` -- `paperspace.json` -- `paperspace.jsonc` -- `paperspace.toml` -- `.paperspace/app.yaml` -- `.paperspace/app.yml` -- `.paperspace/app.json` -- `.paperspace/app.jsonc` -- `.paperspace/app.toml` | false | -| project-id | p | The ID of the project to deploy to. | false | -| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace upgrade - -This command upgrades pspace to the latest version. - -If you used a package manager like `brew` to install `pspace`, -you should use that to upgrade in order to avoid potential permissions -issues. For example, for `brew` you can upgrade by running: -``` - -brew upgrade pspace - -``` -If you installed `pspace` using the install script, you can upgrade by -running: -``` - -pspace upgrade - -``` -### Usage -``` - -upgrade [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands - -## pspace version - -Shows version information command, including version number and build date. - -### Usage -``` - -version [flags] - -``` -### Flags - -| Name | Aliases | Description | Required | -| --- | --- | --- | --- | -| log-level | l | Enable debug logging. | false | -| json | j | Output JSON | false | -| api-key | | A Paperspace public API Key used for authenticating requests | false | -| help | h | Show help for a command | false | - -### Subcommands -``` diff --git a/.assets/pspace/autoscaling-group.md b/.assets/pspace/autoscaling-group.md new file mode 100644 index 0000000..0086595 --- /dev/null +++ b/.assets/pspace/autoscaling-group.md @@ -0,0 +1,30 @@ +# pspace autoscaling-group + +Manage your autoscaling groups. Autoscaling groups enable using +the Kubernetes cluster-autoscaler to automatically scale your cluster. +You can also autoscaling groups as a primitive for your own autoscaler. + +## Usage + +``` + autoscaling-group [command] + autoscaling-group [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/autoscaling-group/create.md b/.assets/pspace/autoscaling-group/create.md new file mode 100644 index 0000000..cb6a760 --- /dev/null +++ b/.assets/pspace/autoscaling-group/create.md @@ -0,0 +1,31 @@ +# pspace autoscaling-group create + +Create an autoscaling group. + +## Usage + +``` + autoscaling-group create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | true | +| cluster-id | | The ID of the cluster | true | +| machine-type | | The machine type for the autoscaling group | true | +| network-id | | The ID of the network for the autoscaling group | true | +| template-id | | The ID of the template for the autoscaling group | true | +| startup-script-id | | The ID of the startup script for the autoscaling group | true | +| max | | The maximum number of active machines in the autoscaling group | true | +| min | | The minimum number of active machines in the autoscaling group | true | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/delete.md b/.assets/pspace/autoscaling-group/delete.md new file mode 100644 index 0000000..4f332b4 --- /dev/null +++ b/.assets/pspace/autoscaling-group/delete.md @@ -0,0 +1,22 @@ +# pspace autoscaling-group delete + +Delete an autoscaling group from a team. + +## Usage + +``` + autoscaling-group delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/get.md b/.assets/pspace/autoscaling-group/get.md new file mode 100644 index 0000000..3f7e032 --- /dev/null +++ b/.assets/pspace/autoscaling-group/get.md @@ -0,0 +1,22 @@ +# pspace autoscaling-group get + +Get an autoscaling group from a team. + +## Usage + +``` + autoscaling-group get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/help.md b/.assets/pspace/autoscaling-group/help.md new file mode 100644 index 0000000..3270e64 --- /dev/null +++ b/.assets/pspace/autoscaling-group/help.md @@ -0,0 +1,23 @@ +# pspace autoscaling-group help + +Show help for a autoscaling-group command + +## Usage + +``` + autoscaling-group help [command] + autoscaling-group help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md new file mode 100644 index 0000000..7c21fbb --- /dev/null +++ b/.assets/pspace/autoscaling-group/help/commands.md @@ -0,0 +1,27 @@ +# pspace autoscaling-group help commands + +List autoscaling-group commands + +Example: +``` +$ autoscaling-group help commands commands +``` + +## Usage + +``` + autoscaling-group help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/list.md b/.assets/pspace/autoscaling-group/list.md new file mode 100644 index 0000000..f2c0eed --- /dev/null +++ b/.assets/pspace/autoscaling-group/list.md @@ -0,0 +1,34 @@ +# pspace autoscaling-group list + +List autoscaling groups in your team. + +Pick a subset of fields to display: +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +## Usage + +``` + autoscaling-group list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| cluster-id | | Filter by cluster ID. | false | +| machine-type | | Filter by machine type. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/autoscaling-group/update.md b/.assets/pspace/autoscaling-group/update.md new file mode 100644 index 0000000..46ba46a --- /dev/null +++ b/.assets/pspace/autoscaling-group/update.md @@ -0,0 +1,32 @@ +# pspace autoscaling-group update + +Update an autoscaling group. + +## Usage + +``` + autoscaling-group update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the autoscaling group | false | +| cluster-id | | The ID of the cluster | false | +| machine-type | | The machine type for the autoscaling group | false | +| network-id | | The ID of the network for the autoscaling group | false | +| template-id | | The ID of the template for the autoscaling group | false | +| startup-script-id | | The ID of the startup script for the autoscaling group | false | +| max | | The maximum number of active machines in the autoscaling group | false | +| min | | The minimum number of active machines in the autoscaling group | false | +| provisioning-timeout | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| current | | The desired number of active machines in the autoscaling group | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion.md b/.assets/pspace/completion.md new file mode 100644 index 0000000..ca4ae3f --- /dev/null +++ b/.assets/pspace/completion.md @@ -0,0 +1,27 @@ +# pspace completion + +Generate an autocompletion script for pspace in the specified shell. +See each sub-command's help for details on how to use the generated script. + +## Usage + +``` + completion [command] + completion [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [bash](#bash) +- [fish](#fish) +- [help](#help) +- [zsh](#zsh) diff --git a/.assets/pspace/completion/bash.md b/.assets/pspace/completion/bash.md new file mode 100644 index 0000000..3534d87 --- /dev/null +++ b/.assets/pspace/completion/bash.md @@ -0,0 +1,43 @@ +# pspace completion bash + +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. +If it is not installed already, you can install it via your OS's package manager. + +To load completions in your current shell session: +``` +$ source <(completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: +``` +$ completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion bash [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion/fish.md b/.assets/pspace/completion/fish.md new file mode 100644 index 0000000..aeea101 --- /dev/null +++ b/.assets/pspace/completion/fish.md @@ -0,0 +1,34 @@ +# pspace completion fish + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +``` +$ completion fish fish | source +``` + +To load completions for every new session, execute once: +``` +$ completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion fish [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/completion/help.md b/.assets/pspace/completion/help.md new file mode 100644 index 0000000..994b1d5 --- /dev/null +++ b/.assets/pspace/completion/help.md @@ -0,0 +1,23 @@ +# pspace completion help + +Show help for a completion command + +## Usage + +``` + completion help [command] + completion help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md new file mode 100644 index 0000000..642005b --- /dev/null +++ b/.assets/pspace/completion/help/commands.md @@ -0,0 +1,27 @@ +# pspace completion help commands + +List completion commands + +Example: +``` +$ completion help commands commands +``` + +## Usage + +``` + completion help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/completion/zsh.md b/.assets/pspace/completion/zsh.md new file mode 100644 index 0000000..45d8c01 --- /dev/null +++ b/.assets/pspace/completion/zsh.md @@ -0,0 +1,48 @@ +# pspace completion zsh + +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need +to enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: +``` +$ completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: +``` +$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: +``` +$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +## Usage + +``` + completion zsh [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| no-descriptions | | Disable completion descriptions | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config.md b/.assets/pspace/config.md new file mode 100644 index 0000000..8d59793 --- /dev/null +++ b/.assets/pspace/config.md @@ -0,0 +1,35 @@ +# pspace config + +This command manages your Paperspace configuration. You can use it to set, get, and +delete configuration values. Running this command without any subcommands will print +your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: +``` +pspace config set team "my-team" +``` + +## Usage + +``` + config [command] + config [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [set](#set) diff --git a/.assets/pspace/config/delete.md b/.assets/pspace/config/delete.md new file mode 100644 index 0000000..83cb5b2 --- /dev/null +++ b/.assets/pspace/config/delete.md @@ -0,0 +1,21 @@ +# pspace config delete + +Delete a configuration value. + +## Usage + +``` + config delete [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config/get.md b/.assets/pspace/config/get.md new file mode 100644 index 0000000..c13a592 --- /dev/null +++ b/.assets/pspace/config/get.md @@ -0,0 +1,27 @@ +# pspace config get + +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: +``` +pspace config get team +``` + +## Usage + +``` + config get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/config/help.md b/.assets/pspace/config/help.md new file mode 100644 index 0000000..1ddb36f --- /dev/null +++ b/.assets/pspace/config/help.md @@ -0,0 +1,23 @@ +# pspace config help + +Show help for a config command + +## Usage + +``` + config help [command] + config help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md new file mode 100644 index 0000000..e749bf5 --- /dev/null +++ b/.assets/pspace/config/help/commands.md @@ -0,0 +1,27 @@ +# pspace config help commands + +List config commands + +Example: +``` +$ config help commands commands +``` + +## Usage + +``` + config help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/config/set.md b/.assets/pspace/config/set.md new file mode 100644 index 0000000..82c69b6 --- /dev/null +++ b/.assets/pspace/config/set.md @@ -0,0 +1,21 @@ +# pspace config set + +Set a configuration value. + +## Usage + +``` + config set [arguments] [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md new file mode 100644 index 0000000..973c9e2 --- /dev/null +++ b/.assets/pspace/console.md @@ -0,0 +1,21 @@ +# pspace console + +This command opens the Paperspace web console in your browser. + +## Usage + +``` + console [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template.md b/.assets/pspace/custom-template.md new file mode 100644 index 0000000..e7d12c4 --- /dev/null +++ b/.assets/pspace/custom-template.md @@ -0,0 +1,31 @@ +# pspace custom-template + +Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +## Usage + +``` + custom-template [command] + custom-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/custom-template/create.md b/.assets/pspace/custom-template/create.md new file mode 100644 index 0000000..00b1f0d --- /dev/null +++ b/.assets/pspace/custom-template/create.md @@ -0,0 +1,24 @@ +# pspace custom-template create + +Create a custom template from a machine. + +## Usage + +``` + custom-template create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the custom template | true | +| machine-id | m | The ID of the machine to create a custom template from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/delete.md b/.assets/pspace/custom-template/delete.md new file mode 100644 index 0000000..24b083a --- /dev/null +++ b/.assets/pspace/custom-template/delete.md @@ -0,0 +1,22 @@ +# pspace custom-template delete + +Delete a custom template from a team. + +## Usage + +``` + custom-template delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/get.md b/.assets/pspace/custom-template/get.md new file mode 100644 index 0000000..8eb97ef --- /dev/null +++ b/.assets/pspace/custom-template/get.md @@ -0,0 +1,22 @@ +# pspace custom-template get + +Get a custom template from a team. + +## Usage + +``` + custom-template get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/help.md b/.assets/pspace/custom-template/help.md new file mode 100644 index 0000000..6868f7d --- /dev/null +++ b/.assets/pspace/custom-template/help.md @@ -0,0 +1,23 @@ +# pspace custom-template help + +Show help for a custom-template command + +## Usage + +``` + custom-template help [command] + custom-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md new file mode 100644 index 0000000..e074c6f --- /dev/null +++ b/.assets/pspace/custom-template/help/commands.md @@ -0,0 +1,27 @@ +# pspace custom-template help commands + +List custom-template commands + +Example: +``` +$ custom-template help commands commands +``` + +## Usage + +``` + custom-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/custom-template/list.md b/.assets/pspace/custom-template/list.md new file mode 100644 index 0000000..4d67c93 --- /dev/null +++ b/.assets/pspace/custom-template/list.md @@ -0,0 +1,35 @@ +# pspace custom-template list + +List custom templates in your team. + +Pick a subset of fields to display: +``` +pspace custom-template list -F name -F dtModified +``` + +## Usage + +``` + custom-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset.md b/.assets/pspace/dataset.md new file mode 100644 index 0000000..ad0111f --- /dev/null +++ b/.assets/pspace/dataset.md @@ -0,0 +1,31 @@ +# pspace dataset + +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +## Usage + +``` + dataset [command] + dataset [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) +- [versions](#versions) diff --git a/.assets/pspace/dataset/create.md b/.assets/pspace/dataset/create.md new file mode 100644 index 0000000..966ab9b --- /dev/null +++ b/.assets/pspace/dataset/create.md @@ -0,0 +1,26 @@ +# pspace dataset create + +Create a dataset. + +## Usage + +``` + dataset create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| storage-provider-id | | The ID of the storage provider to use for the dataset | false | +| is-public | | Whether the dataset is public | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/delete.md b/.assets/pspace/dataset/delete.md new file mode 100644 index 0000000..8cf4617 --- /dev/null +++ b/.assets/pspace/dataset/delete.md @@ -0,0 +1,22 @@ +# pspace dataset delete + +Delete a dataset from a team. + +## Usage + +``` + dataset delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/get.md b/.assets/pspace/dataset/get.md new file mode 100644 index 0000000..46aa312 --- /dev/null +++ b/.assets/pspace/dataset/get.md @@ -0,0 +1,22 @@ +# pspace dataset get + +Get a dataset from a team. + +## Usage + +``` + dataset get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/help.md b/.assets/pspace/dataset/help.md new file mode 100644 index 0000000..12b4586 --- /dev/null +++ b/.assets/pspace/dataset/help.md @@ -0,0 +1,23 @@ +# pspace dataset help + +Show help for a dataset command + +## Usage + +``` + dataset help [command] + dataset help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md new file mode 100644 index 0000000..d848fd7 --- /dev/null +++ b/.assets/pspace/dataset/help/commands.md @@ -0,0 +1,27 @@ +# pspace dataset help commands + +List dataset commands + +Example: +``` +$ dataset help commands commands +``` + +## Usage + +``` + dataset help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/list.md b/.assets/pspace/dataset/list.md new file mode 100644 index 0000000..7242d70 --- /dev/null +++ b/.assets/pspace/dataset/list.md @@ -0,0 +1,32 @@ +# pspace dataset list + +List datasets in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset list -F name -F dtModified +``` + +## Usage + +``` + dataset list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/update.md b/.assets/pspace/dataset/update.md new file mode 100644 index 0000000..a9efa84 --- /dev/null +++ b/.assets/pspace/dataset/update.md @@ -0,0 +1,24 @@ +# pspace dataset update + +Update a dataset in a project or team. + +## Usage + +``` + dataset update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the dataset | true | +| description | | The description of the dataset | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions.md b/.assets/pspace/dataset/versions.md new file mode 100644 index 0000000..9cfa3ec --- /dev/null +++ b/.assets/pspace/dataset/versions.md @@ -0,0 +1,30 @@ +# pspace dataset versions + +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +## Usage + +``` + dataset versions [command] + dataset versions [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/dataset/versions/create.md b/.assets/pspace/dataset/versions/create.md new file mode 100644 index 0000000..ed307c4 --- /dev/null +++ b/.assets/pspace/dataset/versions/create.md @@ -0,0 +1,24 @@ +# pspace dataset versions create + +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +## Usage + +``` + dataset versions create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/delete.md b/.assets/pspace/dataset/versions/delete.md new file mode 100644 index 0000000..3234bc6 --- /dev/null +++ b/.assets/pspace/dataset/versions/delete.md @@ -0,0 +1,23 @@ +# pspace dataset versions delete + +Delete a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions delete [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/get.md b/.assets/pspace/dataset/versions/get.md new file mode 100644 index 0000000..c072be6 --- /dev/null +++ b/.assets/pspace/dataset/versions/get.md @@ -0,0 +1,23 @@ +# pspace dataset versions get + +Get a dataset version from a team. This command will prompt you for an ID +if you don't provide one. + +## Usage + +``` + dataset versions get [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/help.md b/.assets/pspace/dataset/versions/help.md new file mode 100644 index 0000000..4cb4876 --- /dev/null +++ b/.assets/pspace/dataset/versions/help.md @@ -0,0 +1,23 @@ +# pspace dataset versions help + +Show help for a versions command + +## Usage + +``` + dataset versions help [command] + dataset versions help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md new file mode 100644 index 0000000..af2d37a --- /dev/null +++ b/.assets/pspace/dataset/versions/help/commands.md @@ -0,0 +1,27 @@ +# pspace dataset versions help commands + +List versions commands + +Example: +``` +$ dataset versions help commands commands +``` + +## Usage + +``` + dataset versions help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/list.md b/.assets/pspace/dataset/versions/list.md new file mode 100644 index 0000000..291e70d --- /dev/null +++ b/.assets/pspace/dataset/versions/list.md @@ -0,0 +1,32 @@ +# pspace dataset versions list + +List dataset versions in your team or project. + +Pick a subset of fields to display: +``` +pspace dataset versions list -F name -F dtModified +``` + +## Usage + +``` + dataset versions list [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/dataset/versions/update.md b/.assets/pspace/dataset/versions/update.md new file mode 100644 index 0000000..aa85218 --- /dev/null +++ b/.assets/pspace/dataset/versions/update.md @@ -0,0 +1,24 @@ +# pspace dataset versions update + +Update a dataset version in a project or team. + +## Usage + +``` + dataset versions update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| message | m | The description of the dataset version | true | +| tags | | The tags for the version, comma-delimited | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment.md b/.assets/pspace/deployment.md new file mode 100644 index 0000000..873960b --- /dev/null +++ b/.assets/pspace/deployment.md @@ -0,0 +1,27 @@ +# pspace deployment + +Effortlessly deploy ML apps to Paperspace. + +## Usage + +``` + deployment [command] + deployment [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [up](#up) diff --git a/.assets/pspace/deployment/delete.md b/.assets/pspace/deployment/delete.md new file mode 100644 index 0000000..7df1430 --- /dev/null +++ b/.assets/pspace/deployment/delete.md @@ -0,0 +1,26 @@ +# pspace deployment delete + +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +## Usage + +``` + deployment delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/get.md b/.assets/pspace/deployment/get.md new file mode 100644 index 0000000..492e10e --- /dev/null +++ b/.assets/pspace/deployment/get.md @@ -0,0 +1,32 @@ +# pspace deployment get + +Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +## Usage + +``` + deployment get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/help.md b/.assets/pspace/deployment/help.md new file mode 100644 index 0000000..5dc0208 --- /dev/null +++ b/.assets/pspace/deployment/help.md @@ -0,0 +1,23 @@ +# pspace deployment help + +Show help for a deployment command + +## Usage + +``` + deployment help [command] + deployment help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md new file mode 100644 index 0000000..5afdb31 --- /dev/null +++ b/.assets/pspace/deployment/help/commands.md @@ -0,0 +1,27 @@ +# pspace deployment help commands + +List deployment commands + +Example: +``` +$ deployment help commands commands +``` + +## Usage + +``` + deployment help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/list.md b/.assets/pspace/deployment/list.md new file mode 100644 index 0000000..d73e118 --- /dev/null +++ b/.assets/pspace/deployment/list.md @@ -0,0 +1,32 @@ +# pspace deployment list + +List deployments in your team. + +Pick a subset of fields to display: +``` +pspace deployment list -F id -F name +``` + +## Usage + +``` + deployment list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/deployment/up.md b/.assets/pspace/deployment/up.md new file mode 100644 index 0000000..bf886a8 --- /dev/null +++ b/.assets/pspace/deployment/up.md @@ -0,0 +1,59 @@ +# pspace deployment up + +This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. +``` +$ pspace deployment create --project-id 1234 +``` + +## Usage + +``` + deployment up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md new file mode 100644 index 0000000..a9638fe --- /dev/null +++ b/.assets/pspace/docs.md @@ -0,0 +1,26 @@ +# pspace docs + +This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` + +## Usage + +``` + docs [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/help.md b/.assets/pspace/help.md new file mode 100644 index 0000000..677a8cf --- /dev/null +++ b/.assets/pspace/help.md @@ -0,0 +1,23 @@ +# pspace help + +Show help for a pspace command + +## Usage + +``` + help [command] + help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md new file mode 100644 index 0000000..ed803ff --- /dev/null +++ b/.assets/pspace/help/commands.md @@ -0,0 +1,27 @@ +# pspace help commands + +List pspace commands + +Example: +``` +$ help commands commands +``` + +## Usage + +``` + help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md new file mode 100644 index 0000000..38e27e7 --- /dev/null +++ b/.assets/pspace/init.md @@ -0,0 +1,77 @@ +# pspace init + +Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +``` +$ pspace init +``` + +Create a new app named "my-app" relative to the current directory. +``` +$ pspace init my-app +``` + +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` +$ pspace init my-app -t Paperspace/gradio-demo +``` + +## Usage + +``` + init [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| template | t | A template to use when creating the app. This can be a URL +to a git repository or a shorthand template name. + +These templates are equivalent: +``` +user/repo +github:user/repo +git@github.com:user/repo +https://github.com/user/repo +``` + +Download from GitLab: +``` +gitlab:user/repo +git@gitlab.com:user/repo +https://gitlab.com/user/repo +``` + +Download from Bitbucket +``` +bitbucket:user/repo +git@bitbucket.org:user/repo +https://bitbucket.org/user/repo +``` + +Specify a tag or branch: +``` +user/repo#dev # branch +user/repo#v1.2.3 # release tag +user/repo#1234abcd # commit hash +``` | true | +| mode | m | The mode to use when creating the app. This can be either "git" or +"tar". If "git" is specified, the template will be downloaded as a +tarball. Note that "git" clones over SSH, so you must have a valid +SSH key configured with GitHub, Bitbucket, or GitLab. | false | +| name | n | The name of the app. Defaults to the first argument current directory name. | false | +| clean | c | Clean the Paperspace cache. This negates other args/flags. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md new file mode 100644 index 0000000..80217e7 --- /dev/null +++ b/.assets/pspace/login.md @@ -0,0 +1,21 @@ +# pspace login + +Log in to the CLI using your Paperspace API key or by opening the web console. + +## Usage + +``` + login [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md new file mode 100644 index 0000000..35b5296 --- /dev/null +++ b/.assets/pspace/logout.md @@ -0,0 +1,22 @@ +# pspace logout + +Log out of the CLI for the current team, a specific team, or all teams. + +## Usage + +``` + logout [arguments...] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| all | a | Log out of all teams. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event.md b/.assets/pspace/machine-event.md new file mode 100644 index 0000000..732f134 --- /dev/null +++ b/.assets/pspace/machine-event.md @@ -0,0 +1,29 @@ +# pspace machine-event + +Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine-event [command] + machine-event [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/machine-event/get.md b/.assets/pspace/machine-event/get.md new file mode 100644 index 0000000..3452ed5 --- /dev/null +++ b/.assets/pspace/machine-event/get.md @@ -0,0 +1,22 @@ +# pspace machine-event get + +Get a machine event from a team. + +## Usage + +``` + machine-event get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event/help.md b/.assets/pspace/machine-event/help.md new file mode 100644 index 0000000..703391a --- /dev/null +++ b/.assets/pspace/machine-event/help.md @@ -0,0 +1,23 @@ +# pspace machine-event help + +Show help for a machine-event command + +## Usage + +``` + machine-event help [command] + machine-event help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md new file mode 100644 index 0000000..9bb10fd --- /dev/null +++ b/.assets/pspace/machine-event/help/commands.md @@ -0,0 +1,27 @@ +# pspace machine-event help commands + +List machine-event commands + +Example: +``` +$ machine-event help commands commands +``` + +## Usage + +``` + machine-event help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/machine-event/list.md b/.assets/pspace/machine-event/list.md new file mode 100644 index 0000000..a3d73ab --- /dev/null +++ b/.assets/pspace/machine-event/list.md @@ -0,0 +1,34 @@ +# pspace machine-event list + +List machine events in your team. + +Pick a subset of fields to display: +``` +pspace machine-event list -F name -F dtModified +``` + +## Usage + +``` + machine-event list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine.md b/.assets/pspace/machine.md new file mode 100644 index 0000000..be849f2 --- /dev/null +++ b/.assets/pspace/machine.md @@ -0,0 +1,33 @@ +# pspace machine + +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +## Usage + +``` + machine [command] + machine [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [restart](#restart) +- [start](#start) +- [stop](#stop) +- [update](#update) diff --git a/.assets/pspace/machine/create.md b/.assets/pspace/machine/create.md new file mode 100644 index 0000000..46568ad --- /dev/null +++ b/.assets/pspace/machine/create.md @@ -0,0 +1,43 @@ +# pspace machine create + +Create a machine. + +## Usage + +``` + machine create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to create | true | +| template-id | | The ID of the template to create the machine from | true | +| network-id | | The ID of the network to create the machine in | false | +| region | | The region to create the machine in | true | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| take-initial-snapshot | | Whether to take an initial snapshot. | false | +| restore-point-enabled | | Whether to use initial snapshot as a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| startup-script-id | | The startup script ID. | false | +| email-password | | Whether to email the password. | false | +| start-on-create | | Whether to start the machine on creation. | false | +| enable-nvlink | | Whether to enable NVLink. | false | +| accessor-ids | | The accessors of the machine. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/delete.md b/.assets/pspace/machine/delete.md new file mode 100644 index 0000000..81770c3 --- /dev/null +++ b/.assets/pspace/machine/delete.md @@ -0,0 +1,22 @@ +# pspace machine delete + +Delete a machine from a team. + +## Usage + +``` + machine delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/get.md b/.assets/pspace/machine/get.md new file mode 100644 index 0000000..8fb70f3 --- /dev/null +++ b/.assets/pspace/machine/get.md @@ -0,0 +1,22 @@ +# pspace machine get + +Get a machine from a team. + +## Usage + +``` + machine get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/help.md b/.assets/pspace/machine/help.md new file mode 100644 index 0000000..1b773fe --- /dev/null +++ b/.assets/pspace/machine/help.md @@ -0,0 +1,23 @@ +# pspace machine help + +Show help for a machine command + +## Usage + +``` + machine help [command] + machine help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md new file mode 100644 index 0000000..5d8375b --- /dev/null +++ b/.assets/pspace/machine/help/commands.md @@ -0,0 +1,27 @@ +# pspace machine help commands + +List machine commands + +Example: +``` +$ machine help commands commands +``` + +## Usage + +``` + machine help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/machine/list.md b/.assets/pspace/machine/list.md new file mode 100644 index 0000000..c5f942c --- /dev/null +++ b/.assets/pspace/machine/list.md @@ -0,0 +1,36 @@ +# pspace machine list + +List machines in your team. + +Pick a subset of fields to display: +``` +pspace machine list -F name -F dtModified +``` + +## Usage + +``` + machine list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| agent-type | a | Filter by agent type. | false | +| machine-type | m | Filter by machine type. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/restart.md b/.assets/pspace/machine/restart.md new file mode 100644 index 0000000..f0abfa5 --- /dev/null +++ b/.assets/pspace/machine/restart.md @@ -0,0 +1,22 @@ +# pspace machine restart + +Restart a machine from a team. + +## Usage + +``` + machine restart [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/start.md b/.assets/pspace/machine/start.md new file mode 100644 index 0000000..f9299be --- /dev/null +++ b/.assets/pspace/machine/start.md @@ -0,0 +1,22 @@ +# pspace machine start + +Start a machine from a team. + +## Usage + +``` + machine start [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/stop.md b/.assets/pspace/machine/stop.md new file mode 100644 index 0000000..bd02344 --- /dev/null +++ b/.assets/pspace/machine/stop.md @@ -0,0 +1,22 @@ +# pspace machine stop + +Stop a machine from a team. + +## Usage + +``` + machine stop [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/machine/update.md b/.assets/pspace/machine/update.md new file mode 100644 index 0000000..a5bf1bc --- /dev/null +++ b/.assets/pspace/machine/update.md @@ -0,0 +1,36 @@ +# pspace machine update + +Update a machine's settings. + +## Usage + +``` + machine update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the machine | true | +| machine-type | | The machine type to update to | true | +| network-id | | The ID of the network to create the machine in | false | +| disk-size | | The size of the machine's disk | true | +| public-ip-type | | The public IP type. | false | +| auto-snapshot-enabled | | Whether to enable auto snapshots. | false | +| auto-snapshot-frequency | | The auto snapshot frequency. | false | +| auto-snapshot-save-count | | The number of auto snapshots to save. | false | +| auto-shutdown-enabled | | Whether to enable auto shutdown. | false | +| auto-shutdown-timeout | | The auto shutdown timeout in hours. | false | +| auto-shutdown-force | | Whether to force shutdown the machine. | false | +| restore-point-enabled | | Whether to enable a restore point. | false | +| restore-point-frequency | | The restore point frequency. | false | +| restore-point-snapshot-id | | The ID of the snapshot to use as a restore point. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model.md b/.assets/pspace/model.md new file mode 100644 index 0000000..361cde1 --- /dev/null +++ b/.assets/pspace/model.md @@ -0,0 +1,29 @@ +# pspace model + +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +## Usage + +``` + model [command] + model [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/model/create.md b/.assets/pspace/model/create.md new file mode 100644 index 0000000..b7f06a4 --- /dev/null +++ b/.assets/pspace/model/create.md @@ -0,0 +1,28 @@ +# pspace model create + +Create a new model. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + model create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the model | false | +| description | d | The description of the model | false | +| is-public | | Whether the model is public | false | +| storage-provider-id | s | The ID of the storage provider to use for the model | false | +| project-id | p | The ID of the project to create the model in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/delete.md b/.assets/pspace/model/delete.md new file mode 100644 index 0000000..d18204b --- /dev/null +++ b/.assets/pspace/model/delete.md @@ -0,0 +1,22 @@ +# pspace model delete + +Delete a model from a team. + +## Usage + +``` + model delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/get.md b/.assets/pspace/model/get.md new file mode 100644 index 0000000..b467036 --- /dev/null +++ b/.assets/pspace/model/get.md @@ -0,0 +1,22 @@ +# pspace model get + +Get a model from a team. + +## Usage + +``` + model get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/model/help.md b/.assets/pspace/model/help.md new file mode 100644 index 0000000..9df28c6 --- /dev/null +++ b/.assets/pspace/model/help.md @@ -0,0 +1,23 @@ +# pspace model help + +Show help for a model command + +## Usage + +``` + model help [command] + model help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md new file mode 100644 index 0000000..be3d3c5 --- /dev/null +++ b/.assets/pspace/model/help/commands.md @@ -0,0 +1,27 @@ +# pspace model help commands + +List model commands + +Example: +``` +$ model help commands commands +``` + +## Usage + +``` + model help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/model/list.md b/.assets/pspace/model/list.md new file mode 100644 index 0000000..9202299 --- /dev/null +++ b/.assets/pspace/model/list.md @@ -0,0 +1,32 @@ +# pspace model list + +List models in your team. + +Pick a subset of fields to display: +``` +pspace model list -F name -F dtModified +``` + +## Usage + +``` + model list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/os-template.md b/.assets/pspace/os-template.md new file mode 100644 index 0000000..ffd377d --- /dev/null +++ b/.assets/pspace/os-template.md @@ -0,0 +1,27 @@ +# pspace os-template + +List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +## Usage + +``` + os-template [command] + os-template [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/os-template/help.md b/.assets/pspace/os-template/help.md new file mode 100644 index 0000000..c04c5ea --- /dev/null +++ b/.assets/pspace/os-template/help.md @@ -0,0 +1,23 @@ +# pspace os-template help + +Show help for a os-template command + +## Usage + +``` + os-template help [command] + os-template help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md new file mode 100644 index 0000000..2667495 --- /dev/null +++ b/.assets/pspace/os-template/help/commands.md @@ -0,0 +1,27 @@ +# pspace os-template help commands + +List os-template commands + +Example: +``` +$ os-template help commands commands +``` + +## Usage + +``` + os-template help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/os-template/list.md b/.assets/pspace/os-template/list.md new file mode 100644 index 0000000..8228eb9 --- /dev/null +++ b/.assets/pspace/os-template/list.md @@ -0,0 +1,33 @@ +# pspace os-template list + +List OS templates. + +Pick a subset of fields to display: +``` +pspace os-template list -F name +``` + +## Usage + +``` + os-template list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network.md b/.assets/pspace/private-network.md new file mode 100644 index 0000000..34e5a57 --- /dev/null +++ b/.assets/pspace/private-network.md @@ -0,0 +1,31 @@ +# pspace private-network + +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. + +## Usage + +``` + private-network [command] + private-network [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/private-network/create.md b/.assets/pspace/private-network/create.md new file mode 100644 index 0000000..988f218 --- /dev/null +++ b/.assets/pspace/private-network/create.md @@ -0,0 +1,24 @@ +# pspace private-network create + +Create a private network. + +## Usage + +``` + private-network create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the private network | true | +| region | | The region to create the private network in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/delete.md b/.assets/pspace/private-network/delete.md new file mode 100644 index 0000000..4cbe68f --- /dev/null +++ b/.assets/pspace/private-network/delete.md @@ -0,0 +1,22 @@ +# pspace private-network delete + +Delete a private network from a team. + +## Usage + +``` + private-network delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/get.md b/.assets/pspace/private-network/get.md new file mode 100644 index 0000000..4207a19 --- /dev/null +++ b/.assets/pspace/private-network/get.md @@ -0,0 +1,22 @@ +# pspace private-network get + +Get a private network from a team. + +## Usage + +``` + private-network get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/help.md b/.assets/pspace/private-network/help.md new file mode 100644 index 0000000..35a0a7f --- /dev/null +++ b/.assets/pspace/private-network/help.md @@ -0,0 +1,23 @@ +# pspace private-network help + +Show help for a private-network command + +## Usage + +``` + private-network help [command] + private-network help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md new file mode 100644 index 0000000..1f003c5 --- /dev/null +++ b/.assets/pspace/private-network/help/commands.md @@ -0,0 +1,27 @@ +# pspace private-network help commands + +List private-network commands + +Example: +``` +$ private-network help commands commands +``` + +## Usage + +``` + private-network help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/private-network/list.md b/.assets/pspace/private-network/list.md new file mode 100644 index 0000000..928d6eb --- /dev/null +++ b/.assets/pspace/private-network/list.md @@ -0,0 +1,34 @@ +# pspace private-network list + +List private networks in your team. + +Pick a subset of fields to display: +``` +pspace private-network list -F name -F dtModified +``` + +## Usage + +``` + private-network list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project.md b/.assets/pspace/project.md new file mode 100644 index 0000000..313e241 --- /dev/null +++ b/.assets/pspace/project.md @@ -0,0 +1,29 @@ +# pspace project + +Manage your Paperspace projects. + +## Usage + +``` + project [command] + project [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [link](#link) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/project/create.md b/.assets/pspace/project/create.md new file mode 100644 index 0000000..10e69f3 --- /dev/null +++ b/.assets/pspace/project/create.md @@ -0,0 +1,23 @@ +# pspace project create + +Create a new project. This command will prompt you for a name if you don't +provide one. + +## Usage + +``` + project create [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/delete.md b/.assets/pspace/project/delete.md new file mode 100644 index 0000000..ba58c68 --- /dev/null +++ b/.assets/pspace/project/delete.md @@ -0,0 +1,23 @@ +# pspace project delete + +Delete a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/get.md b/.assets/pspace/project/get.md new file mode 100644 index 0000000..e70d249 --- /dev/null +++ b/.assets/pspace/project/get.md @@ -0,0 +1,23 @@ +# pspace project get + +Get a project by its ID. If you don't provide an ID, this command will +prompt you for one based on the projects you have access to. + +## Usage + +``` + project get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/help.md b/.assets/pspace/project/help.md new file mode 100644 index 0000000..a485416 --- /dev/null +++ b/.assets/pspace/project/help.md @@ -0,0 +1,23 @@ +# pspace project help + +Show help for a project command + +## Usage + +``` + project help [command] + project help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md new file mode 100644 index 0000000..7ed866b --- /dev/null +++ b/.assets/pspace/project/help/commands.md @@ -0,0 +1,27 @@ +# pspace project help commands + +List project commands + +Example: +``` +$ project help commands commands +``` + +## Usage + +``` + project help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/project/link.md b/.assets/pspace/project/link.md new file mode 100644 index 0000000..a200990 --- /dev/null +++ b/.assets/pspace/project/link.md @@ -0,0 +1,39 @@ +# pspace project link + +This will link a remote project to a local directory. Commands that +depend on a project ID will use the project ID of the linked project +when communicating with the Paperspace API. + +Link a project to the current directory. +``` +$ pspace link +``` + +Link a project to a different directory. +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. +``` +$ pspace link pzwf2g05ubegj +``` + +## Usage + +``` + project link [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| cwd | | The directory to link the project to. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/list.md b/.assets/pspace/project/list.md new file mode 100644 index 0000000..823bc80 --- /dev/null +++ b/.assets/pspace/project/list.md @@ -0,0 +1,32 @@ +# pspace project list + +List projects in your team. + +Pick a subset of fields to display: +``` +pspace project list -F id -F name -F dtCreated +``` + +## Usage + +``` + project list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/project/update.md b/.assets/pspace/project/update.md new file mode 100644 index 0000000..9ad171e --- /dev/null +++ b/.assets/pspace/project/update.md @@ -0,0 +1,28 @@ +# pspace project update + +Update an existing project. + +Example: +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +## Usage + +``` + pspace project update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| name | | The new name for the project. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip.md b/.assets/pspace/public-ip.md new file mode 100644 index 0000000..9722726 --- /dev/null +++ b/.assets/pspace/public-ip.md @@ -0,0 +1,29 @@ +# pspace public-ip + +Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +## Usage + +``` + public-ip [command] + public-ip [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [claim](#claim) +- [help](#help) +- [list](#list) +- [release](#release) diff --git a/.assets/pspace/public-ip/assign.md b/.assets/pspace/public-ip/assign.md new file mode 100644 index 0000000..0febe9e --- /dev/null +++ b/.assets/pspace/public-ip/assign.md @@ -0,0 +1,23 @@ +# pspace public-ip assign + +Assign a public IP to a machine. + +## Usage + +``` + public-ip assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine to assign the public IP to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/claim.md b/.assets/pspace/public-ip/claim.md new file mode 100644 index 0000000..0676833 --- /dev/null +++ b/.assets/pspace/public-ip/claim.md @@ -0,0 +1,23 @@ +# pspace public-ip claim + +Claim a public IP for a team. + +## Usage + +``` + public-ip claim [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| region | r | The region to claim the public IP in | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/help.md b/.assets/pspace/public-ip/help.md new file mode 100644 index 0000000..6131c35 --- /dev/null +++ b/.assets/pspace/public-ip/help.md @@ -0,0 +1,23 @@ +# pspace public-ip help + +Show help for a public-ip command + +## Usage + +``` + public-ip help [command] + public-ip help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md new file mode 100644 index 0000000..62c03d5 --- /dev/null +++ b/.assets/pspace/public-ip/help/commands.md @@ -0,0 +1,27 @@ +# pspace public-ip help commands + +List public-ip commands + +Example: +``` +$ public-ip help commands commands +``` + +## Usage + +``` + public-ip help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/list.md b/.assets/pspace/public-ip/list.md new file mode 100644 index 0000000..63bd002 --- /dev/null +++ b/.assets/pspace/public-ip/list.md @@ -0,0 +1,33 @@ +# pspace public-ip list + +List public IPs in your team or project. + +Pick a subset of fields to display: +``` +pspace public-ip list -F name -F dtModified +``` + +## Usage + +``` + public-ip list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/public-ip/release.md b/.assets/pspace/public-ip/release.md new file mode 100644 index 0000000..d936e8e --- /dev/null +++ b/.assets/pspace/public-ip/release.md @@ -0,0 +1,22 @@ +# pspace public-ip release + +Release a public IP from a team. This will unassign it from its assigned machine, if any. + +## Usage + +``` + public-ip release [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret.md b/.assets/pspace/secret.md new file mode 100644 index 0000000..773bd76 --- /dev/null +++ b/.assets/pspace/secret.md @@ -0,0 +1,38 @@ +# pspace secret + +Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +## Usage + +``` + secret [command] + secret [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/secret/create.md b/.assets/pspace/secret/create.md new file mode 100644 index 0000000..18e9535 --- /dev/null +++ b/.assets/pspace/secret/create.md @@ -0,0 +1,29 @@ +# pspace secret create + +Create a secret in a project or team. + +## Usage + +``` + secret create [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/delete.md b/.assets/pspace/secret/delete.md new file mode 100644 index 0000000..077f756 --- /dev/null +++ b/.assets/pspace/secret/delete.md @@ -0,0 +1,29 @@ +# pspace secret delete + +Delete a secret from a project or team. + +## Usage + +``` + secret delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/get.md b/.assets/pspace/secret/get.md new file mode 100644 index 0000000..45dc488 --- /dev/null +++ b/.assets/pspace/secret/get.md @@ -0,0 +1,30 @@ +# pspace secret get + +Get a secret from a project or team. + +## Usage + +``` + secret get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/help.md b/.assets/pspace/secret/help.md new file mode 100644 index 0000000..a74ebeb --- /dev/null +++ b/.assets/pspace/secret/help.md @@ -0,0 +1,23 @@ +# pspace secret help + +Show help for a secret command + +## Usage + +``` + secret help [command] + secret help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md new file mode 100644 index 0000000..3f2baf6 --- /dev/null +++ b/.assets/pspace/secret/help/commands.md @@ -0,0 +1,27 @@ +# pspace secret help commands + +List secret commands + +Example: +``` +$ secret help commands commands +``` + +## Usage + +``` + secret help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/secret/list.md b/.assets/pspace/secret/list.md new file mode 100644 index 0000000..4208446 --- /dev/null +++ b/.assets/pspace/secret/list.md @@ -0,0 +1,40 @@ +# pspace secret list + +List secrets in your team or project. + +Pick a subset of fields to display: +``` +pspace secret list -F name -F dtModified +``` + +## Usage + +``` + secret list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/secret/update.md b/.assets/pspace/secret/update.md new file mode 100644 index 0000000..790e50d --- /dev/null +++ b/.assets/pspace/secret/update.md @@ -0,0 +1,29 @@ +# pspace secret update + +Update a secret in a project or team. + +## Usage + +``` + secret update [arguments] [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| project-id | p | The ID of the project the secret is in. If not specified, the +secret will be created in the project linked to your current working +directory. If you are not in a project directory, you will be prompted +to select a project. | false | +| global | g | Manage a secret that is available to the entire team you are +currently logged into. By default, secrets are only available to +a project. | false | +| cwd | | The directory to create the secret in | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive.md b/.assets/pspace/shared-drive.md new file mode 100644 index 0000000..7849088 --- /dev/null +++ b/.assets/pspace/shared-drive.md @@ -0,0 +1,31 @@ +# pspace shared-drive + +Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +## Usage + +``` + shared-drive [command] + shared-drive [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) diff --git a/.assets/pspace/shared-drive/create.md b/.assets/pspace/shared-drive/create.md new file mode 100644 index 0000000..34dfd0c --- /dev/null +++ b/.assets/pspace/shared-drive/create.md @@ -0,0 +1,26 @@ +# pspace shared-drive create + +Create a shared drive. + +## Usage + +``` + shared-drive create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the shared drive | true | +| network-id | | The ID of the network to create the shared drive in | true | +| region | | The region to create the shared drive in | true | +| size | | The size of the shared drive | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/delete.md b/.assets/pspace/shared-drive/delete.md new file mode 100644 index 0000000..e18f39b --- /dev/null +++ b/.assets/pspace/shared-drive/delete.md @@ -0,0 +1,22 @@ +# pspace shared-drive delete + +Delete a shared drive from a team. + +## Usage + +``` + shared-drive delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/get.md b/.assets/pspace/shared-drive/get.md new file mode 100644 index 0000000..d446156 --- /dev/null +++ b/.assets/pspace/shared-drive/get.md @@ -0,0 +1,22 @@ +# pspace shared-drive get + +Get a shared drive from a team. + +## Usage + +``` + shared-drive get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/help.md b/.assets/pspace/shared-drive/help.md new file mode 100644 index 0000000..4e1f0f4 --- /dev/null +++ b/.assets/pspace/shared-drive/help.md @@ -0,0 +1,23 @@ +# pspace shared-drive help + +Show help for a shared-drive command + +## Usage + +``` + shared-drive help [command] + shared-drive help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md new file mode 100644 index 0000000..ec6ec3e --- /dev/null +++ b/.assets/pspace/shared-drive/help/commands.md @@ -0,0 +1,27 @@ +# pspace shared-drive help commands + +List shared-drive commands + +Example: +``` +$ shared-drive help commands commands +``` + +## Usage + +``` + shared-drive help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/shared-drive/list.md b/.assets/pspace/shared-drive/list.md new file mode 100644 index 0000000..7359bfb --- /dev/null +++ b/.assets/pspace/shared-drive/list.md @@ -0,0 +1,34 @@ +# pspace shared-drive list + +List shared drives in your team or project. + +Pick a subset of fields to display: +``` +pspace shared-drive list -F name -F dtModified +``` + +## Usage + +``` + shared-drive list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| region | r | Filter by region. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md new file mode 100644 index 0000000..e664380 --- /dev/null +++ b/.assets/pspace/signup.md @@ -0,0 +1,21 @@ +# pspace signup + +This command opens the Paperspace signup page in your browser. + +## Usage + +``` + signup [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot.md b/.assets/pspace/snapshot.md new file mode 100644 index 0000000..3fe37e6 --- /dev/null +++ b/.assets/pspace/snapshot.md @@ -0,0 +1,31 @@ +# pspace snapshot + +Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +## Usage + +``` + snapshot [command] + snapshot [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [help](#help) +- [list](#list) +- [restore](#restore) diff --git a/.assets/pspace/snapshot/create.md b/.assets/pspace/snapshot/create.md new file mode 100644 index 0000000..fd1a91d --- /dev/null +++ b/.assets/pspace/snapshot/create.md @@ -0,0 +1,24 @@ +# pspace snapshot create + +Create a snapshot from a machine. + +## Usage + +``` + snapshot create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the snapshot | true | +| machine-id | m | The ID of the machine to create a snapshot from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/delete.md b/.assets/pspace/snapshot/delete.md new file mode 100644 index 0000000..93663ed --- /dev/null +++ b/.assets/pspace/snapshot/delete.md @@ -0,0 +1,22 @@ +# pspace snapshot delete + +Delete a snapshot from a team. + +## Usage + +``` + snapshot delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/help.md b/.assets/pspace/snapshot/help.md new file mode 100644 index 0000000..1e48224 --- /dev/null +++ b/.assets/pspace/snapshot/help.md @@ -0,0 +1,23 @@ +# pspace snapshot help + +Show help for a snapshot command + +## Usage + +``` + snapshot help [command] + snapshot help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md new file mode 100644 index 0000000..7c5f454 --- /dev/null +++ b/.assets/pspace/snapshot/help/commands.md @@ -0,0 +1,27 @@ +# pspace snapshot help commands + +List snapshot commands + +Example: +``` +$ snapshot help commands commands +``` + +## Usage + +``` + snapshot help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/list.md b/.assets/pspace/snapshot/list.md new file mode 100644 index 0000000..59678f2 --- /dev/null +++ b/.assets/pspace/snapshot/list.md @@ -0,0 +1,34 @@ +# pspace snapshot list + +List snapshots in your team. + +Pick a subset of fields to display: +``` +pspace snapshot list -F name -F dtModified +``` + +## Usage + +``` + snapshot list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| machine-id | m | The ID of the machine the event is for. If not specified, all events +will be returned. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/snapshot/restore.md b/.assets/pspace/snapshot/restore.md new file mode 100644 index 0000000..0cc1b84 --- /dev/null +++ b/.assets/pspace/snapshot/restore.md @@ -0,0 +1,23 @@ +# pspace snapshot restore + +Restore a machine to a snapshot. + +## Usage + +``` + snapshot restore [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| create-snapshot | | Create an additional snapshot before restore | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script.md b/.assets/pspace/startup-script.md new file mode 100644 index 0000000..e2c9337 --- /dev/null +++ b/.assets/pspace/startup-script.md @@ -0,0 +1,31 @@ +# pspace startup-script + +Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. + +## Usage + +``` + startup-script [command] + startup-script [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [assign](#assign) +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [unassign](#unassign) +- [update](#update) diff --git a/.assets/pspace/startup-script/assign.md b/.assets/pspace/startup-script/assign.md new file mode 100644 index 0000000..f913d40 --- /dev/null +++ b/.assets/pspace/startup-script/assign.md @@ -0,0 +1,23 @@ +# pspace startup-script assign + +Assign a startup script to a machine. + +## Usage + +``` + startup-script assign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to assign the startup script to | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/create.md b/.assets/pspace/startup-script/create.md new file mode 100644 index 0000000..688450b --- /dev/null +++ b/.assets/pspace/startup-script/create.md @@ -0,0 +1,25 @@ +# pspace startup-script create + +Create a startup script. + +## Usage + +``` + startup-script create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | true | +| script | | The script to run | true | +| run-once | | Whether to run once or on every boot | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/delete.md b/.assets/pspace/startup-script/delete.md new file mode 100644 index 0000000..236d9f4 --- /dev/null +++ b/.assets/pspace/startup-script/delete.md @@ -0,0 +1,22 @@ +# pspace startup-script delete + +Delete a startup script from a team. + +## Usage + +``` + startup-script delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/get.md b/.assets/pspace/startup-script/get.md new file mode 100644 index 0000000..b3e49a2 --- /dev/null +++ b/.assets/pspace/startup-script/get.md @@ -0,0 +1,22 @@ +# pspace startup-script get + +Get a startup script from a team. + +## Usage + +``` + startup-script get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/help.md b/.assets/pspace/startup-script/help.md new file mode 100644 index 0000000..4e4c0b8 --- /dev/null +++ b/.assets/pspace/startup-script/help.md @@ -0,0 +1,23 @@ +# pspace startup-script help + +Show help for a startup-script command + +## Usage + +``` + startup-script help [command] + startup-script help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md new file mode 100644 index 0000000..84d6b42 --- /dev/null +++ b/.assets/pspace/startup-script/help/commands.md @@ -0,0 +1,27 @@ +# pspace startup-script help commands + +List startup-script commands + +Example: +``` +$ startup-script help commands commands +``` + +## Usage + +``` + startup-script help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/list.md b/.assets/pspace/startup-script/list.md new file mode 100644 index 0000000..cd887ae --- /dev/null +++ b/.assets/pspace/startup-script/list.md @@ -0,0 +1,33 @@ +# pspace startup-script list + +List startup scripts in your team. + +Pick a subset of fields to display: +``` +pspace startup-script list -F name -F dtCreated +``` + +## Usage + +``` + startup-script list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| name | n | Filter by name. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/unassign.md b/.assets/pspace/startup-script/unassign.md new file mode 100644 index 0000000..dfc3c28 --- /dev/null +++ b/.assets/pspace/startup-script/unassign.md @@ -0,0 +1,23 @@ +# pspace startup-script unassign + +Unassign a startup script from a machine. + +## Usage + +``` + startup-script unassign [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| machine-id | | The ID of the machine to unassign the startup script from | true | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/startup-script/update.md b/.assets/pspace/startup-script/update.md new file mode 100644 index 0000000..e90c9b7 --- /dev/null +++ b/.assets/pspace/startup-script/update.md @@ -0,0 +1,26 @@ +# pspace startup-script update + +Update a startup script. + +## Usage + +``` + startup-script update [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the startup script | false | +| script | | The script to run | false | +| run-once | | Whether to run once or on every boot | false | +| enabled | | Whether the startup script is enabled or not | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider.md b/.assets/pspace/storage-provider.md new file mode 100644 index 0000000..cd1d679 --- /dev/null +++ b/.assets/pspace/storage-provider.md @@ -0,0 +1,30 @@ +# pspace storage-provider + +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +## Usage + +``` + storage-provider [command] + storage-provider [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [create](#create) +- [delete](#delete) +- [get](#get) +- [help](#help) +- [list](#list) +- [update](#update) diff --git a/.assets/pspace/storage-provider/create.md b/.assets/pspace/storage-provider/create.md new file mode 100644 index 0000000..3ff4704 --- /dev/null +++ b/.assets/pspace/storage-provider/create.md @@ -0,0 +1,24 @@ +# pspace storage-provider create + +Create a storage provider. + +## Usage + +``` + storage-provider create [command] + storage-provider create [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) diff --git a/.assets/pspace/storage-provider/create/help.md b/.assets/pspace/storage-provider/create/help.md new file mode 100644 index 0000000..8dbdea0 --- /dev/null +++ b/.assets/pspace/storage-provider/create/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider create help + +Show help for a create command + +## Usage + +``` + storage-provider create help [command] + storage-provider create help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md new file mode 100644 index 0000000..33d6790 --- /dev/null +++ b/.assets/pspace/storage-provider/create/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider create help commands + +List create commands + +Example: +``` +$ storage-provider create help commands commands +``` + +## Usage + +``` + storage-provider create help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/create/s3.md b/.assets/pspace/storage-provider/create/s3.md new file mode 100644 index 0000000..a15d5dc --- /dev/null +++ b/.assets/pspace/storage-provider/create/s3.md @@ -0,0 +1,31 @@ +# pspace storage-provider create s3 + +Create an S3 storage provider. + +## Usage + +``` + storage-provider create s3 [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | false | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/delete.md b/.assets/pspace/storage-provider/delete.md new file mode 100644 index 0000000..66dd46a --- /dev/null +++ b/.assets/pspace/storage-provider/delete.md @@ -0,0 +1,22 @@ +# pspace storage-provider delete + +Delete a storage provider from a team. + +## Usage + +``` + storage-provider delete [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/get.md b/.assets/pspace/storage-provider/get.md new file mode 100644 index 0000000..3b0df82 --- /dev/null +++ b/.assets/pspace/storage-provider/get.md @@ -0,0 +1,22 @@ +# pspace storage-provider get + +Get a storage provider from a team. + +## Usage + +``` + storage-provider get [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/help.md b/.assets/pspace/storage-provider/help.md new file mode 100644 index 0000000..09574c1 --- /dev/null +++ b/.assets/pspace/storage-provider/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider help + +Show help for a storage-provider command + +## Usage + +``` + storage-provider help [command] + storage-provider help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md new file mode 100644 index 0000000..f53a9ef --- /dev/null +++ b/.assets/pspace/storage-provider/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider help commands + +List storage-provider commands + +Example: +``` +$ storage-provider help commands commands +``` + +## Usage + +``` + storage-provider help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/list.md b/.assets/pspace/storage-provider/list.md new file mode 100644 index 0000000..24e571b --- /dev/null +++ b/.assets/pspace/storage-provider/list.md @@ -0,0 +1,32 @@ +# pspace storage-provider list + +List storage providers in your team or project. + +Pick a subset of fields to display: +``` +pspace storage provider list -F name -F dtModified +``` + +## Usage + +``` + storage-provider list [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| limit | | The number of items to return in the next page. | false | +| after | | The cursor to fetch the next results from. | false | +| orderBy | | The field to order items by. | false | +| asc | | Whether to order items ascending. | false | +| desc | | Whether to order items descending. | false | +| fields | F | The fields to include in the response. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/update.md b/.assets/pspace/storage-provider/update.md new file mode 100644 index 0000000..020100d --- /dev/null +++ b/.assets/pspace/storage-provider/update.md @@ -0,0 +1,24 @@ +# pspace storage-provider update + +Update a storage provider. + +## Usage + +``` + storage-provider update [command] + storage-provider update [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [help](#help) +- [s3](#s3) diff --git a/.assets/pspace/storage-provider/update/help.md b/.assets/pspace/storage-provider/update/help.md new file mode 100644 index 0000000..11b6715 --- /dev/null +++ b/.assets/pspace/storage-provider/update/help.md @@ -0,0 +1,23 @@ +# pspace storage-provider update help + +Show help for a update command + +## Usage + +``` + storage-provider update help [command] + storage-provider update help [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + +- [commands](#commands) diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md new file mode 100644 index 0000000..e5d1c4c --- /dev/null +++ b/.assets/pspace/storage-provider/update/help/commands.md @@ -0,0 +1,27 @@ +# pspace storage-provider update help commands + +List update commands + +Example: +``` +$ storage-provider update help commands commands +``` + +## Usage + +``` + storage-provider update help commands [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | +| all | a | Show all commands, including hidden ones | false | + +### Subcommands + diff --git a/.assets/pspace/storage-provider/update/s3.md b/.assets/pspace/storage-provider/update/s3.md new file mode 100644 index 0000000..6b3c9ca --- /dev/null +++ b/.assets/pspace/storage-provider/update/s3.md @@ -0,0 +1,31 @@ +# pspace storage-provider update s3 + +Update an S3 storage provider in a project or team. + +## Usage + +``` + storage-provider update s3 [arguments] [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| fields | F | The fields to include in the response. | false | +| name | n | The name of the storage provider | true | +| is-team-default | | Whether the storage provider is the team's default provider | true | +| endpoint | | The endpoint of the storage provider | false | +| bucket | | The bucket of the storage provider | true | +| region | | The region of the storage provider | false | +| access-key | | The access key of the storage provider | true | +| secret-access-key | | The secret access key of the storage provider | true | +| signature-version | | The signature version of the storage provider | false | +| retain-data | | Whether to retain data in the storage provider | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md new file mode 100644 index 0000000..1316caa --- /dev/null +++ b/.assets/pspace/up.md @@ -0,0 +1,54 @@ +# pspace up + +This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` +$ pspace up +``` + +Deploy the app using a config file. +``` +$ pspace up -c paperspace.json +``` + +Deploy an app in a different directory. +``` +$ pspace up --cwd ../my-app +``` + +## Usage + +``` + up [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| config | c | The path to the config file. Defaults to our default config file paths. + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | +| project-id | p | The ID of the project to deploy to. | false | +| cwd | | The directory to deploy the app from. Defaults to the current directory. | false | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md new file mode 100644 index 0000000..96d9f8f --- /dev/null +++ b/.assets/pspace/upgrade.md @@ -0,0 +1,34 @@ +# pspace upgrade + +This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` +brew upgrade pspace +``` + +If you installed `pspace` using the install script, you can upgrade by +running: +``` +pspace upgrade +``` + +## Usage + +``` + upgrade [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md new file mode 100644 index 0000000..5a49e4c --- /dev/null +++ b/.assets/pspace/version.md @@ -0,0 +1,21 @@ +# pspace version + +Shows version information command, including version number and build date. + +## Usage + +``` + version [flags] +``` + +## Flags + +| Name | Aliases | Description | Required | +| --- | --- | --- | --- | +| log-level | l | Enable debug logging. | false | +| json | j | Output JSON | false | +| api-key | | A Paperspace public API Key used for authenticating requests | false | +| help | h | Show help for a command | false | + +### Subcommands + diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index c2c5f0b..f26c833 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -1,9 +1,6 @@ import { app } from "../zcli.ts"; import { root } from "../commands/mod.ts"; -import { - zcliJson, - ZcliJsonCommand, -} from "https://deno.land/x/zcli@1.3.3/zcli-json.ts"; +import { zcliJson, ZcliJsonCommand } from "./zcli-json.ts"; // Read the markdown file adjacent to this script const json = await zcliJson(app, root); @@ -15,18 +12,15 @@ await Deno.writeTextFile( ); // Also generate markdown for the CLI -let markdown = ""; -markdown += "# Paperspace CLI\n\n"; -markdown += json.info.description + "\n\n"; - -function renderCommand(path: string[], command: ZcliJsonCommand) { - markdown += `## ${path.join(" ")}\n\n`; +async function renderCommand(path: string[], command: ZcliJsonCommand) { + let markdown = ""; + markdown += `# ${path.join(" ")}\n\n`; markdown += command.description + "\n\n"; - markdown += "### Usage\n\n"; + markdown += "## Usage\n\n"; markdown += `\`\`\`\n`; markdown += `${command.usage}\n`; markdown += "\`\`\`\n\n"; - markdown += "### Flags\n\n"; + markdown += "## Flags\n\n"; markdown += "| Name | Aliases | Description | Required |\n"; markdown += "| --- | --- | --- | --- |\n"; for (const flag of command.flags) { @@ -40,13 +34,20 @@ function renderCommand(path: string[], command: ZcliJsonCommand) { for (const subcommand of command.commands) { markdown += `- [${subcommand.name}](#${subcommand.name})\n`; } + + if (path.length >= 2) { + await Deno.mkdir(`.assets/${path.slice(0, -1).join("/")}`, { + recursive: true, + }); + } + await Deno.writeTextFile(`.assets/${path.join("/")}.md`, markdown, { + create: true, + }); for (const subcommand of command.commands) { - renderCommand([...path, subcommand.name], subcommand); + await renderCommand([...path, subcommand.name], subcommand); } } for (const command of json.commands) { - renderCommand([command.name], command); + await renderCommand([command.name], command); } - -await Deno.writeTextFile(".assets/pspace.md", markdown); diff --git a/.scripts/zcli-json.ts b/.scripts/zcli-json.ts new file mode 100644 index 0000000..6ed3695 --- /dev/null +++ b/.scripts/zcli-json.ts @@ -0,0 +1,228 @@ +// deno-lint-ignore-file no-explicit-any +import { CommandFactory } from "https://deno.land/x/zcli@1.3.3/init.ts"; +import { + flag, + flags, + getDefault, + innerType, + walkFlags, +} from "https://deno.land/x/zcli@1.3.3/flags.ts"; +import { Command } from "https://deno.land/x/zcli@1.3.3/command.ts"; +import * as intl from "https://deno.land/x/zcli@1.3.3/intl.ts"; +import { z } from "https://deno.land/x/zcli@1.3.3/z.ts"; +import zodToJsonSchema from "https://esm.sh/zod-to-json-schema@3.20.4"; +import { walkArgs } from "https://deno.land/x/zcli@1.3.3/args.ts"; + +export async function zcliJson< + Context extends { + meta: { version: string; date?: string; commit?: string }; + }, +>( + commandFactory: CommandFactory, + root: Command, +): Promise { + let json: ZcliJson; + + function zcliJsonCommand< + Context extends { + meta: { version: string; date?: string; commit?: string }; + }, + >(commandFactory: CommandFactory, options: { + /** + * Change the name of the command + * @default "zcli.json" + */ + name?: string; + /** + * Add aliases for the command + */ + aliases?: string[]; + /** + * Whether the command should be hidden from users + * @default true + */ + hidden?: boolean; + } = {}) { + const { name = "zcli.json", hidden = true, aliases } = options; + + return commandFactory.command(name, { + short: + "Prints the CLI command structure to a specification with JSONSchemas.", + long: ` + Prints the CLI command structure to a specification with JSONSchemas. This is + useful for the purposes of outputting your command structure in a documentable + format. + `, + hidden, + aliases, + flags: flags({ + all: flag( + { + aliases: ["a"], + short: "Show all commands and flags, including hidden ones.", + long: + `Show all commands and flags in the output, including hidden ones.`, + }, + ).boolean().default(false), + }), + }) + .run(function ({ args, flags, ctx }) { + ctx = { ...ctx }; + // @ts-expect-error: it's fine + ctx.root = root; + + function generateCommand( + command: Command, + path: string[], + ): ZcliJsonCommand { + const commands: ZcliJsonCommand[] = []; + + for ( + const cmd of intl.collate(command.commands, { + get(cmd) { + return cmd.name; + }, + }) + ) { + if (flags.all || !cmd.hidden) { + commands.push(generateCommand(cmd, [...path, cmd.name])); + } + } + + const context = { ...ctx, path }; + + const a: any[] = []; + const hasOptionalArgs = args instanceof z.ZodOptional || + args instanceof z.ZodDefault; + + walkArgs(command.args, (arg, { position, variadic }) => { + a.push({ + position, + summary: (arg.description ?? "").trim(), + required: !hasOptionalArgs, + variadic, + schema: zodToJsonSchema(arg as any, { strictUnions: true }), + }); + }); + + const commandFlags: any[] = []; + + walkFlags(command.flags, (flag, name) => { + if ((flag.hidden && !flags.all)) return; + const collects = flag instanceof z.ZodArray || + flag._def.innerType instanceof z.ZodArray; + const itemType = collects + ? flag instanceof z.ZodArray + ? flag._def.type + : flag._def.innerType._def.type + : flag; + const defaultValue = getDefault(flag); + + commandFlags.push({ + name, + aliases: flag.aliases, + description: flag.long(context) || flag.short(context) || "", + summary: flag.short(context) || "", + required: !(flag instanceof z.ZodOptional) && + !(flag instanceof z.ZodDefault) && name !== "help", + collects, + negatable: flag.negatable, + default: defaultValue, + global: flag.__global, + schema: zodToJsonSchema( + name === "help" + ? z.boolean().default(false) + : collects + ? itemType + : innerType(flag), + { strictUnions: true }, + ), + }); + }); + + return { + name: command.name, + description: command.long(context) || command.short(context) || "", + summary: command.short(context) ?? "", + usage: command.usage(context), + deprecated: command.deprecated, + arguments: command.args + ? { + description: command.args.long(context) ?? "", + summary: command.args.short(context) ?? "", + items: a, + } + : undefined, + flags: commandFlags, + commands: commands, + }; + } + + json = { + "zcli": "1.0.0", + info: { + name: root.name, + version: ctx?.meta.version, + commit: ctx?.meta.commit, + buildDate: ctx?.meta.date, + description: root.long(ctx) || root.short(ctx) || "", + summary: root.short(ctx) || "", + }, + commands: [generateCommand(root, [])], + }; + }); + } + + const command = zcliJsonCommand(commandFactory); + await command.execute([]); + return json!; +} + +export type ZcliJson = { + zcli: "1.0.0"; + info: { + name: string; + version: string; + commit?: string; + buildDate?: string; + description: string; + summary: string; + }; + commands: ZcliJsonCommand[]; +}; + +export type ZcliJsonCommand = { + name: string; + summary: string; + description: string; + usage: string; + deprecated?: string; + arguments: undefined | { + description: string; + summary: string; + items: ZcliJsonArgument[]; + }; + flags: ZcliJsonFlag[]; + commands: ZcliJsonCommand[]; +}; + +export type ZcliJsonArgument = { + position: number; + summary: string; + required: boolean; + variadic: boolean; + schema: any; +}; + +export type ZcliJsonFlag = { + name: string; + aliases: string[]; + description?: string; + summary?: string; + required: boolean; + collects: boolean; + negatable: boolean; + global: boolean; + default?: any; + schema: any; +}; diff --git a/deno.lock b/deno.lock index bf1f1bd..21d2682 100644 --- a/deno.lock +++ b/deno.lock @@ -1,5 +1,5 @@ { - "version": "2", + "version": "3", "remote": { "https://deno.land/std@0.179.0/_util/asserts.ts": "178dfc49a464aee693a7e285567b3d0b555dc805ff490505a8aae34f9cfb1462", "https://deno.land/std@0.179.0/_util/os.ts": "d932f56d41e4f6a6093d56044e29ce637f8dcc43c5a90af43504a889cf1775e3", @@ -60,7 +60,6 @@ "https://deno.land/std@0.179.0/encoding/jsonc.ts": "02b86115d2b812f26789481ebcf4748171e8ece6514b60243b3733e2c200876a", "https://deno.land/std@0.179.0/encoding/toml.ts": "d11fc659365218035ec1d92c1dfa206718838954a6de7cfc62d0a07ffb19f582", "https://deno.land/std@0.179.0/encoding/yaml.ts": "02571d1bbbcfd7c5647789cee872ecf9c1c470e1b1a40948ed219fb661e19d87", - "https://deno.land/std@0.179.0/flags/mod.ts": "d1cdefa18472ef69858a17df5cf7c98445ed27ac10e1460183081303b0ebc270", "https://deno.land/std@0.179.0/fmt/bytes.ts": "f3cdd34c7a5063c296e198cf9b7000774033283d469716e6b7741f4167bdaf46", "https://deno.land/std@0.179.0/fmt/colors.ts": "938c5d44d889fb82eff6c358bea8baa7e85950a16c9f6dae3ec3a7a729164471", "https://deno.land/std@0.179.0/fmt/printf.ts": "e5b426cd6ad13df5d408e9c375c025d59de30e380c5534715bd892df874ab057", @@ -106,13 +105,6 @@ "https://deno.land/std@0.179.0/streams/write_all.ts": "3b2e1ce44913f966348ce353d02fa5369e94115181037cd8b602510853ec3033", "https://deno.land/std@0.179.0/streams/writer_from_stream_writer.ts": "31126a6bf2e678c5a718011d4831dbe75dbdbd885965d3dbd5dd105e6f20f976", "https://deno.land/std@0.179.0/streams/zip_readable_streams.ts": "9eb82070d83055fe6f077192fb204dc7612695a4b330148e9aa376df1a65e708", - "https://deno.land/std@0.179.0/testing/_diff.ts": "1a3c044aedf77647d6cac86b798c6417603361b66b54c53331b312caeb447aea", - "https://deno.land/std@0.179.0/testing/_format.ts": "a69126e8a469009adf4cf2a50af889aca364c349797e63174884a52ff75cf4c7", - "https://deno.land/std@0.179.0/testing/_test_suite.ts": "30f018feeb3835f12ab198d8a518f9089b1bcb2e8c838a8b615ab10d5005465c", - "https://deno.land/std@0.179.0/testing/asserts.ts": "984ab0bfb3faeed92ffaa3a6b06536c66811185328c5dd146257c702c41b01ab", - "https://deno.land/std@0.179.0/testing/bdd.ts": "c5ca6d85940dbcc19b4d2bc3608d49ab65d81470aa91306d5efa4b0d5c945731", - "https://deno.land/std@0.179.0/testing/mock.ts": "220ed9b8151cb2cac141043d4cfea7c47673fab5d18d1c1f0943297c8afb5d13", - "https://deno.land/std@0.179.0/types.d.ts": "220ed56662a0bd393ba5d124aa6ae2ad36a00d2fcbc0e8666a65f4606aaa9784", "https://deno.land/x/ansi@1.0.1/clear.ts": "444d83749bd171a38e77a7a7d5d270bbf84fbb0ea21f0a62e60c931a11f2bfc1", "https://deno.land/x/ansi@1.0.1/constants.ts": "aa51274a1402e017e043f544542e895880eadd67cca3e424884ed228813144bb", "https://deno.land/x/ansi@1.0.1/cursor.ts": "cbba999f0f87865401490541e1bf098573491d1c6be411852eaed58f4e39716a", @@ -254,7 +246,6 @@ "https://deno.land/x/zcli@1.3.3/mod.ts": "bdf98129a4f2d5b9e4d1446e252765f3c0df64289b5094b3c7cc287b42ebee12", "https://deno.land/x/zcli@1.3.3/version.ts": "793bc7245ccefda0f924017b2d973ec4258519c6b89b75f1f2ad91c3966ce3aa", "https://deno.land/x/zcli@1.3.3/z.ts": "3ece197424db8241978f2867426ceee02c72a53dc406142cf767b3a33560ebe5", - "https://deno.land/x/zcli@1.3.3/zcli-json.ts": "bf090cbd9c6222ad331ca01382e967e669286b19ea5cd550ebfc7fd2d7384323", "https://deno.land/x/zcli@1.3.3/zod-proxy.ts": "b5cb0c33445e7170c0c021340a6ce45747df76662d0d76ba4eeb6e606ffab115", "https://deno.land/x/zod@v3.21.4/ZodError.ts": "4de18ff525e75a0315f2c12066b77b5c2ae18c7c15ef7df7e165d63536fdf2ea", "https://deno.land/x/zod@v3.21.4/errors.ts": "5285922d2be9700cc0c70c95e4858952b07ae193aa0224be3cbd5cd5567eabef", @@ -269,191 +260,9 @@ "https://deno.land/x/zod@v3.21.4/locales/en.ts": "a7a25cd23563ccb5e0eed214d9b31846305ddbcdb9c5c8f508b108943366ab4c", "https://deno.land/x/zod@v3.21.4/mod.ts": "64e55237cb4410e17d968cd08975566059f27638ebb0b86048031b987ba251c4", "https://deno.land/x/zod@v3.21.4/types.ts": "b5d061babea250de14fc63764df5b3afa24f2b088a1d797fc060ba49a0ddff28", - "https://esm.sh/v111/zod@3.21.4/deno/zod.js": "ef6535dd2aa5c37b49464e9f474f5e59252e3f50f7f03183d43e997be3f62263", - "https://esm.sh/v111/zod@3.21.4/index.d.ts": "b51c954b9557b1dcb03b2bf34cd136e710cb9aa276e686cac0e291249590a52a", - "https://esm.sh/v111/zod@3.21.4/lib/ZodError.d.ts": "1f19511459549a66526d9dcc3b2288e59fa5fd4cf42b390a945d0bdc289806df", - "https://esm.sh/v111/zod@3.21.4/lib/errors.d.ts": "5ec2790f877581637c058eb5bbb72e855a078620d0781d2a6a8f308fe1d5436f", - "https://esm.sh/v111/zod@3.21.4/lib/external.d.ts": "91cec2fe1e1fb2574812a29a57ad2c39a1e69b0fa1179547382c92649fc5c66e", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/enumUtil.d.ts": "f672c876c1a04a223cf2023b3d91e8a52bb1544c576b81bf64a8fec82be9969c", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/errorUtil.d.ts": "98a9cc18f661d28e6bd31c436e1984f3980f35e0f0aa9cf795c54f8ccb667ffe", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/parseUtil.d.ts": "d3dbfc2f2fbf2c1bdea72db72f9f5c95d2ca5b4d32c9e229764ebaba0920203c", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/partialUtil.d.ts": "be2da97df422506d54e0e1727a40f6315c7311931b65a552b3172148db734c43", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/typeAliases.d.ts": "5487b97cfa28b26b4a9ef0770f872bdbebd4c46124858de00f242c3eed7519f4", - "https://esm.sh/v111/zod@3.21.4/lib/helpers/util.d.ts": "7a01f546ace66019156e4232a1bee2fabc2f8eabeb052473d926ee1693956265", - "https://esm.sh/v111/zod@3.21.4/lib/index.d.ts": "e6e0b04af1500398c8840582cce03d8907d6475005eb490f0e07bb33db6da66c", - "https://esm.sh/v111/zod@3.21.4/lib/locales/en.d.ts": "f8ec1611afb8d132c6c71822718805866890cf2071025153af97508eff24e4b6", - "https://esm.sh/v111/zod@3.21.4/lib/types.d.ts": "d7eecca2a9e02b2b2f51eaef95956f490a5780d03b32b9865068a63a26810f01", - "https://esm.sh/v112/zod-to-json-schema@3.20.4/deno/zod-to-json-schema.mjs": "44fabb5e833c12b2c22e5bc58227a94effd7971e29837ad9b637333c1d2981a8", - "https://esm.sh/v112/zod@3.21.4/deno/zod.mjs": "652b3e1f40b7dbb5b32d5c4d4fc7f1cbe06b0cf87c16cb7cd0c62f8ce9457406", - "https://esm.sh/zod-to-json-schema@3.20.4": "8f7f0db5c072058e1508a855afe8897189a0a177c18f72134004798c183e4c3e" - }, - "npm": { - "specifiers": { - "openapi-typescript": "openapi-typescript@6.2.0", - "openapi-typescript@6.2.0": "openapi-typescript@6.2.0" - }, - "packages": { - "@nodelib/fs.scandir@2.1.5": { - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", - "dependencies": { - "@nodelib/fs.stat": "@nodelib/fs.stat@2.0.5", - "run-parallel": "run-parallel@1.2.0" - } - }, - "@nodelib/fs.stat@2.0.5": { - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", - "dependencies": {} - }, - "@nodelib/fs.walk@1.2.8": { - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", - "dependencies": { - "@nodelib/fs.scandir": "@nodelib/fs.scandir@2.1.5", - "fastq": "fastq@1.15.0" - } - }, - "ansi-colors@4.1.3": { - "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", - "dependencies": {} - }, - "argparse@2.0.1": { - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dependencies": {} - }, - "braces@3.0.2": { - "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", - "dependencies": { - "fill-range": "fill-range@7.0.1" - } - }, - "busboy@1.6.0": { - "integrity": "sha512-8SFQbg/0hQ9xy3UNTB0YEnsNBbWfhf7RtnzpL7TkBiTBRfrQ9Fxcnz7VJsleJpyp6rVLvXiuORqjlHi5q+PYuA==", - "dependencies": { - "streamsearch": "streamsearch@1.1.0" - } - }, - "fast-glob@3.2.12": { - "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", - "dependencies": { - "@nodelib/fs.stat": "@nodelib/fs.stat@2.0.5", - "@nodelib/fs.walk": "@nodelib/fs.walk@1.2.8", - "glob-parent": "glob-parent@5.1.2", - "merge2": "merge2@1.4.1", - "micromatch": "micromatch@4.0.5" - } - }, - "fastq@1.15.0": { - "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==", - "dependencies": { - "reusify": "reusify@1.0.4" - } - }, - "fill-range@7.0.1": { - "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", - "dependencies": { - "to-regex-range": "to-regex-range@5.0.1" - } - }, - "glob-parent@5.1.2": { - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", - "dependencies": { - "is-glob": "is-glob@4.0.3" - } - }, - "is-extglob@2.1.1": { - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", - "dependencies": {} - }, - "is-glob@4.0.3": { - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "dependencies": { - "is-extglob": "is-extglob@2.1.1" - } - }, - "is-number@7.0.0": { - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", - "dependencies": {} - }, - "js-yaml@4.1.0": { - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", - "dependencies": { - "argparse": "argparse@2.0.1" - } - }, - "merge2@1.4.1": { - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", - "dependencies": {} - }, - "micromatch@4.0.5": { - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", - "dependencies": { - "braces": "braces@3.0.2", - "picomatch": "picomatch@2.3.1" - } - }, - "openapi-typescript@6.1.1": { - "integrity": "sha512-KKoe2ZfALfMRo7hbi7T7fP6hr7770l6/FbwGPNMCLwMj4gYqLIGf49bR2gnPrCDQG1XbC65M8XGCnvF/E+aI9g==", - "dependencies": { - "ansi-colors": "ansi-colors@4.1.3", - "fast-glob": "fast-glob@3.2.12", - "js-yaml": "js-yaml@4.1.0", - "supports-color": "supports-color@9.3.1", - "undici": "undici@5.20.0", - "yargs-parser": "yargs-parser@21.1.1" - } - }, - "openapi-typescript@6.2.0": { - "integrity": "sha512-d1HF70HCUnU+g9hgX5X3MJ+BMgwX16fzwD6mkyfNqdxXuOTOSkm+O+aaFqLNX13aFbCylz4m2WiVe4viAShxiQ==", - "dependencies": { - "ansi-colors": "ansi-colors@4.1.3", - "fast-glob": "fast-glob@3.2.12", - "js-yaml": "js-yaml@4.1.0", - "supports-color": "supports-color@9.3.1", - "undici": "undici@5.20.0", - "yargs-parser": "yargs-parser@21.1.1" - } - }, - "picomatch@2.3.1": { - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", - "dependencies": {} - }, - "queue-microtask@1.2.3": { - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dependencies": {} - }, - "reusify@1.0.4": { - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", - "dependencies": {} - }, - "run-parallel@1.2.0": { - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dependencies": { - "queue-microtask": "queue-microtask@1.2.3" - } - }, - "streamsearch@1.1.0": { - "integrity": "sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==", - "dependencies": {} - }, - "supports-color@9.3.1": { - "integrity": "sha512-knBY82pjmnIzK3NifMo3RxEIRD9E0kIzV4BKcyTZ9+9kWgLMxd4PrsTSMoFQUabgRBbF8KOLRDCyKgNV+iK44Q==", - "dependencies": {} - }, - "to-regex-range@5.0.1": { - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dependencies": { - "is-number": "is-number@7.0.0" - } - }, - "undici@5.20.0": { - "integrity": "sha512-J3j60dYzuo6Eevbawwp1sdg16k5Tf768bxYK4TUJRH7cBM4kFCbf3mOnM/0E3vQYXvpxITbbWmBafaDbxLDz3g==", - "dependencies": { - "busboy": "busboy@1.6.0" - } - }, - "yargs-parser@21.1.1": { - "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", - "dependencies": {} - } - } + "https://esm.sh/v135/zod-to-json-schema@3.20.4/denonext/zod-to-json-schema.mjs": "069fd005ad8095b36b1e2d65359f7e9850012429126972728a565c83fcd5ad5c", + "https://esm.sh/v135/zod@3.22.4/denonext/zod.mjs": "660128af5d1e921745c4d452472d103d9f2fc5afa508bbf233b83d35a272ad67", + "https://esm.sh/v135/zod@3.23.8/denonext/zod.mjs": "b3707b03ddc01aab11b740436ab23c0fcc8d15fed072be20085c1fd611016b61", + "https://esm.sh/zod-to-json-schema@3.20.4": "6420a5b1f4ab016d902b3e552dcfe1048c1f3e92b2f5d7b171598a00d3df7e32" } }