diff --git a/.assets/pspace.json b/.assets/pspace.json index 2b17a68..d3cb1d6 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2023-06-13T17:23:29.159Z", + "buildDate": "2024-05-30T13:51:15.604Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, @@ -91,7 +91,7 @@ "name": "autoscaling-group", "description": "Manage your autoscaling groups. Autoscaling groups enable using\nthe Kubernetes cluster-autoscaler to automatically scale your cluster.\nYou can also autoscaling groups as a primitive for your own autoscaler.", "summary": "Manage your autoscaling groups", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace autoscaling-group [command]\n pspace autoscaling-group [flags]", "flags": [ { "name": "log-level", @@ -169,7 +169,7 @@ "name": "create", "description": "Create an autoscaling group.", "summary": "Create an autoscaling group", - "usage": " pspace autoscaling-group [flags]", + "usage": " pspace autoscaling-group create [flags]", "flags": [ { "name": "fields", @@ -392,7 +392,7 @@ "name": "delete", "description": "Delete an autoscaling group from a team.", "summary": "Delete an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " pspace autoscaling-group delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -504,7 +504,7 @@ "name": "get", "description": "Get an autoscaling group from a team.", "summary": "Get an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " pspace autoscaling-group get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -616,7 +616,7 @@ "name": "help", "description": "Show help for a autoscaling-group command", "summary": "Show help for a autoscaling-group command", - "usage": " pspace autoscaling-group [command]\n pspace autoscaling-group [arguments] [flags]", + "usage": " pspace autoscaling-group help [command]\n pspace autoscaling-group help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -717,9 +717,9 @@ "commands": [ { "name": "commands", - "description": "List autoscaling-group commands\n\nExample:\n```\n$ pspace autoscaling-group help commands\n```", + "description": "List autoscaling-group commands\n\nExample:\n```\n$ pspace autoscaling-group help commands commands\n```", "summary": "List autoscaling-group commands", - "usage": " pspace autoscaling-group help [flags]", + "usage": " pspace autoscaling-group help commands [flags]", "flags": [ { "name": "log-level", @@ -817,7 +817,7 @@ "name": "list", "description": "List autoscaling groups in your team.\n\nPick a subset of fields to display:\n```\npspace autoscaling-group list -F name -F dtCreated\n```", "summary": "List autoscaling groups.", - "usage": " pspace autoscaling-group [flags]", + "usage": " pspace autoscaling-group list [flags]", "flags": [ { "name": "limit", @@ -1013,7 +1013,7 @@ "name": "update", "description": "Update an autoscaling group.", "summary": "Update an autoscaling group", - "usage": " pspace autoscaling-group [arguments] [flags]", + "usage": " pspace autoscaling-group update [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1269,7 +1269,7 @@ "name": "completion", "description": "Generate an autocompletion script for pspace in the specified shell.\nSee each sub-command's help for details on how to use the generated script.", "summary": "Generate an autocompletion script for the specified shell", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace completion [command]\n pspace completion [flags]", "flags": [ { "name": "log-level", @@ -1345,9 +1345,9 @@ "commands": [ { "name": "bash", - "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(pspace completion bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ pspace completion bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the bash shell.\n\nThis script depends on the `bash-completion` package.\nIf it is not installed already, you can install it via your OS's package manager.\n\nTo load completions in your current shell session:\n```\n$ source <(pspace completion bash bash)\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion bash bash > /etc/bash_completion.d/pspace\n```\n\nmacOS:\n```\n$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the bash shell", - "usage": " pspace completion [flags]", + "usage": " pspace completion bash [flags]", "flags": [ { "name": "log-level", @@ -1424,9 +1424,9 @@ }, { "name": "fish", - "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ pspace completion fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ pspace completion fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the fish shell.\n\nTo load completions in your current shell session:\n```\n$ pspace completion fish fish | source\n```\n\nTo load completions for every new session, execute once:\n```\n$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the fish shell", - "usage": " pspace completion [flags]", + "usage": " pspace completion fish [flags]", "flags": [ { "name": "no-descriptions", @@ -1520,7 +1520,7 @@ "name": "help", "description": "Show help for a completion command", "summary": "Show help for a completion command", - "usage": " pspace completion [command]\n pspace completion [arguments] [flags]", + "usage": " pspace completion help [command]\n pspace completion help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -1619,9 +1619,9 @@ "commands": [ { "name": "commands", - "description": "List completion commands\n\nExample:\n```\n$ pspace completion help commands\n```", + "description": "List completion commands\n\nExample:\n```\n$ pspace completion help commands commands\n```", "summary": "List completion commands", - "usage": " pspace completion help [flags]", + "usage": " pspace completion help commands [flags]", "flags": [ { "name": "log-level", @@ -1717,9 +1717,9 @@ }, { "name": "zsh", - "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ pspace completion zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ pspace completion zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", + "description": "Generate the autocompletion script for the zsh shell.\n\nIf shell completion is not already enabled in your environment you will need\nto enable it. You can execute the following once:\n\n```\n$ echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n```\n\nTo load completions for every new session, execute once:\n\nLinux:\n```\n$ pspace completion zsh zsh > \"${fpath[1]}/_pspace\"\n```\n\nmacOS:\n```\n$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace\n```\n\nOh My Zsh:\n```\n$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace\n```\n\nYou will need to start a new shell for this setup to take effect.", "summary": "Generate an autocompletion script for the zsh shell", - "usage": " pspace completion [flags]", + "usage": " pspace completion zsh [flags]", "flags": [ { "name": "no-descriptions", @@ -1815,7 +1815,7 @@ "name": "config", "description": "This command manages your Paperspace configuration. You can use it to set, get, and \ndelete configuration values. Running this command without any subcommands will print \nyour current configuration.\n\nYour configuration is stored in a TOML file at `~/.paperspace/config.toml`. \n\nFor example, to set the current team, run: \n```\npspace config set team \"my-team\"\n```", "summary": "Manage your local Paperspace configuration.", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace config [command]\n pspace config [flags]", "flags": [ { "name": "log-level", @@ -1893,7 +1893,7 @@ "name": "delete", "description": "Delete a configuration value.", "summary": "Delete a configuration value.", - "usage": " pspace config [flags]", + "usage": " pspace config delete [flags]", "arguments": { "description": "", "summary": "The key to delete.", @@ -1994,7 +1994,7 @@ "name": "get", "description": "This command gets a configuration value. You can pass a key to get a specific\nvalue, or you can pass no arguments to get all configuration values.\n\nFor example, to get the current team run:\n```\npspace config get team\n```", "summary": "Get a configuration value.", - "usage": " pspace config [arguments] [flags]", + "usage": " pspace config get [arguments] [flags]", "arguments": { "description": "", "summary": "The key to get.", @@ -2095,7 +2095,7 @@ "name": "help", "description": "Show help for a config command", "summary": "Show help for a config command", - "usage": " pspace config [command]\n pspace config [arguments] [flags]", + "usage": " pspace config help [command]\n pspace config help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2194,9 +2194,9 @@ "commands": [ { "name": "commands", - "description": "List config commands\n\nExample:\n```\n$ pspace config help commands\n```", + "description": "List config commands\n\nExample:\n```\n$ pspace config help commands commands\n```", "summary": "List config commands", - "usage": " pspace config help [flags]", + "usage": " pspace config help commands [flags]", "flags": [ { "name": "log-level", @@ -2294,7 +2294,7 @@ "name": "set", "description": "Set a configuration value.", "summary": "Set a configuration value.", - "usage": " pspace config [arguments] [arguments...] [flags]", + "usage": " pspace config set [arguments] [arguments...] [flags]", "arguments": { "description": "", "summary": "The key/value pair to set.", @@ -2408,7 +2408,7 @@ "name": "console", "description": "This command opens the Paperspace web console in your browser.", "summary": "Open the Paperspace web console.", - "usage": " pspace [flags]", + "usage": " pspace console [flags]", "flags": [ { "name": "log-level", @@ -2484,10 +2484,10 @@ "commands": [] }, { - "name": "deployment", - "description": "Effortlessly deploy ML apps to Paperspace.", - "summary": "Effortlessly deploy ML apps to Paperspace.", - "usage": " pspace [command]\n pspace [flags]", + "name": "custom-template", + "description": "Manage your custom templates. Custom templates are a backup of your\nmachine's disk. They can be used to create additional machines. You\ncan use them to prepopulate a machine with your desired software stack.\n\nFor more information, see https://docs.paperspace.com/compute/custom-templates.", + "summary": "Manage your custom templates", + "usage": " pspace custom-template [command]\n pspace custom-template [flags]", "flags": [ { "name": "log-level", @@ -2561,29 +2561,172 @@ } ], "commands": [ + { + "name": "create", + "description": "Create a custom template from a machine.", + "summary": "Create a custom template", + "usage": " pspace custom-template create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the custom template", + "summary": "The name of the custom template", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-id", + "aliases": [ + "m" + ], + "description": "The ID of the machine to create a custom template from", + "summary": "The ID of the machine to create a custom template from", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, { "name": "delete", - "description": "Delete a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment delete 123e4567-e89b-12d3-a456-426614174000\n```", - "summary": "Delete a deployment.", - "usage": " pspace deployment [arguments] [flags]", + "description": "Delete a custom template from a team.", + "summary": "Delete a custom template", + "usage": " pspace custom-template delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The deployment ID to delete.", + "summary": "The ID of the custom template to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The deployment ID to delete.", + "description": "The ID of the custom template to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } ] }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -2659,21 +2802,21 @@ }, { "name": "get", - "description": "Get a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000\n```\n\nPick a subset of fields to display:\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name\n```", - "summary": "Get a deployment.", - "usage": " pspace deployment [arguments] [flags]", + "description": "Get a custom template from a team.", + "summary": "Get a custom template", + "usage": " pspace custom-template get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The deployment ID to get.", + "summary": "The ID of the custom template to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The deployment ID to get.", + "description": "The ID of the custom template to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -2771,9 +2914,9 @@ }, { "name": "help", - "description": "Show help for a deployment command", - "summary": "Show help for a deployment command", - "usage": " pspace deployment [command]\n pspace deployment [arguments] [flags]", + "description": "Show help for a custom-template command", + "summary": "Show help for a custom-template command", + "usage": " pspace custom-template help [command]\n pspace custom-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -2786,10 +2929,10 @@ "schema": { "type": "string", "enum": [ + "create", "get", "list", "delete", - "up", "help" ], "description": "The command to show help for.", @@ -2873,9 +3016,9 @@ "commands": [ { "name": "commands", - "description": "List deployment commands\n\nExample:\n```\n$ pspace deployment help commands\n```", - "summary": "List deployment commands", - "usage": " pspace deployment help [flags]", + "description": "List custom-template commands\n\nExample:\n```\n$ pspace custom-template help commands commands\n```", + "summary": "List custom-template commands", + "usage": " pspace custom-template help commands [flags]", "flags": [ { "name": "log-level", @@ -2971,9 +3114,9 @@ }, { "name": "list", - "description": "List deployments in your team.\n\nPick a subset of fields to display:\n```\npspace deployment list -F id -F name\n```", - "summary": "List deployments.", - "usage": " pspace deployment [flags]", + "description": "List custom templates in your team.\n\nPick a subset of fields to display:\n```\npspace custom-template list -F name -F dtModified\n```", + "summary": "List custom templates.", + "usage": " pspace custom-template list [flags]", "flags": [ { "name": "limit", @@ -3064,6 +3207,38 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "machine-id", + "aliases": [ + "m" + ], + "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", + "summary": "The ID of the machine the event is for", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3136,52 +3311,146 @@ } ], "commands": [] + } + ] + }, + { + "name": "dataset", + "description": "Manage your datasets.\n\nFor more information, see https://docs.paperspace.com/storage/datasets.", + "summary": "Manage your datasets", + "usage": " pspace dataset [command]\n pspace dataset [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "up", - "description": "This will create a new deployment for your app or update it if it already exists. \nYou can optionally specify a path to a config file. If no config file is specified, \nthe default config file paths will be tried.\n\nCreate a new deployment for the app in the current directory.\n```\n$ pspace deployment create\n```\n\nCreate a new deployment using a config file.\n```\n$ pspace deployment create -c paperspace.json\n```\n\nCreate a new deployment for an app in a different directory.\n```\n$ pspace deployment create --cwd ../my-app\n```\n\nCreate a new deployment for an app in a specific project.\n```\n$ pspace deployment create --project-id 1234\n```", - "summary": "Create or update a deployment", - "usage": " pspace deployment [flags]", - "flags": [ - { - "name": "config", - "aliases": [ - "c" - ], - "description": "The path to the config file. Defaults to our default config file paths.\n\nThe default config file paths are in order of precedence:\n\n- `paperspace.yaml`\n- `paperspace.yml`\n- `paperspace.json`\n- `paperspace.jsonc`\n- `paperspace.toml`\n- `.paperspace/app.yaml`\n- `.paperspace/app.yml`\n- `.paperspace/app.json`\n- `.paperspace/app.jsonc`\n- `.paperspace/app.toml`", - "summary": "The path to the config file. Defaults to our default config file paths.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "project-id", - "aliases": [ - "p" - ], - "description": "The ID of the project to deploy to.", - "summary": "The ID of the project to deploy to.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "cwd", - "aliases": [], - "description": "The directory to deploy the app from. Defaults to the current directory.", - "summary": "The directory to deploy the app from. Defaults to the current directory.", - "required": false, - "collects": false, + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a dataset.", + "summary": "Create a dataset", + "usage": " pspace dataset create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the dataset", + "summary": "The name of the dataset", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [], + "description": "The description of the dataset", + "summary": "The description of the dataset", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "storage-provider-id", + "aliases": [], + "description": "The ID of the storage provider to use for the dataset", + "summary": "The ID of the storage provider to use for the dataset", + "required": false, + "collects": false, "negatable": false, "global": false, "schema": { @@ -3189,6 +3458,20 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "is-public", + "aliases": [], + "description": "Whether the dataset is public", + "summary": "Whether the dataset is public", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3261,236 +3544,158 @@ } ], "commands": [] - } - ] - }, - { - "name": "docs", - "description": "This command opens the Paperspace documentation in your browser.\nYou can optionally pass an argument that will take you to a specific \ndocs page.\n\nValid pages are:\n - `d`, `deployment`", - "summary": "Open Paperspace documention in your default browser.", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The page to open", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "d", - "deployment" + }, + { + "name": "delete", + "description": "Delete a dataset from a team.", + "summary": "Delete a dataset", + "usage": " pspace dataset delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" ], - "description": "The page to open", - "$schema": "http://json-schema.org/draft-07/schema#" + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "help", - "description": "Show help for a pspace command", - "summary": "Show help for a pspace command", - "usage": " pspace [command]\n pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The command to show help for.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "autoscaling-group", - "config", - "console", - "deployment", - "docs", - "init", - "login", - "logout", - "machine", - "machine-event", - "private-network", - "project", - "public-ip", - "secret", - "signup", - "snapshot", - "shared-drive", - "startup-script", - "template", - "up", - "upgrade", - "version", - "completion", - "help" - ], - "description": "The command to show help for.", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "commands", - "description": "List pspace commands\n\nExample:\n```\n$ pspace help commands\n```", - "summary": "List pspace commands", - "usage": " pspace help [flags]", + "name": "get", + "description": "Get a dataset from a team.", + "summary": "Get a dataset", + "usage": " pspace dataset get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -3560,491 +3765,4384 @@ "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a dataset command", + "summary": "Show help for a dataset command", + "usage": " pspace dataset help [command]\n pspace dataset help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "versions", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { - "name": "all", + "name": "log-level", "aliases": [ - "a" + "l" ], - "description": "Show all commands, including hidden ones", - "summary": "Show all commands, including hidden ones", + "description": "Enable debug logging.", + "summary": "Enable debug logging", "required": false, "collects": false, "negatable": false, - "default": false, - "global": false, + "global": true, "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - } - ] - }, - { - "name": "init", - "description": "Create a new Paperspace app. This will create a new directory with a\ndefault app structure. You can optionally specify a name for the app\nand a template to use. If no template is specified, the default\ntemplate will be used.\n\nCreate a new app in the current directory.\n```\n$ pspace init\n```\n\nCreate a new app named \"my-app\" relative to the current directory.\n```\n$ pspace init my-app\n```\n\nCreate a new app named \"my-app\" relative to the current directory using\na template from the Paperspace GitHub organization.\n```\n$ pspace init my-app -t Paperspace/gradio-demo\n```", - "summary": "Create a new Paperspace app", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "The directory to create the app in. Defaults to the current directory.", - "items": [ - { - "position": 0, - "summary": "", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "template", - "aliases": [ - "t" - ], - "description": "A template to use when creating the app. This can be a URL \nto a git repository or a shorthand template name.\n\nThese templates are equivalent:\n```\nuser/repo\ngithub:user/repo\ngit@github.com:user/repo\nhttps://github.com/user/repo\n```\n\nDownload from GitLab:\n```\ngitlab:user/repo\ngit@gitlab.com:user/repo\nhttps://gitlab.com/user/repo\n```\n\nDownload from Bitbucket\n```\nbitbucket:user/repo\ngit@bitbucket.org:user/repo\nhttps://bitbucket.org/user/repo\n```\n\nSpecify a tag or branch:\n```\nuser/repo#dev # branch\nuser/repo#v1.2.3 # release tag\nuser/repo#1234abcd # commit hash\n```", - "summary": "A template to use when creating the app", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "anyOf": [ - { - "not": {} - }, - { - "type": "string" + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" } - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "mode", - "aliases": [ - "m" - ], - "description": "The mode to use when creating the app. This can be either \"git\" or\n\"tar\". If \"git\" is specified, the template will be downloaded as a\ntarball. Note that \"git\" clones over SSH, so you must have a valid\nSSH key configured with GitHub, Bitbucket, or GitLab.", - "summary": "The mode to use when creating the app: 'git' or 'tar'.", - "required": false, - "collects": false, - "negatable": false, - "default": "tar", - "global": false, - "schema": { - "type": "string", - "enum": [ - "git", - "tar" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the app. Defaults to the first argument current directory name.", - "summary": "The name of the app. Defaults to the first argument current directory name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "clean", - "aliases": [ - "c" + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Clean the Paperspace cache. This negates other args/flags.", - "summary": "Clean the Paperspace cache. This negates other args/flags.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [ + { + "name": "commands", + "description": "List dataset commands\n\nExample:\n```\n$ pspace dataset help commands commands\n```", + "summary": "List dataset commands", + "usage": " pspace dataset help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] }, { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" + "name": "list", + "description": "List datasets in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset list -F name -F dtModified\n```", + "summary": "List datasets.", + "usage": " pspace dataset list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "update", + "description": "Update a dataset in a project or team.", + "summary": "Update a dataset", + "usage": " pspace dataset update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the dataset", + "summary": "The name of the dataset", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [], + "description": "The description of the dataset", + "summary": "The description of the dataset", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "versions", + "description": "Manage your dataset versions.\n\nFor more information, see https://docs.paperspace.com/storage/datasetVersions.", + "summary": "Manage your dataset versions", + "usage": " pspace dataset versions [command]\n pspace dataset versions [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a dataset version. This command will prompt you for an ID if you don't\nprovide one.", + "summary": "Create a dataset version", + "usage": " pspace dataset versions create [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The description of the dataset version.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The description of the dataset version.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "tags", + "aliases": [], + "description": "The tags for the version, comma-delimited", + "summary": "The tags for the version, comma-delimited", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "delete", + "description": "Delete a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", + "summary": "Delete a dataset version", + "usage": " pspace dataset versions delete [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The version of the dataset to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The version of the dataset to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a dataset version from a team. This command will prompt you for an ID\nif you don't provide one.", + "summary": "Get a dataset version", + "usage": " pspace dataset versions get [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The dataset version to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The dataset version to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a versions command", + "summary": "Show help for a versions command", + "usage": " pspace dataset versions help [command]\n pspace dataset versions help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List versions commands\n\nExample:\n```\n$ pspace dataset versions help commands commands\n```", + "summary": "List versions commands", + "usage": " pspace dataset versions help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List dataset versions in your team or project.\n\nPick a subset of fields to display:\n```\npspace dataset versions list -F name -F dtModified\n```", + "summary": "List dataset versions.", + "usage": " pspace dataset versions list [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a dataset version in a project or team.", + "summary": "Update a dataset version", + "usage": " pspace dataset versions update [arguments] [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the dataset", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the dataset", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "position": 1, + "summary": "The version of the dataset to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The version of the dataset to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "message", + "aliases": [ + "m" + ], + "description": "The description of the dataset version", + "summary": "The description of the dataset version", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "tags", + "aliases": [], + "description": "The tags for the version, comma-delimited", + "summary": "The tags for the version, comma-delimited", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + } + ] + }, + { + "name": "deployment", + "description": "Effortlessly deploy ML apps to Paperspace.", + "summary": "Effortlessly deploy ML apps to Paperspace.", + "usage": " pspace deployment [command]\n pspace deployment [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "delete", + "description": "Delete a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment delete 123e4567-e89b-12d3-a456-426614174000\n```", + "summary": "Delete a deployment.", + "usage": " pspace deployment delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The deployment ID to delete.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The deployment ID to delete.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a deployment by its ID. If you don't provide an ID, this command will\nprompt you for one based on the deployments you have access to.\n\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000\n```\n\nPick a subset of fields to display:\n```\npspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name\n```", + "summary": "Get a deployment.", + "usage": " pspace deployment get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The deployment ID to get.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The deployment ID to get.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a deployment command", + "summary": "Show help for a deployment command", + "usage": " pspace deployment help [command]\n pspace deployment help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "get", + "list", + "delete", + "up", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List deployment commands\n\nExample:\n```\n$ pspace deployment help commands commands\n```", + "summary": "List deployment commands", + "usage": " pspace deployment help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List deployments in your team.\n\nPick a subset of fields to display:\n```\npspace deployment list -F id -F name\n```", + "summary": "List deployments.", + "usage": " pspace deployment list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "up", + "description": "This will create a new deployment for your app or update it if it already exists. \nYou can optionally specify a path to a config file. If no config file is specified, \nthe default config file paths will be tried.\n\nCreate a new deployment for the app in the current directory.\n```\n$ pspace deployment create\n```\n\nCreate a new deployment using a config file.\n```\n$ pspace deployment create -c paperspace.json\n```\n\nCreate a new deployment for an app in a different directory.\n```\n$ pspace deployment create --cwd ../my-app\n```\n\nCreate a new deployment for an app in a specific project.\n```\n$ pspace deployment create --project-id 1234\n```", + "summary": "Create or update a deployment", + "usage": " pspace deployment up [flags]", + "flags": [ + { + "name": "config", + "aliases": [ + "c" + ], + "description": "The path to the config file. Defaults to our default config file paths.\n\nThe default config file paths are in order of precedence:\n\n- `paperspace.yaml`\n- `paperspace.yml`\n- `paperspace.json`\n- `paperspace.jsonc`\n- `paperspace.toml`\n- `.paperspace/app.yaml`\n- `.paperspace/app.yml`\n- `.paperspace/app.json`\n- `.paperspace/app.jsonc`\n- `.paperspace/app.toml`", + "summary": "The path to the config file. Defaults to our default config file paths.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "project-id", + "aliases": [ + "p" + ], + "description": "The ID of the project to deploy to.", + "summary": "The ID of the project to deploy to.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "cwd", + "aliases": [], + "description": "The directory to deploy the app from. Defaults to the current directory.", + "summary": "The directory to deploy the app from. Defaults to the current directory.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "docs", + "description": "This command opens the Paperspace documentation in your browser.\nYou can optionally pass an argument that will take you to a specific \ndocs page.\n\nValid pages are:\n - `d`, `deployment`", + "summary": "Open Paperspace documention in your default browser.", + "usage": " pspace docs [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The page to open", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "d", + "deployment" + ], + "description": "The page to open", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "help", + "description": "Show help for a pspace command", + "summary": "Show help for a pspace command", + "usage": " pspace help [command]\n pspace help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "autoscaling-group", + "config", + "console", + "custom-template", + "dataset", + "deployment", + "docs", + "init", + "login", + "logout", + "machine", + "machine-event", + "os-template", + "private-network", + "project", + "public-ip", + "secret", + "signup", + "snapshot", + "shared-drive", + "startup-script", + "storage-provider", + "up", + "upgrade", + "model", + "version", + "completion", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List pspace commands\n\nExample:\n```\n$ pspace help commands commands\n```", + "summary": "List pspace commands", + "usage": " pspace help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "init", + "description": "Create a new Paperspace app. This will create a new directory with a\ndefault app structure. You can optionally specify a name for the app\nand a template to use. If no template is specified, the default\ntemplate will be used.\n\nCreate a new app in the current directory.\n```\n$ pspace init\n```\n\nCreate a new app named \"my-app\" relative to the current directory.\n```\n$ pspace init my-app\n```\n\nCreate a new app named \"my-app\" relative to the current directory using\na template from the Paperspace GitHub organization.\n```\n$ pspace init my-app -t Paperspace/gradio-demo\n```", + "summary": "Create a new Paperspace app", + "usage": " pspace init [arguments] [flags]", + "arguments": { + "description": "", + "summary": "The directory to create the app in. Defaults to the current directory.", + "items": [ + { + "position": 0, + "summary": "", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "template", + "aliases": [ + "t" + ], + "description": "A template to use when creating the app. This can be a URL \nto a git repository or a shorthand template name.\n\nThese templates are equivalent:\n```\nuser/repo\ngithub:user/repo\ngit@github.com:user/repo\nhttps://github.com/user/repo\n```\n\nDownload from GitLab:\n```\ngitlab:user/repo\ngit@gitlab.com:user/repo\nhttps://gitlab.com/user/repo\n```\n\nDownload from Bitbucket\n```\nbitbucket:user/repo\ngit@bitbucket.org:user/repo\nhttps://bitbucket.org/user/repo\n```\n\nSpecify a tag or branch:\n```\nuser/repo#dev # branch\nuser/repo#v1.2.3 # release tag\nuser/repo#1234abcd # commit hash\n```", + "summary": "A template to use when creating the app", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "anyOf": [ + { + "not": {} + }, + { + "type": "string" + } + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "mode", + "aliases": [ + "m" + ], + "description": "The mode to use when creating the app. This can be either \"git\" or\n\"tar\". If \"git\" is specified, the template will be downloaded as a\ntarball. Note that \"git\" clones over SSH, so you must have a valid\nSSH key configured with GitHub, Bitbucket, or GitLab.", + "summary": "The mode to use when creating the app: 'git' or 'tar'.", + "required": false, + "collects": false, + "negatable": false, + "default": "tar", + "global": false, + "schema": { + "type": "string", + "enum": [ + "git", + "tar" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the app. Defaults to the first argument current directory name.", + "summary": "The name of the app. Defaults to the first argument current directory name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "clean", + "aliases": [ + "c" + ], + "description": "Clean the Paperspace cache. This negates other args/flags.", + "summary": "Clean the Paperspace cache. This negates other args/flags.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "login", + "description": "Log in to the CLI using your Paperspace API key or by opening the web console.", + "summary": "Log in to the CLI.", + "usage": " pspace login [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "An API key to log in with.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "An API key to log in with.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "logout", + "description": "Log out of the CLI for the current team, a specific team, or all teams.", + "summary": "Log out of the CLI.", + "usage": " pspace logout [arguments...] [flags]", + "arguments": { + "description": "", + "summary": "The teams to logout of.", + "items": [ + { + "position": 0, + "summary": "The team to logout of.", + "required": true, + "variadic": true, + "schema": { + "type": "string", + "description": "The team to logout of.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Log out of all teams.", + "summary": "Log out of all teams.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "machine", + "description": "Manage your Paperspace machines.\n\nFor more information, see https://docs.paperspace.com/machines.", + "summary": "Manage your Paperspace machines", + "usage": " pspace machine [command]\n pspace machine [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a machine.", + "summary": "Create a machine", + "usage": " pspace machine create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the machine", + "summary": "The name of the machine", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-type", + "aliases": [], + "description": "The machine type to create", + "summary": "The machine type to create", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "template-id", + "aliases": [], + "description": "The ID of the template to create the machine from", + "summary": "The ID of the template to create the machine from", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "network-id", + "aliases": [], + "description": "The ID of the network to create the machine in", + "summary": "The ID of the network to create the machine in", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region to create the machine in", + "summary": "The region to create the machine in", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "disk-size", + "aliases": [], + "description": "The size of the machine's disk", + "summary": "The size of the machine's disk", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "public-ip-type", + "aliases": [], + "description": "The public IP type.", + "summary": "The public IP type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-enabled", + "aliases": [], + "description": "Whether to enable auto snapshots.", + "summary": "Whether to enable auto snapshots.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-frequency", + "aliases": [], + "description": "The auto snapshot frequency.", + "summary": "The auto snapshot frequency.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-snapshot-save-count", + "aliases": [], + "description": "The number of auto snapshots to save.", + "summary": "The number of auto snapshots to save.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-enabled", + "aliases": [], + "description": "Whether to enable auto shutdown.", + "summary": "Whether to enable auto shutdown.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-timeout", + "aliases": [], + "description": "The auto shutdown timeout in hours.", + "summary": "The auto shutdown timeout in hours.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "auto-shutdown-force", + "aliases": [], + "description": "Whether to force shutdown the machine.", + "summary": "Whether to force shutdown the machine.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "take-initial-snapshot", + "aliases": [], + "description": "Whether to take an initial snapshot.", + "summary": "Whether to take an initial snapshot.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "restore-point-enabled", + "aliases": [], + "description": "Whether to use initial snapshot as a restore point.", + "summary": "Whether to use initial snapshot as a restore point.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "restore-point-frequency", + "aliases": [], + "description": "The restore point frequency.", + "summary": "The restore point frequency.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "startup-script-id", + "aliases": [], + "description": "The startup script ID.", + "summary": "The startup script ID.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "email-password", + "aliases": [], + "description": "Whether to email the password.", + "summary": "Whether to email the password.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "start-on-create", + "aliases": [], + "description": "Whether to start the machine on creation.", + "summary": "Whether to start the machine on creation.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "enable-nvlink", + "aliases": [], + "description": "Whether to enable NVLink.", + "summary": "Whether to enable NVLink.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "accessor-ids", + "aliases": [], + "description": "The accessors of the machine.", + "summary": "The accessors of the machine.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "login", - "description": "Log in to the CLI using your Paperspace API key or by opening the web console.", - "summary": "Log in to the CLI.", - "usage": " pspace [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "An API key to log in with.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "An API key to log in with.", - "$schema": "http://json-schema.org/draft-07/schema#" + "name": "delete", + "description": "Delete a machine from a team.", + "summary": "Delete a machine", + "usage": " pspace machine delete [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to delete", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to delete", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } } - } - ] - }, - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "json", - "aliases": [ - "j" + "name": "get", + "description": "Get a machine from a team.", + "summary": "Get a machine", + "usage": " pspace machine get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { "name": "help", - "aliases": [ - "h" + "description": "Show help for a machine command", + "summary": "Show help for a machine command", + "usage": " pspace machine help [command]\n pspace machine help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "create", + "get", + "list", + "start", + "stop", + "restart", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "logout", - "description": "Log out of the CLI for the current team, a specific team, or all teams.", - "summary": "Log out of the CLI.", - "usage": " pspace [arguments...] [flags]", - "arguments": { - "description": "", - "summary": "The teams to logout of.", - "items": [ - { - "position": 0, - "summary": "The team to logout of.", - "required": true, - "variadic": true, - "schema": { - "type": "string", - "description": "The team to logout of.", - "$schema": "http://json-schema.org/draft-07/schema#" + "commands": [ + { + "name": "commands", + "description": "List machine commands\n\nExample:\n```\n$ pspace machine help commands commands\n```", + "summary": "List machine commands", + "usage": " pspace machine help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] } - } - ] - }, - "flags": [ - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Log out of all teams.", - "summary": "Log out of all teams.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + ] }, { - "name": "json", - "aliases": [ - "j" + "name": "list", + "description": "List machines in your team.\n\nPick a subset of fields to display:\n```\npspace machine list -F name -F dtModified\n```", + "summary": "List machines.", + "usage": " pspace machine list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "agent-type", + "aliases": [ + "a" + ], + "description": "Filter by agent type.", + "summary": "Filter by agent type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "machine-type", + "aliases": [ + "m" + ], + "description": "Filter by machine type.", + "summary": "Filter by machine type.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [ + "r" + ], + "description": "Filter by region.", + "summary": "Filter by region.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - }, - { - "name": "machine", - "description": "Manage your Paperspace machines.\n\nFor more information, see https://docs.paperspace.com/machines.", - "summary": "Manage your Paperspace machines", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" + "name": "restart", + "description": "Restart a machine from a team.", + "summary": "Restart a machine", + "usage": " pspace machine restart [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to restart", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to restart", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "json", - "aliases": [ - "j" + "name": "start", + "description": "Start a machine from a team.", + "summary": "Start a machine", + "usage": " pspace machine start [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to start", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to start", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a machine.", - "summary": "Create a machine", - "usage": " pspace machine [flags]", + "name": "stop", + "description": "Stop a machine from a team.", + "summary": "Stop a machine", + "usage": " pspace machine stop [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to stop", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to stop", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ { "name": "fields", @@ -4063,26 +8161,124 @@ } }, { - "name": "name", + "name": "log-level", "aliases": [ - "n" + "l" ], - "description": "The name of the machine", - "summary": "The name of the machine", - "required": true, + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "machine-type", + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", "aliases": [], - "description": "The machine type to create", - "summary": "The machine type to create", + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a machine's settings.", + "summary": "Update a machine", + "usage": " pspace machine update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the machine to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the machine to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the machine", + "summary": "The name of the machine", "required": true, "collects": false, "negatable": false, @@ -4093,10 +8289,10 @@ } }, { - "name": "template-id", + "name": "machine-type", "aliases": [], - "description": "The ID of the template to create the machine from", - "summary": "The ID of the template to create the machine from", + "description": "The machine type to update to", + "summary": "The machine type to update to", "required": true, "collects": false, "negatable": false, @@ -4120,20 +8316,6 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "region", - "aliases": [], - "description": "The region to create the machine in", - "summary": "The region to create the machine in", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "disk-size", "aliases": [], @@ -4246,25 +8428,11 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "take-initial-snapshot", - "aliases": [], - "description": "Whether to take an initial snapshot.", - "summary": "Whether to take an initial snapshot.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "restore-point-enabled", "aliases": [], - "description": "Whether to use initial snapshot as a restore point.", - "summary": "Whether to use initial snapshot as a restore point.", + "description": "Whether to enable a restore point.", + "summary": "Whether to enable a restore point.", "required": false, "collects": false, "negatable": false, @@ -4289,70 +8457,14 @@ } }, { - "name": "startup-script-id", - "aliases": [], - "description": "The startup script ID.", - "summary": "The startup script ID.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "email-password", - "aliases": [], - "description": "Whether to email the password.", - "summary": "Whether to email the password.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "start-on-create", - "aliases": [], - "description": "Whether to start the machine on creation.", - "summary": "Whether to start the machine on creation.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "enable-nvlink", + "name": "restore-point-snapshot-id", "aliases": [], - "description": "Whether to enable NVLink.", - "summary": "Whether to enable NVLink.", + "description": "The ID of the snapshot to use as a restore point.", + "summary": "The ID of the snapshot to use as a restore point.", "required": false, "collects": false, "negatable": false, "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "accessor-ids", - "aliases": [], - "description": "The accessors of the machine.", - "summary": "The accessors of the machine.", - "required": false, - "collects": true, - "negatable": false, - "global": false, "schema": { "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" @@ -4430,136 +8542,104 @@ } ], "commands": [] + } + ] + }, + { + "name": "machine-event", + "description": "Manage your machine events. Events are asynchronous tasks performed by our system on your machines.\nNot all machine commands are asynchronous. For those that are, a machine event will be returned\nwhich can be tracked using this command.\n\nFor more information, see https://docs.paperspace.com/machines.", + "summary": "Manage your machine events", + "usage": " pspace machine-event [command]\n pspace machine-event [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "delete", - "description": "Delete a machine from a team.", - "summary": "Delete a machine", - "usage": " pspace machine [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine to delete", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine to delete", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } + "name": "json", + "aliases": [ + "j" ], - "commands": [] + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ { "name": "get", - "description": "Get a machine from a team.", - "summary": "Get a machine", - "usage": " pspace machine [arguments] [flags]", + "description": "Get a machine event from a team.", + "summary": "Get a machine event", + "usage": " pspace machine-event get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to get", + "summary": "The ID of the machine event to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to get", + "description": "The ID of the machine event to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -4657,9 +8737,9 @@ }, { "name": "help", - "description": "Show help for a machine command", - "summary": "Show help for a machine command", - "usage": " pspace machine [command]\n pspace machine [arguments] [flags]", + "description": "Show help for a machine-event command", + "summary": "Show help for a machine-event command", + "usage": " pspace machine-event help [command]\n pspace machine-event help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -4672,14 +8752,8 @@ "schema": { "type": "string", "enum": [ - "create", "get", "list", - "start", - "stop", - "restart", - "delete", - "update", "help" ], "description": "The command to show help for.", @@ -4763,9 +8837,9 @@ "commands": [ { "name": "commands", - "description": "List machine commands\n\nExample:\n```\n$ pspace machine help commands\n```", - "summary": "List machine commands", - "usage": " pspace machine help [flags]", + "description": "List machine-event commands\n\nExample:\n```\n$ pspace machine-event help commands commands\n```", + "summary": "List machine-event commands", + "usage": " pspace machine-event help commands [flags]", "flags": [ { "name": "log-level", @@ -4861,9 +8935,9 @@ }, { "name": "list", - "description": "List machines in your team.\n\nPick a subset of fields to display:\n```\npspace machine list -F name -F dtModified\n```", - "summary": "List machines.", - "usage": " pspace machine [flags]", + "description": "List machine events in your team.\n\nPick a subset of fields to display:\n```\npspace machine-event list -F name -F dtModified\n```", + "summary": "List machine events.", + "usage": " pspace machine-event list [flags]", "flags": [ { "name": "limit", @@ -4955,60 +9029,12 @@ } }, { - "name": "agent-type", - "aliases": [ - "a" - ], - "description": "Filter by agent type.", - "summary": "Filter by agent type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-type", + "name": "machine-id", "aliases": [ "m" ], - "description": "Filter by machine type.", - "summary": "Filter by machine type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "Filter by name.", - "summary": "Filter by name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "region", - "aliases": [ - "r" - ], - "description": "Filter by region.", - "summary": "Filter by region.", + "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", + "summary": "The ID of the machine the event is for", "required": false, "collects": false, "negatable": false, @@ -5090,39 +9116,180 @@ } ], "commands": [] + } + ] + }, + { + "name": "model", + "description": "Manage your Paperspace models.\n\nFor more information, see https://docs.paperspace.com/deploying/models.", + "summary": "Manage your Paperspace models", + "usage": " pspace model [command]\n pspace model [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "restart", - "description": "Restart a machine from a team.", - "summary": "Restart a machine", - "usage": " pspace machine [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine to restart", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine to restart", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a new model. This command will prompt you for a name if you don't\nprovide one.", + "summary": "Create a new model", + "usage": " pspace model create [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the model", + "summary": "The name of the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "description", + "aliases": [ + "d" + ], + "description": "The description of the model", + "summary": "The description of the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-public", + "aliases": [], + "description": "Whether the model is public", + "summary": "Whether the model is public", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "storage-provider-id", + "aliases": [ + "s" + ], + "description": "The ID of the storage provider to use for the model", + "summary": "The ID of the storage provider to use for the model", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" } - ] - }, - "flags": [ + }, { - "name": "fields", + "name": "project-id", "aliases": [ - "F" + "p" ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + "description": "The ID of the project to create the model in", + "summary": "The ID of the project to create the model in", "required": false, - "collects": true, + "collects": false, "negatable": false, "global": false, "schema": { @@ -5204,22 +9371,22 @@ "commands": [] }, { - "name": "start", - "description": "Start a machine from a team.", - "summary": "Start a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "delete", + "description": "Delete a model from a team.", + "summary": "Delete a model", + "usage": " pspace model delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to start", + "summary": "The ID of the model to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to start", + "description": "The ID of the model to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -5316,22 +9483,22 @@ "commands": [] }, { - "name": "stop", - "description": "Stop a machine from a team.", - "summary": "Stop a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "get", + "description": "Get a model from a team.", + "summary": "Get a model", + "usage": " pspace model get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to stop", + "summary": "The ID of the model to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to stop", + "description": "The ID of the model to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -5428,242 +9595,35 @@ "commands": [] }, { - "name": "update", - "description": "Update a machine's settings.", - "summary": "Update a machine", - "usage": " pspace machine [arguments] [flags]", + "name": "help", + "description": "Show help for a model command", + "summary": "Show help for a model command", + "usage": " pspace model help [command]\n pspace model help [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the machine to update", + "summary": "The command to show help for.", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the machine to update", + "enum": [ + "create", + "list", + "get", + "delete", + "help" + ], + "description": "The command to show help for.", "$schema": "http://json-schema.org/draft-07/schema#" } } ] }, "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the machine", - "summary": "The name of the machine", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-type", - "aliases": [], - "description": "The machine type to update to", - "summary": "The machine type to update to", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "network-id", - "aliases": [], - "description": "The ID of the network to create the machine in", - "summary": "The ID of the network to create the machine in", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "disk-size", - "aliases": [], - "description": "The size of the machine's disk", - "summary": "The size of the machine's disk", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "public-ip-type", - "aliases": [], - "description": "The public IP type.", - "summary": "The public IP type.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-enabled", - "aliases": [], - "description": "Whether to enable auto snapshots.", - "summary": "Whether to enable auto snapshots.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-frequency", - "aliases": [], - "description": "The auto snapshot frequency.", - "summary": "The auto snapshot frequency.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-snapshot-save-count", - "aliases": [], - "description": "The number of auto snapshots to save.", - "summary": "The number of auto snapshots to save.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-enabled", - "aliases": [], - "description": "Whether to enable auto shutdown.", - "summary": "Whether to enable auto shutdown.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-timeout", - "aliases": [], - "description": "The auto shutdown timeout in hours.", - "summary": "The auto shutdown timeout in hours.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "auto-shutdown-force", - "aliases": [], - "description": "Whether to force shutdown the machine.", - "summary": "Whether to force shutdown the machine.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-enabled", - "aliases": [], - "description": "Whether to enable a restore point.", - "summary": "Whether to enable a restore point.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-frequency", - "aliases": [], - "description": "The restore point frequency.", - "summary": "The restore point frequency.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "restore-point-snapshot-id", - "aliases": [], - "description": "The ID of the snapshot to use as a restore point.", - "summary": "The ID of the snapshot to use as a restore point.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -5735,111 +9695,184 @@ } } ], - "commands": [] - } - ] - }, - { - "name": "machine-event", - "description": "Manage your machine events. Events are asynchronous tasks performed by our system on your machines.\nNot all machine commands are asynchronous. For those that are, a machine event will be returned\nwhich can be tracked using this command.\n\nFor more information, see https://docs.paperspace.com/machines.", - "summary": "Manage your machine events", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "commands": [ + { + "name": "commands", + "description": "List model commands\n\nExample:\n```\n$ pspace model help commands commands\n```", + "summary": "List model commands", + "usage": " pspace model help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "get", - "description": "Get a machine event from a team.", - "summary": "Get a machine event", - "usage": " pspace machine-event [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the machine event to get", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the machine event to get", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "name": "list", + "description": "List models in your team.\n\nPick a subset of fields to display:\n```\npspace model list -F name -F dtModified\n```", + "summary": "List models.", + "usage": " pspace model list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" } - ] - }, - "flags": [ + }, { "name": "fields", "aliases": [ @@ -5928,12 +9961,92 @@ } ], "commands": [] + } + ] + }, + { + "name": "os-template", + "description": "List OS templates. OS templates are pre-configured virtual machines that\nyou can use to create a new machine.\n\nFor more information, see https://docs.paperspace.com/compute/os-templates.", + "summary": "List OS templates", + "usage": " pspace os-template [command]\n pspace os-template [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { "name": "help", - "description": "Show help for a machine-event command", - "summary": "Show help for a machine-event command", - "usage": " pspace machine-event [command]\n pspace machine-event [arguments] [flags]", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "help", + "description": "Show help for a os-template command", + "summary": "Show help for a os-template command", + "usage": " pspace os-template help [command]\n pspace os-template help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -5946,7 +10059,6 @@ "schema": { "type": "string", "enum": [ - "get", "list", "help" ], @@ -6031,9 +10143,9 @@ "commands": [ { "name": "commands", - "description": "List machine-event commands\n\nExample:\n```\n$ pspace machine-event help commands\n```", - "summary": "List machine-event commands", - "usage": " pspace machine-event help [flags]", + "description": "List os-template commands\n\nExample:\n```\n$ pspace os-template help commands commands\n```", + "summary": "List os-template commands", + "usage": " pspace os-template help commands [flags]", "flags": [ { "name": "log-level", @@ -6129,9 +10241,9 @@ }, { "name": "list", - "description": "List machine events in your team.\n\nPick a subset of fields to display:\n```\npspace machine-event list -F name -F dtModified\n```", - "summary": "List machine events.", - "usage": " pspace machine-event [flags]", + "description": "List OS templates.\n\nPick a subset of fields to display:\n```\npspace os-template list -F name\n```", + "summary": "List OS templates.", + "usage": " pspace os-template list [flags]", "flags": [ { "name": "limit", @@ -6223,12 +10335,12 @@ } }, { - "name": "machine-id", + "name": "name", "aliases": [ - "m" + "n" ], - "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", - "summary": "The ID of the machine the event is for", + "description": "Filter by name.", + "summary": "Filter by name.", "required": false, "collects": false, "negatable": false, @@ -6317,7 +10429,7 @@ "name": "private-network", "description": "Manage your private networks. Private networks are logically isolated networks\nfor your machines and shared drives. They can also be used for site-to-site VPNs\nand direct connections to your on-premise network.\n\nFor more information, see https://docs.paperspace.com/networking/private-networks.", "summary": "Manage your private networks", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace private-network [command]\n pspace private-network [flags]", "flags": [ { "name": "log-level", @@ -6395,7 +10507,7 @@ "name": "create", "description": "Create a private network.", "summary": "Create a private network", - "usage": " pspace private-network [flags]", + "usage": " pspace private-network create [flags]", "flags": [ { "name": "fields", @@ -6520,7 +10632,7 @@ "name": "delete", "description": "Delete a private network from a team.", "summary": "Delete a private network", - "usage": " pspace private-network [arguments] [flags]", + "usage": " pspace private-network delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6632,7 +10744,7 @@ "name": "get", "description": "Get a private network from a team.", "summary": "Get a private network", - "usage": " pspace private-network [arguments] [flags]", + "usage": " pspace private-network get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6744,7 +10856,7 @@ "name": "help", "description": "Show help for a private-network command", "summary": "Show help for a private-network command", - "usage": " pspace private-network [command]\n pspace private-network [arguments] [flags]", + "usage": " pspace private-network help [command]\n pspace private-network help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -6844,9 +10956,9 @@ "commands": [ { "name": "commands", - "description": "List private-network commands\n\nExample:\n```\n$ pspace private-network help commands\n```", + "description": "List private-network commands\n\nExample:\n```\n$ pspace private-network help commands commands\n```", "summary": "List private-network commands", - "usage": " pspace private-network help [flags]", + "usage": " pspace private-network help commands [flags]", "flags": [ { "name": "log-level", @@ -6944,7 +11056,7 @@ "name": "list", "description": "List private networks in your team.\n\nPick a subset of fields to display:\n```\npspace private-network list -F name -F dtModified\n```", "summary": "List private networks.", - "usage": " pspace private-network [flags]", + "usage": " pspace private-network list [flags]", "flags": [ { "name": "limit", @@ -7146,7 +11258,7 @@ "name": "project", "description": "Manage your Paperspace projects.", "summary": "Manage your Paperspace projects.", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace project [command]\n pspace project [flags]", "flags": [ { "name": "log-level", @@ -7176,68 +11288,180 @@ "aliases": [ "j" ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a new project. This command will prompt you for a name if you don't\nprovide one.", + "summary": "Create a new project", + "usage": " pspace project create [arguments] [flags]", + "arguments": { + "description": "", + "summary": "Create a project with these properties.", + "items": [ + { + "position": 0, + "summary": "", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "minLength": 1, + "maxLength": 120, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] }, { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a new project. This command will prompt you for a name if you don't\nprovide one.", - "summary": "Create a new project", - "usage": " pspace project [arguments] [flags]", + "name": "delete", + "description": "Delete a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", + "summary": "Delete a project.", + "usage": " pspace project delete [arguments] [flags]", "arguments": { "description": "", - "summary": "Create a project with these properties.", + "summary": "", "items": [ { "position": 0, - "summary": "", + "summary": "The project ID to delete.", "required": true, "variadic": false, "schema": { "type": "string", - "minLength": 1, - "maxLength": 120, + "description": "The project ID to delete.", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -7337,7 +11561,7 @@ "name": "get", "description": "Get a project by its ID. If you don't provide an ID, this command will\nprompt you for one based on the projects you have access to.", "summary": "Get a project.", - "usage": " pspace project [arguments] [flags]", + "usage": " pspace project get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7449,7 +11673,7 @@ "name": "help", "description": "Show help for a project command", "summary": "Show help for a project command", - "usage": " pspace project [command]\n pspace project [arguments] [flags]", + "usage": " pspace project help [command]\n pspace project help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -7467,6 +11691,7 @@ "create", "update", "link", + "delete", "help" ], "description": "The command to show help for.", @@ -7550,9 +11775,9 @@ "commands": [ { "name": "commands", - "description": "List project commands\n\nExample:\n```\n$ pspace project help commands\n```", + "description": "List project commands\n\nExample:\n```\n$ pspace project help commands commands\n```", "summary": "List project commands", - "usage": " pspace project help [flags]", + "usage": " pspace project help commands [flags]", "flags": [ { "name": "log-level", @@ -7650,7 +11875,7 @@ "name": "link", "description": "This will link a remote project to a local directory. Commands that\ndepend on a project ID will use the project ID of the linked project\nwhen communicating with the Paperspace API.\n\nLink a project to the current directory.\n```\n$ pspace link\n```\n\nLink a project to a different directory.\n```\n$ pspace link --cwd ../my-app\n```\n\nLink a project and specify a project ID.\n```\n$ pspace link pzwf2g05ubegj\n```", "summary": "Link a remote project to ", - "usage": " pspace project [arguments] [flags]", + "usage": " pspace project link [arguments] [flags]", "arguments": { "description": "", "summary": "A project ID. If not provided, you will be prompted to select one.", @@ -7760,7 +11985,7 @@ "name": "list", "description": "List projects in your team.\n\nPick a subset of fields to display:\n```\npspace project list -F id -F name -F dtCreated\n```", "summary": "List projects.", - "usage": " pspace project [flags]", + "usage": " pspace project list [flags]", "flags": [ { "name": "limit", @@ -8058,7 +12283,7 @@ "name": "public-ip", "description": "Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet.\n\nFor more information, see https://docs.paperspace.com/networking/public-ips.", "summary": "Manage your public IPs", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace public-ip [command]\n pspace public-ip [flags]", "flags": [ { "name": "log-level", @@ -8136,7 +12361,7 @@ "name": "assign", "description": "Assign a public IP to a machine.", "summary": "Assign a public IP", - "usage": " pspace public-ip [arguments] [flags]", + "usage": " pspace public-ip assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8267,7 +12492,7 @@ "name": "claim", "description": "Claim a public IP for a team.", "summary": "Claim a public IP", - "usage": " pspace public-ip [flags]", + "usage": " pspace public-ip claim [flags]", "flags": [ { "name": "fields", @@ -8378,7 +12603,7 @@ "name": "help", "description": "Show help for a public-ip command", "summary": "Show help for a public-ip command", - "usage": " pspace public-ip [command]\n pspace public-ip [arguments] [flags]", + "usage": " pspace public-ip help [command]\n pspace public-ip help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8478,9 +12703,9 @@ "commands": [ { "name": "commands", - "description": "List public-ip commands\n\nExample:\n```\n$ pspace public-ip help commands\n```", + "description": "List public-ip commands\n\nExample:\n```\n$ pspace public-ip help commands commands\n```", "summary": "List public-ip commands", - "usage": " pspace public-ip help [flags]", + "usage": " pspace public-ip help commands [flags]", "flags": [ { "name": "log-level", @@ -8578,7 +12803,7 @@ "name": "list", "description": "List public IPs in your team or project.\n\nPick a subset of fields to display:\n```\npspace public-ip list -F name -F dtModified\n```", "summary": "List public IPs.", - "usage": " pspace public-ip [flags]", + "usage": " pspace public-ip list [flags]", "flags": [ { "name": "limit", @@ -8762,7 +12987,7 @@ "name": "release", "description": "Release a public IP from a team. This will unassign it from its assigned machine, if any.", "summary": "Release a public IP", - "usage": " pspace public-ip [arguments] [flags]", + "usage": " pspace public-ip release [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -8876,7 +13101,7 @@ "name": "secret", "description": "Manage your Paperspace secrets. Secrets are used to store sensitive\ninformation such as API keys, passwords, and other credentials. Secrets \ncan be safely injected into workloads as environment variables. An environment \nvariable that uses a Secret will not reveal the contents of the secret itself.\n\nSecrets can be created at the following levels:\n\n- Project (default): these secrets are applied to all resources in a project\n- Global: these secrets can be applied to all resources on your current team\n\nFor more information, see https://docs.paperspace.com/secrets.", "summary": "Manage your Paperspace secrets", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace secret [command]\n pspace secret [flags]", "flags": [ { "name": "log-level", @@ -8954,7 +13179,7 @@ "name": "create", "description": "Create a secret in a project or team.", "summary": "Create a secret", - "usage": " pspace secret [arguments] [arguments] [flags]", + "usage": " pspace secret create [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9112,7 +13337,7 @@ "name": "delete", "description": "Delete a secret from a project or team.", "summary": "Delete a secret", - "usage": " pspace secret [arguments] [flags]", + "usage": " pspace secret delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9257,7 +13482,7 @@ "name": "get", "description": "Get a secret from a project or team.", "summary": "Get a secret", - "usage": " pspace secret [arguments] [flags]", + "usage": " pspace secret get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9418,7 +13643,7 @@ "name": "help", "description": "Show help for a secret command", "summary": "Show help for a secret command", - "usage": " pspace secret [command]\n pspace secret [arguments] [flags]", + "usage": " pspace secret help [command]\n pspace secret help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9519,9 +13744,9 @@ "commands": [ { "name": "commands", - "description": "List secret commands\n\nExample:\n```\n$ pspace secret help commands\n```", + "description": "List secret commands\n\nExample:\n```\n$ pspace secret help commands commands\n```", "summary": "List secret commands", - "usage": " pspace secret help [flags]", + "usage": " pspace secret help commands [flags]", "flags": [ { "name": "log-level", @@ -9619,7 +13844,7 @@ "name": "list", "description": "List secrets in your team or project.\n\nPick a subset of fields to display:\n```\npspace secret list -F name -F dtModified\n```", "summary": "List secrets.", - "usage": " pspace secret [flags]", + "usage": " pspace secret list [flags]", "flags": [ { "name": "limit", @@ -9833,7 +14058,7 @@ "name": "update", "description": "Update a secret in a project or team.", "summary": "Update a secret", - "usage": " pspace secret [arguments] [arguments] [flags]", + "usage": " pspace secret update [arguments] [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -9993,7 +14218,7 @@ "name": "shared-drive", "description": "Manage your shared drives. Shared drives are used to centralize data\nused by your team. Shared drives can be mounted on any Paperspace machine\nin the same private network.\n\nFor more information, see https://docs.paperspace.com/storage/shared-drives.", "summary": "Manage your shared drives", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace shared-drive [command]\n pspace shared-drive [flags]", "flags": [ { "name": "log-level", @@ -10071,7 +14296,7 @@ "name": "create", "description": "Create a shared drive.", "summary": "Create a shared drive", - "usage": " pspace shared-drive [flags]", + "usage": " pspace shared-drive create [flags]", "flags": [ { "name": "fields", @@ -10222,21 +14447,21 @@ }, { "name": "delete", - "description": "Delete a template from a team.", - "summary": "Delete a template", - "usage": " pspace shared-drive [arguments] [flags]", + "description": "Delete a shared drive from a team.", + "summary": "Delete a shared drive", + "usage": " pspace shared-drive delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to delete", + "summary": "The ID of the shared drive to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to delete", + "description": "The ID of the shared drive to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -10334,21 +14559,21 @@ }, { "name": "get", - "description": "Get a template from a team.", - "summary": "Get a template", - "usage": " pspace shared-drive [arguments] [flags]", + "description": "Get a shared drive from a team.", + "summary": "Get a shared drive", + "usage": " pspace shared-drive get [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to get", + "summary": "The ID of the shared drive to get", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to get", + "description": "The ID of the shared drive to get", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -10448,7 +14673,7 @@ "name": "help", "description": "Show help for a shared-drive command", "summary": "Show help for a shared-drive command", - "usage": " pspace shared-drive [command]\n pspace shared-drive [arguments] [flags]", + "usage": " pspace shared-drive help [command]\n pspace shared-drive help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -10548,9 +14773,9 @@ "commands": [ { "name": "commands", - "description": "List shared-drive commands\n\nExample:\n```\n$ pspace shared-drive help commands\n```", + "description": "List shared-drive commands\n\nExample:\n```\n$ pspace shared-drive help commands commands\n```", "summary": "List shared-drive commands", - "usage": " pspace shared-drive help [flags]", + "usage": " pspace shared-drive help commands [flags]", "flags": [ { "name": "log-level", @@ -10648,7 +14873,7 @@ "name": "list", "description": "List shared drives in your team or project.\n\nPick a subset of fields to display:\n```\npspace shared-drive list -F name -F dtModified\n```", "summary": "List shared drives.", - "usage": " pspace shared-drive [flags]", + "usage": " pspace shared-drive list [flags]", "flags": [ { "name": "limit", @@ -10850,7 +15075,7 @@ "name": "signup", "description": "This command opens the Paperspace signup page in your browser.", "summary": "Sign up for a Paperspace account.", - "usage": " pspace [flags]", + "usage": " pspace signup [flags]", "flags": [ { "name": "log-level", @@ -10929,7 +15154,7 @@ "name": "snapshot", "description": "Manage your snapshots. Snapshots are copies of your machine's disk at a point in time.\nThey can be used to restore the machine to its previous state. Using snapshots is recommended\nbefore taking any action that could affect the usability of the machine or its network connection.\n\nFor more information, see https://docs.paperspace.com/storage/snapshots.", "summary": "Manage your snapshots", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace snapshot [command]\n pspace snapshot [flags]", "flags": [ { "name": "log-level", @@ -11007,7 +15232,7 @@ "name": "create", "description": "Create a snapshot from a machine.", "summary": "Create a snapshot", - "usage": " pspace snapshot [flags]", + "usage": " pspace snapshot create [flags]", "flags": [ { "name": "fields", @@ -11134,7 +15359,7 @@ "name": "delete", "description": "Delete a snapshot from a team.", "summary": "Delete a snapshot", - "usage": " pspace snapshot [arguments] [flags]", + "usage": " pspace snapshot delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11246,7 +15471,7 @@ "name": "help", "description": "Show help for a snapshot command", "summary": "Show help for a snapshot command", - "usage": " pspace snapshot [command]\n pspace snapshot [arguments] [flags]", + "usage": " pspace snapshot help [command]\n pspace snapshot help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11346,9 +15571,9 @@ "commands": [ { "name": "commands", - "description": "List snapshot commands\n\nExample:\n```\n$ pspace snapshot help commands\n```", + "description": "List snapshot commands\n\nExample:\n```\n$ pspace snapshot help commands commands\n```", "summary": "List snapshot commands", - "usage": " pspace snapshot help [flags]", + "usage": " pspace snapshot help commands [flags]", "flags": [ { "name": "log-level", @@ -11446,7 +15671,7 @@ "name": "list", "description": "List snapshots in your team.\n\nPick a subset of fields to display:\n```\npspace snapshot list -F name -F dtModified\n```", "summary": "List snapshots.", - "usage": " pspace snapshot [flags]", + "usage": " pspace snapshot list [flags]", "flags": [ { "name": "limit", @@ -11630,7 +15855,7 @@ "name": "restore", "description": "Restore a machine to a snapshot.", "summary": "Restore a snapshot", - "usage": " pspace snapshot [arguments] [flags]", + "usage": " pspace snapshot restore [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11758,7 +15983,7 @@ "name": "startup-script", "description": "Manage your startup scripts. Startup scripts allow you to configure a machine\non first boot or on every boot.", "summary": "Manage your startup scripts", - "usage": " pspace [command]\n pspace [flags]", + "usage": " pspace startup-script [command]\n pspace startup-script [flags]", "flags": [ { "name": "log-level", @@ -11836,7 +16061,7 @@ "name": "assign", "description": "Assign a startup script to a machine.", "summary": "Assign a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " pspace startup-script assign [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -11962,7 +16187,7 @@ "name": "create", "description": "Create a startup script.", "summary": "Create a startup script", - "usage": " pspace startup-script [flags]", + "usage": " pspace startup-script create [flags]", "flags": [ { "name": "fields", @@ -12101,7 +16326,7 @@ "name": "delete", "description": "Delete a startup script from a team.", "summary": "Delete a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " pspace startup-script delete [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12213,7 +16438,7 @@ "name": "get", "description": "Get a startup script from a team.", "summary": "Get a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "usage": " pspace startup-script get [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12325,7 +16550,7 @@ "name": "help", "description": "Show help for a startup-script command", "summary": "Show help for a startup-script command", - "usage": " pspace startup-script [command]\n pspace startup-script [arguments] [flags]", + "usage": " pspace startup-script help [command]\n pspace startup-script help [arguments] [flags]", "arguments": { "description": "", "summary": "", @@ -12428,9 +16653,9 @@ "commands": [ { "name": "commands", - "description": "List startup-script commands\n\nExample:\n```\n$ pspace startup-script help commands\n```", + "description": "List startup-script commands\n\nExample:\n```\n$ pspace startup-script help commands commands\n```", "summary": "List startup-script commands", - "usage": " pspace startup-script help [flags]", + "usage": " pspace startup-script help commands [flags]", "flags": [ { "name": "log-level", @@ -12519,37 +16744,240 @@ "$schema": "http://json-schema.org/draft-07/schema#" } } - ], - "commands": [] - } - ] - }, - { - "name": "list", - "description": "List startup scripts in your team.\n\nPick a subset of fields to display:\n```\npspace startup-script list -F name -F dtCreated\n```", - "summary": "List startup scripts.", - "usage": " pspace startup-script [flags]", + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List startup scripts in your team.\n\nPick a subset of fields to display:\n```\npspace startup-script list -F name -F dtCreated\n```", + "summary": "List startup scripts.", + "usage": " pspace startup-script list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "enum": [ + "dtCreated" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "desc", + "aliases": [], + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "Filter by name.", + "summary": "Filter by name.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "unassign", + "description": "Unassign a startup script from a machine.", + "summary": "Unassign a startup script", + "usage": " pspace startup-script unassign [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the startup script to unassign", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the startup script to unassign", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ { - "name": "limit", - "aliases": [], - "description": "The number of items to return in the next page.", - "summary": "The number of items to return in the next page.", + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", "required": false, - "collects": false, + "collects": true, "negatable": false, "global": false, "schema": { - "type": "number", + "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "after", + "name": "machine-id", "aliases": [], - "description": "The cursor to fetch the next results from.", - "summary": "The cursor to fetch the next results from.", - "required": false, + "description": "The ID of the machine to unassign the startup script from", + "summary": "The ID of the machine to unassign the startup script from", + "required": true, "collects": false, "negatable": false, "global": false, @@ -12559,50 +16987,101 @@ } }, { - "name": "orderBy", - "aliases": [], - "description": "The field to order items by.", - "summary": "The field to order items by.", + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", "enum": [ - "dtCreated" + "debug", + "info", + "warning", + "error", + "critical" ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "asc", - "aliases": [], - "description": "Whether to order items ascending.", - "summary": "Whether to order items ascending.", + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "boolean", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "desc", + "name": "api-key", "aliases": [], - "description": "Whether to order items descending.", - "summary": "Whether to order items descending.", + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { - "type": "boolean", + "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + }, + { + "name": "update", + "description": "Update a startup script.", + "summary": "Update a startup script", + "usage": " pspace startup-script update [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the startup script to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the startup script to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { "name": "fields", "aliases": [ @@ -12624,8 +17103,22 @@ "aliases": [ "n" ], - "description": "Filter by name.", - "summary": "Filter by name.", + "description": "The name of the startup script", + "summary": "The name of the startup script", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "script", + "aliases": [], + "description": "The script to run", + "summary": "The script to run", "required": false, "collects": false, "negatable": false, @@ -12635,6 +17128,34 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, + { + "name": "run-once", + "aliases": [], + "description": "Whether to run once or on every boot", + "summary": "Whether to run once or on every boot", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "enabled", + "aliases": [], + "description": "Whether the startup script is enabled or not", + "summary": "Whether the startup script is enabled or not", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -12707,60 +17228,93 @@ } ], "commands": [] + } + ] + }, + { + "name": "storage-provider", + "description": "Manage your storage providers.\n\nFor more information, see https://docs.paperspace.com/storage/storageProviders.", + "summary": "Manage your storage providers", + "usage": " pspace storage-provider [command]\n pspace storage-provider [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } }, { - "name": "unassign", - "description": "Unassign a startup script from a machine.", - "summary": "Unassign a startup script", - "usage": " pspace startup-script [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the startup script to unassign", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the startup script to unassign", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "create", + "description": "Create a storage provider.", + "summary": "Create a storage provider", + "usage": " pspace storage-provider create [command]\n pspace storage-provider create [flags]", "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-id", - "aliases": [], - "description": "The ID of the machine to unassign the startup script from", - "summary": "The ID of the machine to unassign the startup script from", - "required": true, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -12819,38 +17373,459 @@ "aliases": [ "h" ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "help", + "description": "Show help for a create command", + "summary": "Show help for a create command", + "usage": " pspace storage-provider create help [command]\n pspace storage-provider create help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "s3", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List create commands\n\nExample:\n```\n$ pspace storage-provider create help commands commands\n```", + "summary": "List create commands", + "usage": " pspace storage-provider create help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "s3", + "description": "Create an S3 storage provider.", + "summary": "Create an S3 storage provider", + "usage": " pspace storage-provider create s3 [flags]", + "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the storage provider", + "summary": "The name of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-team-default", + "aliases": [], + "description": "Whether the storage provider is the team's default provider", + "summary": "Whether the storage provider is the team's default provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "endpoint", + "aliases": [], + "description": "The endpoint of the storage provider", + "summary": "The endpoint of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "bucket", + "aliases": [], + "description": "The bucket of the storage provider", + "summary": "The bucket of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region of the storage provider", + "summary": "The region of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "access-key", + "aliases": [], + "description": "The access key of the storage provider", + "summary": "The access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "secret-access-key", + "aliases": [], + "description": "The secret access key of the storage provider", + "summary": "The secret access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "signature-version", + "aliases": [], + "description": "The signature version of the storage provider", + "summary": "The signature version of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "retain-data", + "aliases": [], + "description": "Whether to retain data in the storage provider", + "summary": "Whether to retain data in the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] } - ], - "commands": [] + ] }, { - "name": "update", - "description": "Update a startup script.", - "summary": "Update a startup script", - "usage": " pspace startup-script [arguments] [flags]", + "name": "delete", + "description": "Delete a storage provider from a team.", + "summary": "Delete a storage provider", + "usage": " pspace storage-provider delete [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the startup script to update", + "summary": "The ID of the storage provider to delete", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the startup script to update", + "description": "The ID of the storage provider to delete", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -12873,64 +17848,6 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "The name of the startup script", - "summary": "The name of the startup script", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "script", - "aliases": [], - "description": "The script to run", - "summary": "The script to run", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "run-once", - "aliases": [], - "description": "Whether to run once or on every boot", - "summary": "Whether to run once or on every boot", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "enabled", - "aliases": [], - "description": "Whether the startup script is enabled or not", - "summary": "Whether the startup script is enabled or not", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, { "name": "log-level", "aliases": [ @@ -12970,167 +17887,72 @@ "$schema": "http://json-schema.org/draft-07/schema#" } }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] - } - ] - }, - { - "name": "template", - "description": "Manage your templates. Templates are a backup of your machine's disk.\nThey can be used to create additional machines. You can use them to\nprepopulate a machine with your desired software stack.\n\nFor more information, see https://docs.paperspace.com/compute/custom-templates.", - "summary": "Manage your templates", - "usage": " pspace [command]\n pspace [flags]", - "flags": [ - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [ - { - "name": "create", - "description": "Create a template from a machine.", - "summary": "Create a template", - "usage": " pspace template [flags]", - "flags": [ - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", "required": false, - "collects": true, + "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { "type": "string", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "name", + "name": "help", "aliases": [ - "n" + "h" ], - "description": "The name of the template", - "summary": "The name of the template", - "required": true, + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, "collects": false, "negatable": false, - "global": false, + "global": true, "schema": { - "type": "string", + "type": "boolean", + "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, + } + ], + "commands": [] + }, + { + "name": "get", + "description": "Get a storage provider from a team.", + "summary": "Get a storage provider", + "usage": " pspace storage-provider get [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the storage provider to get", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the storage provider to get", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ { - "name": "machine-id", + "name": "fields", "aliases": [ - "m" + "F" ], - "description": "The ID of the machine to create a template from", - "summary": "The ID of the machine to create a template from", - "required": true, - "collects": false, + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, "negatable": false, "global": false, "schema": { @@ -13212,22 +18034,30 @@ "commands": [] }, { - "name": "delete", - "description": "Delete a template from a team.", - "summary": "Delete a template", - "usage": " pspace template [arguments] [flags]", + "name": "help", + "description": "Show help for a storage-provider command", + "summary": "Show help for a storage-provider command", + "usage": " pspace storage-provider help [command]\n pspace storage-provider help [arguments] [flags]", "arguments": { "description": "", "summary": "", "items": [ { "position": 0, - "summary": "The ID of the template to delete", + "summary": "The command to show help for.", "required": true, "variadic": false, "schema": { "type": "string", - "description": "The ID of the template to delete", + "enum": [ + "create", + "get", + "list", + "delete", + "update", + "help" + ], + "description": "The command to show help for.", "$schema": "http://json-schema.org/draft-07/schema#" } } @@ -13235,14 +18065,202 @@ }, "flags": [ { - "name": "fields", + "name": "log-level", "aliases": [ - "F" + "l" ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List storage-provider commands\n\nExample:\n```\n$ pspace storage-provider help commands commands\n```", + "summary": "List storage-provider commands", + "usage": " pspace storage-provider help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "List storage providers in your team or project.\n\nPick a subset of fields to display:\n```\npspace storage provider list -F name -F dtModified\n```", + "summary": "List storage providers.", + "usage": " pspace storage-provider list [flags]", + "flags": [ + { + "name": "limit", + "aliases": [], + "description": "The number of items to return in the next page.", + "summary": "The number of items to return in the next page.", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "number", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "after", + "aliases": [], + "description": "The cursor to fetch the next results from.", + "summary": "The cursor to fetch the next results from.", "required": false, - "collects": true, + "collects": false, "negatable": false, "global": false, "schema": { @@ -13251,101 +18269,50 @@ } }, { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", + "name": "orderBy", + "aliases": [], + "description": "The field to order items by.", + "summary": "The field to order items by.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "string", "enum": [ - "debug", - "info", - "warning", - "error", - "critical" + "dtCreated" ], "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", + "name": "asc", + "aliases": [], + "description": "Whether to order items ascending.", + "summary": "Whether to order items ascending.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "boolean", "$schema": "http://json-schema.org/draft-07/schema#" } }, { - "name": "api-key", + "name": "desc", "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", + "description": "Whether to order items descending.", + "summary": "Whether to order items descending.", "required": false, "collects": false, "negatable": false, - "global": true, + "global": false, "schema": { "type": "boolean", - "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - } - ], - "commands": [] - }, - { - "name": "get", - "description": "Get a template from a team.", - "summary": "Get a template", - "usage": " pspace template [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The ID of the template to get", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "description": "The ID of the template to get", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, - "flags": [ + }, { "name": "fields", "aliases": [ @@ -13436,34 +18403,10 @@ "commands": [] }, { - "name": "help", - "description": "Show help for a template command", - "summary": "Show help for a template command", - "usage": " pspace template [command]\n pspace template [arguments] [flags]", - "arguments": { - "description": "", - "summary": "", - "items": [ - { - "position": 0, - "summary": "The command to show help for.", - "required": true, - "variadic": false, - "schema": { - "type": "string", - "enum": [ - "create", - "get", - "list", - "delete", - "help" - ], - "description": "The command to show help for.", - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ] - }, + "name": "update", + "description": "Update a storage provider.", + "summary": "Update a storage provider", + "usage": " pspace storage-provider update [command]\n pspace storage-provider update [flags]", "flags": [ { "name": "log-level", @@ -13538,11 +18481,369 @@ ], "commands": [ { - "name": "commands", - "description": "List template commands\n\nExample:\n```\n$ pspace template help commands\n```", - "summary": "List template commands", - "usage": " pspace template help [flags]", + "name": "help", + "description": "Show help for a update command", + "summary": "Show help for a update command", + "usage": " pspace storage-provider update help [command]\n pspace storage-provider update help [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The command to show help for.", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "enum": [ + "s3", + "help" + ], + "description": "The command to show help for.", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [ + { + "name": "commands", + "description": "List update commands\n\nExample:\n```\n$ pspace storage-provider update help commands commands\n```", + "summary": "List update commands", + "usage": " pspace storage-provider update help commands [flags]", + "flags": [ + { + "name": "log-level", + "aliases": [ + "l" + ], + "description": "Enable debug logging.", + "summary": "Enable debug logging", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "enum": [ + "debug", + "info", + "warning", + "error", + "critical" + ], + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "json", + "aliases": [ + "j" + ], + "description": "Output JSON", + "summary": "Output JSON", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "api-key", + "aliases": [], + "description": "A Paperspace public API Key used for authenticating requests", + "summary": "A Paperspace public API Key used for authenticating requests", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "help", + "aliases": [ + "h" + ], + "description": "Show help for a command", + "summary": "Show help for a command", + "required": false, + "collects": false, + "negatable": false, + "global": true, + "schema": { + "type": "boolean", + "default": false, + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "all", + "aliases": [ + "a" + ], + "description": "Show all commands, including hidden ones", + "summary": "Show all commands, including hidden ones", + "required": false, + "collects": false, + "negatable": false, + "default": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ], + "commands": [] + } + ] + }, + { + "name": "s3", + "description": "Update an S3 storage provider in a project or team.", + "summary": "Update an S3 storage provider", + "usage": " pspace storage-provider update s3 [arguments] [flags]", + "arguments": { + "description": "", + "summary": "", + "items": [ + { + "position": 0, + "summary": "The ID of the storage provider to update", + "required": true, + "variadic": false, + "schema": { + "type": "string", + "description": "The ID of the storage provider to update", + "$schema": "http://json-schema.org/draft-07/schema#" + } + } + ] + }, "flags": [ + { + "name": "fields", + "aliases": [ + "F" + ], + "description": "The fields to include in the response.", + "summary": "The fields to include in the response.", + "required": false, + "collects": true, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "name", + "aliases": [ + "n" + ], + "description": "The name of the storage provider", + "summary": "The name of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "is-team-default", + "aliases": [], + "description": "Whether the storage provider is the team's default provider", + "summary": "Whether the storage provider is the team's default provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "endpoint", + "aliases": [], + "description": "The endpoint of the storage provider", + "summary": "The endpoint of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "bucket", + "aliases": [], + "description": "The bucket of the storage provider", + "summary": "The bucket of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "region", + "aliases": [], + "description": "The region of the storage provider", + "summary": "The region of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "access-key", + "aliases": [], + "description": "The access key of the storage provider", + "summary": "The access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "secret-access-key", + "aliases": [], + "description": "The secret access key of the storage provider", + "summary": "The secret access key of the storage provider", + "required": true, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "signature-version", + "aliases": [], + "description": "The signature version of the storage provider", + "summary": "The signature version of the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "string", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, + { + "name": "retain-data", + "aliases": [], + "description": "Whether to retain data in the storage provider", + "summary": "Whether to retain data in the storage provider", + "required": false, + "collects": false, + "negatable": false, + "global": false, + "schema": { + "type": "boolean", + "$schema": "http://json-schema.org/draft-07/schema#" + } + }, { "name": "log-level", "aliases": [ @@ -13612,228 +18913,11 @@ "default": false, "$schema": "http://json-schema.org/draft-07/schema#" } - }, - { - "name": "all", - "aliases": [ - "a" - ], - "description": "Show all commands, including hidden ones", - "summary": "Show all commands, including hidden ones", - "required": false, - "collects": false, - "negatable": false, - "default": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } } ], "commands": [] } ] - }, - { - "name": "list", - "description": "List templates in your team.\n\nPick a subset of fields to display:\n```\npspace template list -F name -F dtModified\n```", - "summary": "List templates.", - "usage": " pspace template [flags]", - "flags": [ - { - "name": "limit", - "aliases": [], - "description": "The number of items to return in the next page.", - "summary": "The number of items to return in the next page.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "number", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "after", - "aliases": [], - "description": "The cursor to fetch the next results from.", - "summary": "The cursor to fetch the next results from.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "orderBy", - "aliases": [], - "description": "The field to order items by.", - "summary": "The field to order items by.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "enum": [ - "dtCreated" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "asc", - "aliases": [], - "description": "Whether to order items ascending.", - "summary": "Whether to order items ascending.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "desc", - "aliases": [], - "description": "Whether to order items descending.", - "summary": "Whether to order items descending.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "fields", - "aliases": [ - "F" - ], - "description": "The fields to include in the response.", - "summary": "The fields to include in the response.", - "required": false, - "collects": true, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "machine-id", - "aliases": [ - "m" - ], - "description": "The ID of the machine the event is for. If not specified, all events\nwill be returned.", - "summary": "The ID of the machine the event is for", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "name", - "aliases": [ - "n" - ], - "description": "Filter by name.", - "summary": "Filter by name.", - "required": false, - "collects": false, - "negatable": false, - "global": false, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "log-level", - "aliases": [ - "l" - ], - "description": "Enable debug logging.", - "summary": "Enable debug logging", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "enum": [ - "debug", - "info", - "warning", - "error", - "critical" - ], - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "json", - "aliases": [ - "j" - ], - "description": "Output JSON", - "summary": "Output JSON", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "api-key", - "aliases": [], - "description": "A Paperspace public API Key used for authenticating requests", - "summary": "A Paperspace public API Key used for authenticating requests", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "string", - "$schema": "http://json-schema.org/draft-07/schema#" - } - }, - { - "name": "help", - "aliases": [ - "h" - ], - "description": "Show help for a command", - "summary": "Show help for a command", - "required": false, - "collects": false, - "negatable": false, - "global": true, - "schema": { - "type": "boolean", - "default": false, - "$schema": "http://json-schema.org/draft-07/schema#" - } - } - ], - "commands": [] } ] }, @@ -13841,7 +18925,7 @@ "name": "up", "description": "This will upsert an app config and deploy your app to Paperspace. You can optionally \nspecify a path to a config file. If no config file is specified, the default\nconfig file paths will be tried.\n\nDeploy the app in the current directory.\n```\n$ pspace up\n```\n\nDeploy the app using a config file.\n```\n$ pspace up -c paperspace.json\n```\n\nDeploy an app in a different directory.\n```\n$ pspace up --cwd ../my-app\n```", "summary": "Deploy your app to Paperspace", - "usage": " pspace [flags]", + "usage": " pspace up [flags]", "flags": [ { "name": "config", @@ -13966,7 +19050,7 @@ "name": "upgrade", "description": "This command upgrades \u001b[1mpspace\u001b[22m to the latest version.\n\nIf you used a package manager like `brew` to install `pspace`, \nyou should use that to upgrade in order to avoid potential permissions \nissues. For example, for `brew` you can upgrade by running:\n```\nbrew upgrade pspace\n```\n\nIf you installed `pspace` using the install script, you can upgrade by\nrunning:\n```\npspace upgrade\n```", "summary": "Upgrade \u001b[1mpspace\u001b[22m to the latest version.", - "usage": " pspace [flags]", + "usage": " pspace upgrade [flags]", "flags": [ { "name": "log-level", @@ -14045,7 +19129,7 @@ "name": "version", "description": "Shows version information command, including version number and build date.", "summary": "Show version information", - "usage": " pspace [flags]", + "usage": " pspace version [flags]", "flags": [ { "name": "log-level", diff --git a/.assets/pspace/autoscaling-group/autoscaling-group.md b/.assets/pspace/autoscaling-group/autoscaling-group.md new file mode 100644 index 0000000..692d5d9 --- /dev/null +++ b/.assets/pspace/autoscaling-group/autoscaling-group.md @@ -0,0 +1,37 @@ +Manage your autoscaling groups. Autoscaling groups enable using the Kubernetes +cluster-autoscaler to automatically scale your cluster. You can also autoscaling +groups as a primitive for your own autoscaler. + +### Usage + +``` +pspace autoscaling-group [command] +pspace autoscaling-group [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------------- | +| `create` | Create an autoscaling group. | +| `delete` | Delete an autoscaling group from a team. | +| `get` | Get an autoscaling group from a team. | +| `help` | Show help for a autoscaling-group command | +| `list` | List autoscaling groups in your team. | + +Pick a subset of fields to display: + +```` +pspace autoscaling-group list -F name -F dtCreated +``` | +| `update` | Update an autoscaling group. | +```` diff --git a/.assets/pspace/autoscaling-group/create.md b/.assets/pspace/autoscaling-group/create.md new file mode 100644 index 0000000..585e9bf --- /dev/null +++ b/.assets/pspace/autoscaling-group/create.md @@ -0,0 +1,26 @@ +Create an autoscaling group. + +### Usage + +``` +pspace autoscaling-group create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the autoscaling group | true | +| `cluster-id` | | The ID of the cluster | true | +| `machine-type` | | The machine type for the autoscaling group | true | +| `network-id` | | The ID of the network for the autoscaling group | true | +| `template-id` | | The ID of the template for the autoscaling group | true | +| `startup-script-id` | | The ID of the startup script for the autoscaling group | true | +| `max` | | The maximum number of active machines in the autoscaling group | true | +| `min` | | The minimum number of active machines in the autoscaling group | true | +| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/delete.md b/.assets/pspace/autoscaling-group/delete.md new file mode 100644 index 0000000..abf3102 --- /dev/null +++ b/.assets/pspace/autoscaling-group/delete.md @@ -0,0 +1,17 @@ +Delete an autoscaling group from a team. + +### Usage + +``` +pspace autoscaling-group delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/get.md b/.assets/pspace/autoscaling-group/get.md new file mode 100644 index 0000000..6714683 --- /dev/null +++ b/.assets/pspace/autoscaling-group/get.md @@ -0,0 +1,17 @@ +Get an autoscaling group from a team. + +### Usage + +``` +pspace autoscaling-group get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/list.md b/.assets/pspace/autoscaling-group/list.md new file mode 100644 index 0000000..155f296 --- /dev/null +++ b/.assets/pspace/autoscaling-group/list.md @@ -0,0 +1,30 @@ +List autoscaling groups in your team. + +Pick a subset of fields to display: + +``` +pspace autoscaling-group list -F name -F dtCreated +``` + +### Usage + +``` +pspace autoscaling-group list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `cluster-id` | | Filter by cluster ID. | false | +| `machine-type` | | Filter by machine type. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/autoscaling-group/update.md b/.assets/pspace/autoscaling-group/update.md new file mode 100644 index 0000000..fce5232 --- /dev/null +++ b/.assets/pspace/autoscaling-group/update.md @@ -0,0 +1,27 @@ +Update an autoscaling group. + +### Usage + +``` +pspace autoscaling-group update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------- | ------- | -------------------------------------------------------------------------- | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the autoscaling group | false | +| `cluster-id` | | The ID of the cluster | false | +| `machine-type` | | The machine type for the autoscaling group | false | +| `network-id` | | The ID of the network for the autoscaling group | false | +| `template-id` | | The ID of the template for the autoscaling group | false | +| `startup-script-id` | | The ID of the startup script for the autoscaling group | false | +| `max` | | The maximum number of active machines in the autoscaling group | false | +| `min` | | The minimum number of active machines in the autoscaling group | false | +| `provisioning-timeout` | | The timeout for provisioning machines in the autoscaling group, in minutes | false | +| `current` | | The desired number of active machines in the autoscaling group | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion/bash.md b/.assets/pspace/completion/bash.md new file mode 100644 index 0000000..b2ada56 --- /dev/null +++ b/.assets/pspace/completion/bash.md @@ -0,0 +1,41 @@ +Generate the autocompletion script for the bash shell. + +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. + +To load completions in your current shell session: + +``` +$ source <(pspace completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: + +``` +$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion bash [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion/completion.md b/.assets/pspace/completion/completion.md new file mode 100644 index 0000000..6cabf78 --- /dev/null +++ b/.assets/pspace/completion/completion.md @@ -0,0 +1,95 @@ +Generate an autocompletion script for pspace in the specified shell. See each +sub-command's help for details on how to use the generated script. + +### Usage + +``` +pspace completion [command] +pspace completion [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------------------------ | +| `bash` | Generate the autocompletion script for the bash shell. | + +This script depends on the `bash-completion` package. If it is not installed +already, you can install it via your OS's package manager. + +To load completions in your current shell session: + +``` +$ source <(pspace completion bash bash) +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion bash bash > /etc/bash_completion.d/pspace +``` + +macOS: + +``` +$ pspace completion bash bash > /usr/local/etc/bash_completion.d/pspace +``` + +You will need to start a new shell for this setup to take effect. | | `fish` | +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + +``` +$ pspace completion fish fish | source +``` + +To load completions for every new session, execute once: + +``` +$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. | | `help` | +Show help for a completion command | | `zsh` | Generate the autocompletion +script for the zsh shell. + +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: + +``` +$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: + +``` +$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. | diff --git a/.assets/pspace/completion/fish.md b/.assets/pspace/completion/fish.md new file mode 100644 index 0000000..faead47 --- /dev/null +++ b/.assets/pspace/completion/fish.md @@ -0,0 +1,31 @@ +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: + +``` +$ pspace completion fish fish | source +``` + +To load completions for every new session, execute once: + +``` +$ pspace completion fish fish > ~/.config/fish/completions/pspace.fish +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion fish [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `no-descriptions` | | Disable completion descriptions | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/completion/zsh.md b/.assets/pspace/completion/zsh.md new file mode 100644 index 0000000..cecdb27 --- /dev/null +++ b/.assets/pspace/completion/zsh.md @@ -0,0 +1,46 @@ +Generate the autocompletion script for the zsh shell. + +If shell completion is not already enabled in your environment you will need to +enable it. You can execute the following once: + +``` +$ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` + +To load completions for every new session, execute once: + +Linux: + +``` +$ pspace completion zsh zsh > "${fpath[1]}/_pspace" +``` + +macOS: + +``` +$ pspace completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace +``` + +Oh My Zsh: + +``` +$ pspace completion zsh zsh > ~/.oh-my-zsh/completions/_pspace +``` + +You will need to start a new shell for this setup to take effect. + +### Usage + +``` +pspace completion zsh [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `no-descriptions` | | Disable completion descriptions | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config/config.md b/.assets/pspace/config/config.md new file mode 100644 index 0000000..8777cef --- /dev/null +++ b/.assets/pspace/config/config.md @@ -0,0 +1,44 @@ +This command manages your Paperspace configuration. You can use it to set, get, +and delete configuration values. Running this command without any subcommands +will print your current configuration. + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: + +``` +pspace config set team "my-team" +``` + +### Usage + +``` +pspace config [command] +pspace config [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| -------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `delete` | Delete a configuration value. | +| `get` | This command gets a configuration value. You can pass a key to get a specific | +| value, or you can pass no arguments to get all configuration values. | | + +For example, to get the current team run: + +```` +pspace config get team +``` | +| `help` | Show help for a config command | +| `set` | Set a configuration value. | +```` diff --git a/.assets/pspace/config/delete.md b/.assets/pspace/config/delete.md new file mode 100644 index 0000000..c48556d --- /dev/null +++ b/.assets/pspace/config/delete.md @@ -0,0 +1,16 @@ +Delete a configuration value. + +### Usage + +``` +pspace config delete [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config/get.md b/.assets/pspace/config/get.md new file mode 100644 index 0000000..aced795 --- /dev/null +++ b/.assets/pspace/config/get.md @@ -0,0 +1,23 @@ +This command gets a configuration value. You can pass a key to get a specific +value, or you can pass no arguments to get all configuration values. + +For example, to get the current team run: + +``` +pspace config get team +``` + +### Usage + +``` +pspace config get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/config/set.md b/.assets/pspace/config/set.md new file mode 100644 index 0000000..7499101 --- /dev/null +++ b/.assets/pspace/config/set.md @@ -0,0 +1,16 @@ +Set a configuration value. + +### Usage + +``` +pspace config set [arguments] [arguments...] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/console.md b/.assets/pspace/console.md new file mode 100644 index 0000000..3bc9af7 --- /dev/null +++ b/.assets/pspace/console.md @@ -0,0 +1,16 @@ +This command opens the Paperspace web console in your browser. + +### Usage + +``` +pspace console [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/create.md b/.assets/pspace/custom-template/create.md new file mode 100644 index 0000000..0ae3b78 --- /dev/null +++ b/.assets/pspace/custom-template/create.md @@ -0,0 +1,19 @@ +Create a custom template from a machine. + +### Usage + +``` +pspace custom-template create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the custom template | true | +| `machine-id` | m | The ID of the machine to create a custom template from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/custom-template.md b/.assets/pspace/custom-template/custom-template.md new file mode 100644 index 0000000..fc73db2 --- /dev/null +++ b/.assets/pspace/custom-template/custom-template.md @@ -0,0 +1,38 @@ +Manage your custom templates. Custom templates are a backup of your machine's +disk. They can be used to create additional machines. You can use them to +prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. + +### Usage + +``` +pspace custom-template [command] +pspace custom-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------------------------- | +| `create` | Create a custom template from a machine. | +| `delete` | Delete a custom template from a team. | +| `get` | Get a custom template from a team. | +| `help` | Show help for a custom-template command | +| `list` | List custom templates in your team. | + +Pick a subset of fields to display: + +```` +pspace custom-template list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/custom-template/delete.md b/.assets/pspace/custom-template/delete.md new file mode 100644 index 0000000..4696c75 --- /dev/null +++ b/.assets/pspace/custom-template/delete.md @@ -0,0 +1,17 @@ +Delete a custom template from a team. + +### Usage + +``` +pspace custom-template delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/get.md b/.assets/pspace/custom-template/get.md new file mode 100644 index 0000000..d174194 --- /dev/null +++ b/.assets/pspace/custom-template/get.md @@ -0,0 +1,17 @@ +Get a custom template from a team. + +### Usage + +``` +pspace custom-template get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/custom-template/list.md b/.assets/pspace/custom-template/list.md new file mode 100644 index 0000000..fb9e01f --- /dev/null +++ b/.assets/pspace/custom-template/list.md @@ -0,0 +1,31 @@ +List custom templates in your team. + +Pick a subset of fields to display: + +``` +pspace custom-template list -F name -F dtModified +``` + +### Usage + +``` +pspace custom-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/create.md b/.assets/pspace/dataset/create.md new file mode 100644 index 0000000..c18285a --- /dev/null +++ b/.assets/pspace/dataset/create.md @@ -0,0 +1,21 @@ +Create a dataset. + +### Usage + +``` +pspace dataset create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the dataset | true | +| `description` | | The description of the dataset | false | +| `storage-provider-id` | | The ID of the storage provider to use for the dataset | false | +| `is-public` | | Whether the dataset is public | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/dataset.md b/.assets/pspace/dataset/dataset.md new file mode 100644 index 0000000..21eb311 --- /dev/null +++ b/.assets/pspace/dataset/dataset.md @@ -0,0 +1,40 @@ +Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. + +### Usage + +``` +pspace dataset [command] +pspace dataset [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------------------------- | +| `create` | Create a dataset. | +| `delete` | Delete a dataset from a team. | +| `get` | Get a dataset from a team. | +| `help` | Show help for a dataset command | +| `list` | List datasets in your team or project. | + +Pick a subset of fields to display: + +```` +pspace dataset list -F name -F dtModified +``` | +| `update` | Update a dataset in a project or team. | +| `versions` | Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. | +```` diff --git a/.assets/pspace/dataset/delete.md b/.assets/pspace/dataset/delete.md new file mode 100644 index 0000000..4d8127b --- /dev/null +++ b/.assets/pspace/dataset/delete.md @@ -0,0 +1,17 @@ +Delete a dataset from a team. + +### Usage + +``` +pspace dataset delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/get.md b/.assets/pspace/dataset/get.md new file mode 100644 index 0000000..0d59800 --- /dev/null +++ b/.assets/pspace/dataset/get.md @@ -0,0 +1,17 @@ +Get a dataset from a team. + +### Usage + +``` +pspace dataset get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/list.md b/.assets/pspace/dataset/list.md new file mode 100644 index 0000000..d8dd614 --- /dev/null +++ b/.assets/pspace/dataset/list.md @@ -0,0 +1,28 @@ +List datasets in your team or project. + +Pick a subset of fields to display: + +``` +pspace dataset list -F name -F dtModified +``` + +### Usage + +``` +pspace dataset list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/update.md b/.assets/pspace/dataset/update.md new file mode 100644 index 0000000..cfb5855 --- /dev/null +++ b/.assets/pspace/dataset/update.md @@ -0,0 +1,19 @@ +Update a dataset in a project or team. + +### Usage + +``` +pspace dataset update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the dataset | true | +| `description` | | The description of the dataset | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/create.md b/.assets/pspace/dataset/versions/create.md new file mode 100644 index 0000000..63716c3 --- /dev/null +++ b/.assets/pspace/dataset/versions/create.md @@ -0,0 +1,19 @@ +Create a dataset version. This command will prompt you for an ID if you don't +provide one. + +### Usage + +``` +pspace dataset versions create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `tags` | | The tags for the version, comma-delimited | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/delete.md b/.assets/pspace/dataset/versions/delete.md new file mode 100644 index 0000000..2740ff4 --- /dev/null +++ b/.assets/pspace/dataset/versions/delete.md @@ -0,0 +1,18 @@ +Delete a dataset version from a team. This command will prompt you for an ID if +you don't provide one. + +### Usage + +``` +pspace dataset versions delete [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/get.md b/.assets/pspace/dataset/versions/get.md new file mode 100644 index 0000000..d9e84a4 --- /dev/null +++ b/.assets/pspace/dataset/versions/get.md @@ -0,0 +1,18 @@ +Get a dataset version from a team. This command will prompt you for an ID if you +don't provide one. + +### Usage + +``` +pspace dataset versions get [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/list.md b/.assets/pspace/dataset/versions/list.md new file mode 100644 index 0000000..8d1fd63 --- /dev/null +++ b/.assets/pspace/dataset/versions/list.md @@ -0,0 +1,28 @@ +List dataset versions in your team or project. + +Pick a subset of fields to display: + +``` +pspace dataset versions list -F name -F dtModified +``` + +### Usage + +``` +pspace dataset versions list [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/update.md b/.assets/pspace/dataset/versions/update.md new file mode 100644 index 0000000..0d47770 --- /dev/null +++ b/.assets/pspace/dataset/versions/update.md @@ -0,0 +1,19 @@ +Update a dataset version in a project or team. + +### Usage + +``` +pspace dataset versions update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `message` | m | The description of the dataset version | true | +| `tags` | | The tags for the version, comma-delimited | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/dataset/versions/versions.md b/.assets/pspace/dataset/versions/versions.md new file mode 100644 index 0000000..1dcee84 --- /dev/null +++ b/.assets/pspace/dataset/versions/versions.md @@ -0,0 +1,40 @@ +Manage your dataset versions. + +For more information, see https://docs.paperspace.com/storage/datasetVersions. + +### Usage + +``` +pspace dataset versions [command] +pspace dataset versions [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ------------------------- | ----------------------------------------------------------------------------- | +| `create` | Create a dataset version. This command will prompt you for an ID if you don't | +| provide one. | | +| `delete` | Delete a dataset version from a team. This command will prompt you for an ID | +| if you don't provide one. | | +| `get` | Get a dataset version from a team. This command will prompt you for an ID | +| if you don't provide one. | | +| `help` | Show help for a versions command | +| `list` | List dataset versions in your team or project. | + +Pick a subset of fields to display: + +```` +pspace dataset versions list -F name -F dtModified +``` | +| `update` | Update a dataset version in a project or team. | +```` diff --git a/.assets/pspace/deployment/delete.md b/.assets/pspace/deployment/delete.md new file mode 100644 index 0000000..c7e4bab --- /dev/null +++ b/.assets/pspace/deployment/delete.md @@ -0,0 +1,21 @@ +Delete a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. + +``` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` + +### Usage + +``` +pspace deployment delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/deployment.md b/.assets/pspace/deployment/deployment.md new file mode 100644 index 0000000..a163eaa --- /dev/null +++ b/.assets/pspace/deployment/deployment.md @@ -0,0 +1,79 @@ +Effortlessly deploy ML apps to Paperspace. + +### Usage + +``` +pspace deployment [command] +pspace deployment [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| --------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| `delete` | Delete a deployment by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the deployments you have access to. | | + +```` +pspace deployment delete 123e4567-e89b-12d3-a456-426614174000 +``` | +| `get` | Get a deployment by its ID. If you don't provide an ID, this command will +prompt you for one based on the deployments you have access to. +```` + +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 + +``` +Pick a subset of fields to display: +``` + +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name + +```| +| `help` | Show help for a deployment command | +| `list` | List deployments in your team. + +Pick a subset of fields to display: +``` + +pspace deployment list -F id -F name + +```| +| `up` | This will create a new deployment for your app or update it if it already exists. +You can optionally specify a path to a config file. If no config file is specified, +the default config file paths will be tried. + +Create a new deployment for the app in the current directory. +``` + +$ pspace deployment create + +``` +Create a new deployment using a config file. +``` + +$ pspace deployment create -c paperspace.json + +``` +Create a new deployment for an app in a different directory. +``` + +$ pspace deployment create --cwd ../my-app + +``` +Create a new deployment for an app in a specific project. +``` + +$ pspace deployment create --project-id 1234 + +```| +``` diff --git a/.assets/pspace/deployment/get.md b/.assets/pspace/deployment/get.md new file mode 100644 index 0000000..855fabc --- /dev/null +++ b/.assets/pspace/deployment/get.md @@ -0,0 +1,28 @@ +Get a deployment by its ID. If you don't provide an ID, this command will prompt +you for one based on the deployments you have access to. + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 +``` + +Pick a subset of fields to display: + +``` +pspace deployment get 123e4567-e89b-12d3-a456-426614174000 -F name +``` + +### Usage + +``` +pspace deployment get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/list.md b/.assets/pspace/deployment/list.md new file mode 100644 index 0000000..02723c4 --- /dev/null +++ b/.assets/pspace/deployment/list.md @@ -0,0 +1,28 @@ +List deployments in your team. + +Pick a subset of fields to display: + +``` +pspace deployment list -F id -F name +``` + +### Usage + +``` +pspace deployment list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/deployment/up.md b/.assets/pspace/deployment/up.md new file mode 100644 index 0000000..172c688 --- /dev/null +++ b/.assets/pspace/deployment/up.md @@ -0,0 +1,57 @@ +This will create a new deployment for your app or update it if it already +exists. You can optionally specify a path to a config file. If no config file is +specified, the default config file paths will be tried. + +Create a new deployment for the app in the current directory. + +``` +$ pspace deployment create +``` + +Create a new deployment using a config file. + +``` +$ pspace deployment create -c paperspace.json +``` + +Create a new deployment for an app in a different directory. + +``` +$ pspace deployment create --cwd ../my-app +``` + +Create a new deployment for an app in a specific project. + +``` +$ pspace deployment create --project-id 1234 +``` + +### Usage + +``` +pspace deployment up [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------- | ------- | ----------------------------------------------------------------------- | -------- | +| `config` | c | The path to the config file. Defaults to our default config file paths. | | + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | | `project-id` | p | The ID of the project to + deploy to. | false | | `cwd` | | The directory to deploy the app from. + Defaults to the current directory. | false | | `log-level` | l | Enable debug + logging. | false | | `json` | j | Output JSON | false | | `api-key` | | A + Paperspace public API Key used for authenticating requests | false | | `help` + | h | Show help for a command | false | diff --git a/.assets/pspace/docs.md b/.assets/pspace/docs.md new file mode 100644 index 0000000..554ed28 --- /dev/null +++ b/.assets/pspace/docs.md @@ -0,0 +1,21 @@ +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 + +``` +pspace docs [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/init.md b/.assets/pspace/init.md new file mode 100644 index 0000000..cd3df50 --- /dev/null +++ b/.assets/pspace/init.md @@ -0,0 +1,79 @@ +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 + +``` +pspace 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 | +```` diff --git a/.assets/pspace/login.md b/.assets/pspace/login.md new file mode 100644 index 0000000..c32fbf3 --- /dev/null +++ b/.assets/pspace/login.md @@ -0,0 +1,16 @@ +Log in to the CLI using your Paperspace API key or by opening the web console. + +### Usage + +``` +pspace login [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/logout.md b/.assets/pspace/logout.md new file mode 100644 index 0000000..00d0567 --- /dev/null +++ b/.assets/pspace/logout.md @@ -0,0 +1,17 @@ +Log out of the CLI for the current team, a specific team, or all teams. + +### Usage + +``` +pspace logout [arguments...] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `all` | a | Log out of all teams. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event/get.md b/.assets/pspace/machine-event/get.md new file mode 100644 index 0000000..bca1758 --- /dev/null +++ b/.assets/pspace/machine-event/get.md @@ -0,0 +1,17 @@ +Get a machine event from a team. + +### Usage + +``` +pspace machine-event get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event/list.md b/.assets/pspace/machine-event/list.md new file mode 100644 index 0000000..0d503d2 --- /dev/null +++ b/.assets/pspace/machine-event/list.md @@ -0,0 +1,30 @@ +List machine events in your team. + +Pick a subset of fields to display: + +``` +pspace machine-event list -F name -F dtModified +``` + +### Usage + +``` +pspace machine-event list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine-event/machine-event.md b/.assets/pspace/machine-event/machine-event.md new file mode 100644 index 0000000..fb9f130 --- /dev/null +++ b/.assets/pspace/machine-event/machine-event.md @@ -0,0 +1,37 @@ +Manage your machine events. Events are asynchronous tasks performed by our +system on your machines. Not all machine commands are asynchronous. For those +that are, a machine event will be returned which can be tracked using this +command. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` +pspace machine-event [command] +pspace machine-event [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------- | +| `get` | Get a machine event from a team. | +| `help` | Show help for a machine-event command | +| `list` | List machine events in your team. | + +Pick a subset of fields to display: + +```` +pspace machine-event list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/machine/create.md b/.assets/pspace/machine/create.md new file mode 100644 index 0000000..36bfc51 --- /dev/null +++ b/.assets/pspace/machine/create.md @@ -0,0 +1,38 @@ +Create a machine. + +### Usage + +``` +pspace machine create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the machine | true | +| `machine-type` | | The machine type to create | true | +| `template-id` | | The ID of the template to create the machine from | true | +| `network-id` | | The ID of the network to create the machine in | false | +| `region` | | The region to create the machine in | true | +| `disk-size` | | The size of the machine's disk | true | +| `public-ip-type` | | The public IP type. | false | +| `auto-snapshot-enabled` | | Whether to enable auto snapshots. | false | +| `auto-snapshot-frequency` | | The auto snapshot frequency. | false | +| `auto-snapshot-save-count` | | The number of auto snapshots to save. | false | +| `auto-shutdown-enabled` | | Whether to enable auto shutdown. | false | +| `auto-shutdown-timeout` | | The auto shutdown timeout in hours. | false | +| `auto-shutdown-force` | | Whether to force shutdown the machine. | false | +| `take-initial-snapshot` | | Whether to take an initial snapshot. | false | +| `restore-point-enabled` | | Whether to use initial snapshot as a restore point. | false | +| `restore-point-frequency` | | The restore point frequency. | false | +| `startup-script-id` | | The startup script ID. | false | +| `email-password` | | Whether to email the password. | false | +| `start-on-create` | | Whether to start the machine on creation. | false | +| `enable-nvlink` | | Whether to enable NVLink. | false | +| `accessor-ids` | | The accessors of the machine. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/delete.md b/.assets/pspace/machine/delete.md new file mode 100644 index 0000000..ae9af25 --- /dev/null +++ b/.assets/pspace/machine/delete.md @@ -0,0 +1,17 @@ +Delete a machine from a team. + +### Usage + +``` +pspace machine delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/get.md b/.assets/pspace/machine/get.md new file mode 100644 index 0000000..540067a --- /dev/null +++ b/.assets/pspace/machine/get.md @@ -0,0 +1,17 @@ +Get a machine from a team. + +### Usage + +``` +pspace machine get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/list.md b/.assets/pspace/machine/list.md new file mode 100644 index 0000000..c6a6338 --- /dev/null +++ b/.assets/pspace/machine/list.md @@ -0,0 +1,32 @@ +List machines in your team. + +Pick a subset of fields to display: + +``` +pspace machine list -F name -F dtModified +``` + +### Usage + +``` +pspace machine list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `agent-type` | a | Filter by agent type. | false | +| `machine-type` | m | Filter by machine type. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/machine.md b/.assets/pspace/machine/machine.md new file mode 100644 index 0000000..77f7623 --- /dev/null +++ b/.assets/pspace/machine/machine.md @@ -0,0 +1,40 @@ +Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. + +### Usage + +``` +pspace machine [command] +pspace machine [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------- | +| `create` | Create a machine. | +| `delete` | Delete a machine from a team. | +| `get` | Get a machine from a team. | +| `help` | Show help for a machine command | +| `list` | List machines in your team. | + +Pick a subset of fields to display: + +```` +pspace machine list -F name -F dtModified +``` | +| `restart` | Restart a machine from a team. | +| `start` | Start a machine from a team. | +| `stop` | Stop a machine from a team. | +| `update` | Update a machine's settings. | +```` diff --git a/.assets/pspace/machine/restart.md b/.assets/pspace/machine/restart.md new file mode 100644 index 0000000..de40f98 --- /dev/null +++ b/.assets/pspace/machine/restart.md @@ -0,0 +1,17 @@ +Restart a machine from a team. + +### Usage + +``` +pspace machine restart [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/start.md b/.assets/pspace/machine/start.md new file mode 100644 index 0000000..faa932f --- /dev/null +++ b/.assets/pspace/machine/start.md @@ -0,0 +1,17 @@ +Start a machine from a team. + +### Usage + +``` +pspace machine start [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/stop.md b/.assets/pspace/machine/stop.md new file mode 100644 index 0000000..18e36c2 --- /dev/null +++ b/.assets/pspace/machine/stop.md @@ -0,0 +1,17 @@ +Stop a machine from a team. + +### Usage + +``` +pspace machine stop [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/machine/update.md b/.assets/pspace/machine/update.md new file mode 100644 index 0000000..e916ce6 --- /dev/null +++ b/.assets/pspace/machine/update.md @@ -0,0 +1,31 @@ +Update a machine's settings. + +### Usage + +``` +pspace machine update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the machine | true | +| `machine-type` | | The machine type to update to | true | +| `network-id` | | The ID of the network to create the machine in | false | +| `disk-size` | | The size of the machine's disk | true | +| `public-ip-type` | | The public IP type. | false | +| `auto-snapshot-enabled` | | Whether to enable auto snapshots. | false | +| `auto-snapshot-frequency` | | The auto snapshot frequency. | false | +| `auto-snapshot-save-count` | | The number of auto snapshots to save. | false | +| `auto-shutdown-enabled` | | Whether to enable auto shutdown. | false | +| `auto-shutdown-timeout` | | The auto shutdown timeout in hours. | false | +| `auto-shutdown-force` | | Whether to force shutdown the machine. | false | +| `restore-point-enabled` | | Whether to enable a restore point. | false | +| `restore-point-frequency` | | The restore point frequency. | false | +| `restore-point-snapshot-id` | | The ID of the snapshot to use as a restore point. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/create.md b/.assets/pspace/model/create.md new file mode 100644 index 0000000..ed94b61 --- /dev/null +++ b/.assets/pspace/model/create.md @@ -0,0 +1,23 @@ +Create a new model. This command will prompt you for a name if you don't provide +one. + +### Usage + +``` +pspace model create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| --------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the model | false | +| `description` | d | The description of the model | false | +| `is-public` | | Whether the model is public | false | +| `storage-provider-id` | s | The ID of the storage provider to use for the model | false | +| `project-id` | p | The ID of the project to create the model in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/delete.md b/.assets/pspace/model/delete.md new file mode 100644 index 0000000..484ffeb --- /dev/null +++ b/.assets/pspace/model/delete.md @@ -0,0 +1,17 @@ +Delete a model from a team. + +### Usage + +``` +pspace model delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/get.md b/.assets/pspace/model/get.md new file mode 100644 index 0000000..e451c39 --- /dev/null +++ b/.assets/pspace/model/get.md @@ -0,0 +1,17 @@ +Get a model from a team. + +### Usage + +``` +pspace model get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/list.md b/.assets/pspace/model/list.md new file mode 100644 index 0000000..6cd98a6 --- /dev/null +++ b/.assets/pspace/model/list.md @@ -0,0 +1,28 @@ +List models in your team. + +Pick a subset of fields to display: + +``` +pspace model list -F name -F dtModified +``` + +### Usage + +``` +pspace model list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/model/model.md b/.assets/pspace/model/model.md new file mode 100644 index 0000000..63e49d0 --- /dev/null +++ b/.assets/pspace/model/model.md @@ -0,0 +1,37 @@ +Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. + +### Usage + +``` +pspace model [command] +pspace model [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ------------ | ------------------------------------------------------------------------ | +| `create` | Create a new model. This command will prompt you for a name if you don't | +| provide one. | | +| `delete` | Delete a model from a team. | +| `get` | Get a model from a team. | +| `help` | Show help for a model command | +| `list` | List models in your team. | + +Pick a subset of fields to display: + +```` +pspace model list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/os-template/list.md b/.assets/pspace/os-template/list.md new file mode 100644 index 0000000..73eb05d --- /dev/null +++ b/.assets/pspace/os-template/list.md @@ -0,0 +1,29 @@ +List OS templates. + +Pick a subset of fields to display: + +``` +pspace os-template list -F name +``` + +### Usage + +``` +pspace os-template list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/os-template/os-template.md b/.assets/pspace/os-template/os-template.md new file mode 100644 index 0000000..f7ef7fa --- /dev/null +++ b/.assets/pspace/os-template/os-template.md @@ -0,0 +1,34 @@ +List OS templates. OS templates are pre-configured virtual machines that you can +use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. + +### Usage + +``` +pspace os-template [command] +pspace os-template [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------- | +| `help` | Show help for a os-template command | +| `list` | List OS templates. | + +Pick a subset of fields to display: + +```` +pspace os-template list -F name +``` | +```` diff --git a/.assets/pspace/private-network/create.md b/.assets/pspace/private-network/create.md new file mode 100644 index 0000000..0e47206 --- /dev/null +++ b/.assets/pspace/private-network/create.md @@ -0,0 +1,19 @@ +Create a private network. + +### Usage + +``` +pspace private-network create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the private network | true | +| `region` | | The region to create the private network in | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/delete.md b/.assets/pspace/private-network/delete.md new file mode 100644 index 0000000..07daa54 --- /dev/null +++ b/.assets/pspace/private-network/delete.md @@ -0,0 +1,17 @@ +Delete a private network from a team. + +### Usage + +``` +pspace private-network delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/get.md b/.assets/pspace/private-network/get.md new file mode 100644 index 0000000..58b89b1 --- /dev/null +++ b/.assets/pspace/private-network/get.md @@ -0,0 +1,17 @@ +Get a private network from a team. + +### Usage + +``` +pspace private-network get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/list.md b/.assets/pspace/private-network/list.md new file mode 100644 index 0000000..e4e019c --- /dev/null +++ b/.assets/pspace/private-network/list.md @@ -0,0 +1,30 @@ +List private networks in your team. + +Pick a subset of fields to display: + +``` +pspace private-network list -F name -F dtModified +``` + +### Usage + +``` +pspace private-network list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/private-network/private-network.md b/.assets/pspace/private-network/private-network.md new file mode 100644 index 0000000..7e27262 --- /dev/null +++ b/.assets/pspace/private-network/private-network.md @@ -0,0 +1,39 @@ +Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see +https://docs.paperspace.com/networking/private-networks. + +### Usage + +``` +pspace private-network [command] +pspace private-network [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------- | +| `create` | Create a private network. | +| `delete` | Delete a private network from a team. | +| `get` | Get a private network from a team. | +| `help` | Show help for a private-network command | +| `list` | List private networks in your team. | + +Pick a subset of fields to display: + +```` +pspace private-network list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/project/create.md b/.assets/pspace/project/create.md new file mode 100644 index 0000000..a8b7105 --- /dev/null +++ b/.assets/pspace/project/create.md @@ -0,0 +1,18 @@ +Create a new project. This command will prompt you for a name if you don't +provide one. + +### Usage + +``` +pspace project create [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/delete.md b/.assets/pspace/project/delete.md new file mode 100644 index 0000000..c270de1 --- /dev/null +++ b/.assets/pspace/project/delete.md @@ -0,0 +1,18 @@ +Delete a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. + +### Usage + +``` +pspace project delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/get.md b/.assets/pspace/project/get.md new file mode 100644 index 0000000..863b4b2 --- /dev/null +++ b/.assets/pspace/project/get.md @@ -0,0 +1,18 @@ +Get a project by its ID. If you don't provide an ID, this command will prompt +you for one based on the projects you have access to. + +### Usage + +``` +pspace project get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/link.md b/.assets/pspace/project/link.md new file mode 100644 index 0000000..4a2d38a --- /dev/null +++ b/.assets/pspace/project/link.md @@ -0,0 +1,37 @@ +This will link a remote project to a local directory. Commands that depend on a +project ID will use the project ID of the linked project when communicating with +the Paperspace API. + +Link a project to the current directory. + +``` +$ pspace link +``` + +Link a project to a different directory. + +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. + +``` +$ pspace link pzwf2g05ubegj +``` + +### Usage + +``` +pspace project link [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------------------ | -------- | +| `cwd` | | The directory to link the project to. Defaults to the current directory. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/list.md b/.assets/pspace/project/list.md new file mode 100644 index 0000000..528c7db --- /dev/null +++ b/.assets/pspace/project/list.md @@ -0,0 +1,28 @@ +List projects in your team. + +Pick a subset of fields to display: + +``` +pspace project list -F id -F name -F dtCreated +``` + +### Usage + +``` +pspace project list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/project/project.md b/.assets/pspace/project/project.md new file mode 100644 index 0000000..634c53f --- /dev/null +++ b/.assets/pspace/project/project.md @@ -0,0 +1,67 @@ +Manage your Paperspace projects. + +### Usage + +``` +pspace project [command] +pspace project [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| -------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `create` | Create a new project. This command will prompt you for a name if you don't | +| provide one. | | +| `delete` | Delete a project by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the projects you have access to. | | +| `get` | Get a project by its ID. If you don't provide an ID, this command will | +| prompt you for one based on the projects you have access to. | | +| `help` | Show help for a project command | +| `link` | This will link a remote project to a local directory. Commands that | +| depend on a project ID will use the project ID of the linked project | | +| when communicating with the Paperspace API. | | + +Link a project to the current directory. + +``` +$ pspace link +``` + +Link a project to a different directory. + +``` +$ pspace link --cwd ../my-app +``` + +Link a project and specify a project ID. + +```` +$ pspace link pzwf2g05ubegj +``` | +| `list` | List projects in your team. + +Pick a subset of fields to display: +```` + +pspace project list -F id -F name -F dtCreated + +```| +| `update` | Update an existing project. + +Example: +``` + +pspace project update psukfyemho7 --name my-cool-project + +```| +``` diff --git a/.assets/pspace/project/update.md b/.assets/pspace/project/update.md new file mode 100644 index 0000000..e8c636a --- /dev/null +++ b/.assets/pspace/project/update.md @@ -0,0 +1,24 @@ +Update an existing project. + +Example: + +``` +pspace project update psukfyemho7 --name my-cool-project +``` + +### Usage + +``` +pspace project update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `name` | | The new name for the project. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/pspace.md b/.assets/pspace/pspace.md new file mode 100644 index 0000000..01ee358 --- /dev/null +++ b/.assets/pspace/pspace.md @@ -0,0 +1,181 @@ +A CLI for using the Paperspace API. + +It allows you to authenticate, launch deployments, do logging, and more. + +- Deploy an ML app with the `deployment` command +- View a deployed app with the `deployment open` command +- Check the status of a deployment with the `deployment status` command + +Read the full documentation at: https://docs.paperspace.com/ + +### Usage + +``` +pspace [command] +pspace [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | +| `autoscaling-group` | Manage your autoscaling groups. Autoscaling groups enable using | +| the Kubernetes cluster-autoscaler to automatically scale your cluster. | | +| You can also autoscaling groups as a primitive for your own autoscaler. | | +| `completion` | Generate an autocompletion script for pspace in the specified shell. | +| See each sub-command's help for details on how to use the generated script. | | +| `config` | This command manages your Paperspace configuration. You can use it to set, get, and | +| delete configuration values. Running this command without any subcommands will print | | +| your current configuration. | | + +Your configuration is stored in a TOML file at `~/.paperspace/config.toml`. + +For example, to set the current team, run: + +```` +pspace config set team "my-team" +``` | +| `console` | This command opens the Paperspace web console in your browser. | +| `custom-template` | Manage your custom templates. Custom templates are a backup of your +machine's disk. They can be used to create additional machines. You +can use them to prepopulate a machine with your desired software stack. + +For more information, see https://docs.paperspace.com/compute/custom-templates. | +| `dataset` | Manage your datasets. + +For more information, see https://docs.paperspace.com/storage/datasets. | +| `deployment` | Effortlessly deploy ML apps to Paperspace. | +| `docs` | This command opens the Paperspace documentation in your browser. +You can optionally pass an argument that will take you to a specific +docs page. + +Valid pages are: + - `d`, `deployment` | +| `help` | Show help for a pspace command | +| `init` | Create a new Paperspace app. This will create a new directory with a +default app structure. You can optionally specify a name for the app +and a template to use. If no template is specified, the default +template will be used. + +Create a new app in the current directory. +```` + +$ pspace init + +``` +Create a new app named "my-app" relative to the current directory. +``` + +$ pspace init my-app + +``` +Create a new app named "my-app" relative to the current directory using +a template from the Paperspace GitHub organization. +``` + +$ pspace init my-app -t Paperspace/gradio-demo + +```| +| `login` | Log in to the CLI using your Paperspace API key or by opening the web console. | +| `logout` | Log out of the CLI for the current team, a specific team, or all teams. | +| `machine` | Manage your Paperspace machines. + +For more information, see https://docs.paperspace.com/machines. | +| `machine-event` | Manage your machine events. Events are asynchronous tasks performed by our system on your machines. +Not all machine commands are asynchronous. For those that are, a machine event will be returned +which can be tracked using this command. + +For more information, see https://docs.paperspace.com/machines. | +| `model` | Manage your Paperspace models. + +For more information, see https://docs.paperspace.com/deploying/models. | +| `os-template` | List OS templates. OS templates are pre-configured virtual machines that +you can use to create a new machine. + +For more information, see https://docs.paperspace.com/compute/os-templates. | +| `private-network` | Manage your private networks. Private networks are logically isolated networks +for your machines and shared drives. They can also be used for site-to-site VPNs +and direct connections to your on-premise network. + +For more information, see https://docs.paperspace.com/networking/private-networks. | +| `project` | Manage your Paperspace projects. | +| `public-ip` | Manage your public IPs. Public IP addresses allow your compute machines to be reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. | +| `secret` | Manage your Paperspace secrets. Secrets are used to store sensitive +information such as API keys, passwords, and other credentials. Secrets +can be safely injected into workloads as environment variables. An environment +variable that uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. | +| `shared-drive` | Manage your shared drives. Shared drives are used to centralize data +used by your team. Shared drives can be mounted on any Paperspace machine +in the same private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. | +| `signup` | This command opens the Paperspace signup page in your browser. | +| `snapshot` | Manage your snapshots. Snapshots are copies of your machine's disk at a point in time. +They can be used to restore the machine to its previous state. Using snapshots is recommended +before taking any action that could affect the usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. | +| `startup-script` | Manage your startup scripts. Startup scripts allow you to configure a machine +on first boot or on every boot. | +| `storage-provider` | Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. | +| `up` | This will upsert an app config and deploy your app to Paperspace. You can optionally +specify a path to a config file. If no config file is specified, the default +config file paths will be tried. + +Deploy the app in the current directory. +``` + +$ pspace up + +``` +Deploy the app using a config file. +``` + +$ pspace up -c paperspace.json + +``` +Deploy an app in a different directory. +``` + +$ pspace up --cwd ../my-app + +```| +| `upgrade` | This command upgrades pspace to the latest version. + +If you used a package manager like `brew` to install `pspace`, +you should use that to upgrade in order to avoid potential permissions +issues. For example, for `brew` you can upgrade by running: +``` + +brew upgrade pspace + +``` +If you installed `pspace` using the install script, you can upgrade by +running: +``` + +pspace upgrade + +```| +| `version` | Shows version information command, including version number and build date. | +``` diff --git a/.assets/pspace/public-ip/assign.md b/.assets/pspace/public-ip/assign.md new file mode 100644 index 0000000..5c1e190 --- /dev/null +++ b/.assets/pspace/public-ip/assign.md @@ -0,0 +1,18 @@ +Assign a public IP to a machine. + +### Usage + +``` +pspace public-ip assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine to assign the public IP to | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/claim.md b/.assets/pspace/public-ip/claim.md new file mode 100644 index 0000000..6c89fb3 --- /dev/null +++ b/.assets/pspace/public-ip/claim.md @@ -0,0 +1,18 @@ +Claim a public IP for a team. + +### Usage + +``` +pspace public-ip claim [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `region` | r | The region to claim the public IP in | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/list.md b/.assets/pspace/public-ip/list.md new file mode 100644 index 0000000..07d8f9e --- /dev/null +++ b/.assets/pspace/public-ip/list.md @@ -0,0 +1,29 @@ +List public IPs in your team or project. + +Pick a subset of fields to display: + +``` +pspace public-ip list -F name -F dtModified +``` + +### Usage + +``` +pspace public-ip list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/public-ip/public-ip.md b/.assets/pspace/public-ip/public-ip.md new file mode 100644 index 0000000..e57b151 --- /dev/null +++ b/.assets/pspace/public-ip/public-ip.md @@ -0,0 +1,37 @@ +Manage your public IPs. Public IP addresses allow your compute machines to be +reachable over the internet. + +For more information, see https://docs.paperspace.com/networking/public-ips. + +### Usage + +``` +pspace public-ip [command] +pspace public-ip [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ---------------------------------------- | +| `assign` | Assign a public IP to a machine. | +| `claim` | Claim a public IP for a team. | +| `help` | Show help for a public-ip command | +| `list` | List public IPs in your team or project. | + +Pick a subset of fields to display: + +```` +pspace public-ip list -F name -F dtModified +``` | +| `release` | Release a public IP from a team. This will unassign it from its assigned machine, if any. | +```` diff --git a/.assets/pspace/public-ip/release.md b/.assets/pspace/public-ip/release.md new file mode 100644 index 0000000..da4e4d0 --- /dev/null +++ b/.assets/pspace/public-ip/release.md @@ -0,0 +1,18 @@ +Release a public IP from a team. This will unassign it from its assigned +machine, if any. + +### Usage + +``` +pspace public-ip release [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/create.md b/.assets/pspace/secret/create.md new file mode 100644 index 0000000..b942578 --- /dev/null +++ b/.assets/pspace/secret/create.md @@ -0,0 +1,24 @@ +Create a secret in a project or team. + +### Usage + +``` +pspace secret create [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/delete.md b/.assets/pspace/secret/delete.md new file mode 100644 index 0000000..1815f7c --- /dev/null +++ b/.assets/pspace/secret/delete.md @@ -0,0 +1,24 @@ +Delete a secret from a project or team. + +### Usage + +``` +pspace secret delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/get.md b/.assets/pspace/secret/get.md new file mode 100644 index 0000000..262d9ec --- /dev/null +++ b/.assets/pspace/secret/get.md @@ -0,0 +1,25 @@ +Get a secret from a project or team. + +### Usage + +``` +pspace secret get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/list.md b/.assets/pspace/secret/list.md new file mode 100644 index 0000000..bac3ca3 --- /dev/null +++ b/.assets/pspace/secret/list.md @@ -0,0 +1,36 @@ +List secrets in your team or project. + +Pick a subset of fields to display: + +``` +pspace secret list -F name -F dtModified +``` + +### Usage + +``` +pspace secret list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/secret/secret.md b/.assets/pspace/secret/secret.md new file mode 100644 index 0000000..8ad12ab --- /dev/null +++ b/.assets/pspace/secret/secret.md @@ -0,0 +1,45 @@ +Manage your Paperspace secrets. Secrets are used to store sensitive information +such as API keys, passwords, and other credentials. Secrets can be safely +injected into workloads as environment variables. An environment variable that +uses a Secret will not reveal the contents of the secret itself. + +Secrets can be created at the following levels: + +- Project (default): these secrets are applied to all resources in a project +- Global: these secrets can be applied to all resources on your current team + +For more information, see https://docs.paperspace.com/secrets. + +### Usage + +``` +pspace secret [command] +pspace secret [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------- | +| `create` | Create a secret in a project or team. | +| `delete` | Delete a secret from a project or team. | +| `get` | Get a secret from a project or team. | +| `help` | Show help for a secret command | +| `list` | List secrets in your team or project. | + +Pick a subset of fields to display: + +```` +pspace secret list -F name -F dtModified +``` | +| `update` | Update a secret in a project or team. | +```` diff --git a/.assets/pspace/secret/update.md b/.assets/pspace/secret/update.md new file mode 100644 index 0000000..edf4a7f --- /dev/null +++ b/.assets/pspace/secret/update.md @@ -0,0 +1,24 @@ +Update a secret in a project or team. + +### Usage + +``` +pspace secret update [arguments] [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ---------------------------------------------------------------------- | ------- | ------------------------------------------------------------- | -------- | +| `project-id` | p | The ID of the project the secret is in. If not specified, the | | +| secret will be created in the project linked to your current working | | | | +| directory. If you are not in a project directory, you will be prompted | | | | +| to select a project. | false | | | +| `global` | g | Manage a secret that is available to the entire team you are | | +| currently logged into. By default, secrets are only available to | | | | +| a project. | false | | | +| `cwd` | | The directory to create the secret in | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/create.md b/.assets/pspace/shared-drive/create.md new file mode 100644 index 0000000..e8beea9 --- /dev/null +++ b/.assets/pspace/shared-drive/create.md @@ -0,0 +1,21 @@ +Create a shared drive. + +### Usage + +``` +pspace shared-drive create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the shared drive | true | +| `network-id` | | The ID of the network to create the shared drive in | true | +| `region` | | The region to create the shared drive in | true | +| `size` | | The size of the shared drive | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/delete.md b/.assets/pspace/shared-drive/delete.md new file mode 100644 index 0000000..0592cb1 --- /dev/null +++ b/.assets/pspace/shared-drive/delete.md @@ -0,0 +1,17 @@ +Delete a shared drive from a team. + +### Usage + +``` +pspace shared-drive delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/get.md b/.assets/pspace/shared-drive/get.md new file mode 100644 index 0000000..a999983 --- /dev/null +++ b/.assets/pspace/shared-drive/get.md @@ -0,0 +1,17 @@ +Get a shared drive from a team. + +### Usage + +``` +pspace shared-drive get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/list.md b/.assets/pspace/shared-drive/list.md new file mode 100644 index 0000000..3481e8a --- /dev/null +++ b/.assets/pspace/shared-drive/list.md @@ -0,0 +1,30 @@ +List shared drives in your team or project. + +Pick a subset of fields to display: + +``` +pspace shared-drive list -F name -F dtModified +``` + +### Usage + +``` +pspace shared-drive list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `region` | r | Filter by region. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/shared-drive/shared-drive.md b/.assets/pspace/shared-drive/shared-drive.md new file mode 100644 index 0000000..5a9b8e6 --- /dev/null +++ b/.assets/pspace/shared-drive/shared-drive.md @@ -0,0 +1,38 @@ +Manage your shared drives. Shared drives are used to centralize data used by +your team. Shared drives can be mounted on any Paperspace machine in the same +private network. + +For more information, see https://docs.paperspace.com/storage/shared-drives. + +### Usage + +``` +pspace shared-drive [command] +pspace shared-drive [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------------------- | +| `create` | Create a shared drive. | +| `delete` | Delete a shared drive from a team. | +| `get` | Get a shared drive from a team. | +| `help` | Show help for a shared-drive command | +| `list` | List shared drives in your team or project. | + +Pick a subset of fields to display: + +```` +pspace shared-drive list -F name -F dtModified +``` | +```` diff --git a/.assets/pspace/signup.md b/.assets/pspace/signup.md new file mode 100644 index 0000000..cc630fd --- /dev/null +++ b/.assets/pspace/signup.md @@ -0,0 +1,16 @@ +This command opens the Paperspace signup page in your browser. + +### Usage + +``` +pspace signup [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/create.md b/.assets/pspace/snapshot/create.md new file mode 100644 index 0000000..f9b3d78 --- /dev/null +++ b/.assets/pspace/snapshot/create.md @@ -0,0 +1,19 @@ +Create a snapshot from a machine. + +### Usage + +``` +pspace snapshot create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the snapshot | true | +| `machine-id` | m | The ID of the machine to create a snapshot from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/delete.md b/.assets/pspace/snapshot/delete.md new file mode 100644 index 0000000..c73a590 --- /dev/null +++ b/.assets/pspace/snapshot/delete.md @@ -0,0 +1,17 @@ +Delete a snapshot from a team. + +### Usage + +``` +pspace snapshot delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/list.md b/.assets/pspace/snapshot/list.md new file mode 100644 index 0000000..080e11f --- /dev/null +++ b/.assets/pspace/snapshot/list.md @@ -0,0 +1,30 @@ +List snapshots in your team. + +Pick a subset of fields to display: + +``` +pspace snapshot list -F name -F dtModified +``` + +### Usage + +``` +pspace snapshot list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | -------------------------------------------------------------------- | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | m | The ID of the machine the event is for. If not specified, all events | | +| will be returned. | false | | | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/restore.md b/.assets/pspace/snapshot/restore.md new file mode 100644 index 0000000..da87532 --- /dev/null +++ b/.assets/pspace/snapshot/restore.md @@ -0,0 +1,18 @@ +Restore a machine to a snapshot. + +### Usage + +``` +pspace snapshot restore [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `create-snapshot` | | Create an additional snapshot before restore | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/snapshot/snapshot.md b/.assets/pspace/snapshot/snapshot.md new file mode 100644 index 0000000..69011d9 --- /dev/null +++ b/.assets/pspace/snapshot/snapshot.md @@ -0,0 +1,39 @@ +Manage your snapshots. Snapshots are copies of your machine's disk at a point in +time. They can be used to restore the machine to its previous state. Using +snapshots is recommended before taking any action that could affect the +usability of the machine or its network connection. + +For more information, see https://docs.paperspace.com/storage/snapshots. + +### Usage + +``` +pspace snapshot [command] +pspace snapshot [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------- | +| `create` | Create a snapshot from a machine. | +| `delete` | Delete a snapshot from a team. | +| `help` | Show help for a snapshot command | +| `list` | List snapshots in your team. | + +Pick a subset of fields to display: + +```` +pspace snapshot list -F name -F dtModified +``` | +| `restore` | Restore a machine to a snapshot. | +```` diff --git a/.assets/pspace/startup-script/assign.md b/.assets/pspace/startup-script/assign.md new file mode 100644 index 0000000..f1b084d --- /dev/null +++ b/.assets/pspace/startup-script/assign.md @@ -0,0 +1,18 @@ +Assign a startup script to a machine. + +### Usage + +``` +pspace startup-script assign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | | The ID of the machine to assign the startup script to | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/create.md b/.assets/pspace/startup-script/create.md new file mode 100644 index 0000000..4d542ba --- /dev/null +++ b/.assets/pspace/startup-script/create.md @@ -0,0 +1,20 @@ +Create a startup script. + +### Usage + +``` +pspace startup-script create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the startup script | true | +| `script` | | The script to run | true | +| `run-once` | | Whether to run once or on every boot | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/delete.md b/.assets/pspace/startup-script/delete.md new file mode 100644 index 0000000..8252f5b --- /dev/null +++ b/.assets/pspace/startup-script/delete.md @@ -0,0 +1,17 @@ +Delete a startup script from a team. + +### Usage + +``` +pspace startup-script delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/get.md b/.assets/pspace/startup-script/get.md new file mode 100644 index 0000000..631a4db --- /dev/null +++ b/.assets/pspace/startup-script/get.md @@ -0,0 +1,17 @@ +Get a startup script from a team. + +### Usage + +``` +pspace startup-script get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/list.md b/.assets/pspace/startup-script/list.md new file mode 100644 index 0000000..0d1ef3c --- /dev/null +++ b/.assets/pspace/startup-script/list.md @@ -0,0 +1,29 @@ +List startup scripts in your team. + +Pick a subset of fields to display: + +``` +pspace startup-script list -F name -F dtCreated +``` + +### Usage + +``` +pspace startup-script list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | Filter by name. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/startup-script.md b/.assets/pspace/startup-script/startup-script.md new file mode 100644 index 0000000..7b3d002 --- /dev/null +++ b/.assets/pspace/startup-script/startup-script.md @@ -0,0 +1,38 @@ +Manage your startup scripts. Startup scripts allow you to configure a machine on +first boot or on every boot. + +### Usage + +``` +pspace startup-script [command] +pspace startup-script [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | -------------------------------------- | +| `assign` | Assign a startup script to a machine. | +| `create` | Create a startup script. | +| `delete` | Delete a startup script from a team. | +| `get` | Get a startup script from a team. | +| `help` | Show help for a startup-script command | +| `list` | List startup scripts in your team. | + +Pick a subset of fields to display: + +```` +pspace startup-script list -F name -F dtCreated +``` | +| `unassign` | Unassign a startup script from a machine. | +| `update` | Update a startup script. | +```` diff --git a/.assets/pspace/startup-script/unassign.md b/.assets/pspace/startup-script/unassign.md new file mode 100644 index 0000000..1f80cca --- /dev/null +++ b/.assets/pspace/startup-script/unassign.md @@ -0,0 +1,18 @@ +Unassign a startup script from a machine. + +### Usage + +``` +pspace startup-script unassign [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------ | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `machine-id` | | The ID of the machine to unassign the startup script from | true | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/startup-script/update.md b/.assets/pspace/startup-script/update.md new file mode 100644 index 0000000..3e61324 --- /dev/null +++ b/.assets/pspace/startup-script/update.md @@ -0,0 +1,21 @@ +Update a startup script. + +### Usage + +``` +pspace startup-script update [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the startup script | false | +| `script` | | The script to run | false | +| `run-once` | | Whether to run once or on every boot | false | +| `enabled` | | Whether the startup script is enabled or not | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/create/create.md b/.assets/pspace/storage-provider/create/create.md new file mode 100644 index 0000000..cdbd6ee --- /dev/null +++ b/.assets/pspace/storage-provider/create/create.md @@ -0,0 +1,24 @@ +Create a storage provider. + +### Usage + +``` +pspace storage-provider create [command] +pspace storage-provider create [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ------------------------------ | +| `help` | Show help for a create command | +| `s3` | Create an S3 storage provider. | diff --git a/.assets/pspace/storage-provider/create/s3.md b/.assets/pspace/storage-provider/create/s3.md new file mode 100644 index 0000000..fa96d0e --- /dev/null +++ b/.assets/pspace/storage-provider/create/s3.md @@ -0,0 +1,26 @@ +Create an S3 storage provider. + +### Usage + +``` +pspace storage-provider create s3 [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the storage provider | true | +| `is-team-default` | | Whether the storage provider is the team's default provider | false | +| `endpoint` | | The endpoint of the storage provider | false | +| `bucket` | | The bucket of the storage provider | true | +| `region` | | The region of the storage provider | false | +| `access-key` | | The access key of the storage provider | true | +| `secret-access-key` | | The secret access key of the storage provider | true | +| `signature-version` | | The signature version of the storage provider | false | +| `retain-data` | | Whether to retain data in the storage provider | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/delete.md b/.assets/pspace/storage-provider/delete.md new file mode 100644 index 0000000..9298952 --- /dev/null +++ b/.assets/pspace/storage-provider/delete.md @@ -0,0 +1,17 @@ +Delete a storage provider from a team. + +### Usage + +``` +pspace storage-provider delete [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/get.md b/.assets/pspace/storage-provider/get.md new file mode 100644 index 0000000..45d4fe9 --- /dev/null +++ b/.assets/pspace/storage-provider/get.md @@ -0,0 +1,17 @@ +Get a storage provider from a team. + +### Usage + +``` +pspace storage-provider get [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/list.md b/.assets/pspace/storage-provider/list.md new file mode 100644 index 0000000..88de7b9 --- /dev/null +++ b/.assets/pspace/storage-provider/list.md @@ -0,0 +1,28 @@ +List storage providers in your team or project. + +Pick a subset of fields to display: + +``` +pspace storage provider list -F name -F dtModified +``` + +### Usage + +``` +pspace storage-provider list [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `limit` | | The number of items to return in the next page. | false | +| `after` | | The cursor to fetch the next results from. | false | +| `orderBy` | | The field to order items by. | false | +| `asc` | | Whether to order items ascending. | false | +| `desc` | | Whether to order items descending. | false | +| `fields` | F | The fields to include in the response. | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/storage-provider.md b/.assets/pspace/storage-provider/storage-provider.md new file mode 100644 index 0000000..91805cd --- /dev/null +++ b/.assets/pspace/storage-provider/storage-provider.md @@ -0,0 +1,37 @@ +Manage your storage providers. + +For more information, see https://docs.paperspace.com/storage/storageProviders. + +### Usage + +``` +pspace storage-provider [command] +pspace storage-provider [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | ----------------------------------------------- | +| `create` | Create a storage provider. | +| `delete` | Delete a storage provider from a team. | +| `get` | Get a storage provider from a team. | +| `help` | Show help for a storage-provider command | +| `list` | List storage providers in your team or project. | + +Pick a subset of fields to display: + +```` +pspace storage provider list -F name -F dtModified +``` | +| `update` | Update a storage provider. | +```` diff --git a/.assets/pspace/storage-provider/update/s3.md b/.assets/pspace/storage-provider/update/s3.md new file mode 100644 index 0000000..2758434 --- /dev/null +++ b/.assets/pspace/storage-provider/update/s3.md @@ -0,0 +1,26 @@ +Update an S3 storage provider in a project or team. + +### Usage + +``` +pspace storage-provider update s3 [arguments] [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ------------------- | ------- | ------------------------------------------------------------ | -------- | +| `fields` | F | The fields to include in the response. | false | +| `name` | n | The name of the storage provider | true | +| `is-team-default` | | Whether the storage provider is the team's default provider | true | +| `endpoint` | | The endpoint of the storage provider | false | +| `bucket` | | The bucket of the storage provider | true | +| `region` | | The region of the storage provider | false | +| `access-key` | | The access key of the storage provider | true | +| `secret-access-key` | | The secret access key of the storage provider | true | +| `signature-version` | | The signature version of the storage provider | false | +| `retain-data` | | Whether to retain data in the storage provider | false | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/storage-provider/update/update.md b/.assets/pspace/storage-provider/update/update.md new file mode 100644 index 0000000..ba40090 --- /dev/null +++ b/.assets/pspace/storage-provider/update/update.md @@ -0,0 +1,24 @@ +Update a storage provider. + +### Usage + +``` +pspace storage-provider update [command] +pspace storage-provider update [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | + +#### Subcommands + +| Subcommand | Description | +| ---------- | --------------------------------------------------- | +| `help` | Show help for a update command | +| `s3` | Update an S3 storage provider in a project or team. | diff --git a/.assets/pspace/up.md b/.assets/pspace/up.md new file mode 100644 index 0000000..18c7fc0 --- /dev/null +++ b/.assets/pspace/up.md @@ -0,0 +1,51 @@ +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 + +``` +pspace up [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| -------- | ------- | ----------------------------------------------------------------------- | -------- | +| `config` | c | The path to the config file. Defaults to our default config file paths. | | + +The default config file paths are in order of precedence: + +- `paperspace.yaml` +- `paperspace.yml` +- `paperspace.json` +- `paperspace.jsonc` +- `paperspace.toml` +- `.paperspace/app.yaml` +- `.paperspace/app.yml` +- `.paperspace/app.json` +- `.paperspace/app.jsonc` +- `.paperspace/app.toml` | false | | `project-id` | p | The ID of the project to + deploy to. | false | | `cwd` | | The directory to deploy the app from. + Defaults to the current directory. | false | | `log-level` | l | Enable debug + logging. | false | | `json` | j | Output JSON | false | | `api-key` | | A + Paperspace public API Key used for authenticating requests | false | | `help` + | h | Show help for a command | false | diff --git a/.assets/pspace/upgrade.md b/.assets/pspace/upgrade.md new file mode 100644 index 0000000..c2963df --- /dev/null +++ b/.assets/pspace/upgrade.md @@ -0,0 +1,30 @@ +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 + +``` +pspace upgrade [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.assets/pspace/version.md b/.assets/pspace/version.md new file mode 100644 index 0000000..df947a1 --- /dev/null +++ b/.assets/pspace/version.md @@ -0,0 +1,16 @@ +Shows version information command, including version number and build date. + +### Usage + +``` +pspace version [flags] +``` + +### Flags + +| Name | Aliases | Description | Required | +| ----------- | ------- | ------------------------------------------------------------ | -------- | +| `log-level` | l | Enable debug logging. | false | +| `json` | j | Output JSON | false | +| `api-key` | | A Paperspace public API Key used for authenticating requests | false | +| `help` | h | Show help for a command | false | diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index e0eaeab..7f9bf4d 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -1,6 +1,6 @@ import { app } from "../zcli.ts"; import { root } from "../commands/mod.ts"; -import { zcliJson } from "https://deno.land/x/zcli@1.3.3/zcli-json.ts"; +import { zcliJson, ZcliJsonCommand } from "./zcli-json.ts"; // Read the markdown file adjacent to this script const json = await zcliJson(app, root); @@ -10,3 +10,62 @@ await Deno.writeTextFile( ".assets/pspace.json", JSON.stringify(json, null, 2), ); + +// Also generate markdown for the CLI +async function renderCommand( + path: string[], + command: ZcliJsonCommand, +) { + if (command.name === "help") { + return; + } + let markdown = ""; + markdown += command.description + "\n\n"; + markdown += "### Usage\n\n"; + markdown += `\`\`\`\n`; + markdown += `${command.usage}\n`; + markdown += "\`\`\`\n\n"; + markdown += "### Flags\n\n"; + markdown += "| Name | Aliases | Description | Required |\n"; + markdown += "| --- | --- | --- | --- |\n"; + for (const flag of command.flags) { + markdown += `| \`${flag.name}\` | ${ + flag.aliases.join(", ") + } | ${flag.description} | ${flag.required} |\n`; + } + markdown += "\n"; + + const hasSubcommands = command.commands.length > 0; + + if (hasSubcommands) { + markdown += "#### Subcommands\n\n"; + markdown += "| Subcommand | Description |\n"; + markdown += "| --- | --- |\n"; + for (const subcommand of command.commands) { + markdown += `| \`${subcommand.name}\` | ${subcommand.description} |\n`; + } + markdown += "\n"; + } + + const dir = path.slice(0, path.length - (hasSubcommands ? 0 : 1)); + const writePath = [ + ...dir, + command.name + ".md", + ].join("/"); + await Deno.mkdir(`.assets/${dir.join("/")}`, { recursive: true }); + await Deno.writeTextFile( + // edge case, put pspace in pspace/pspace.md + `.assets/${writePath}`, + markdown, + { + create: true, + }, + ); + for (const subcommand of command.commands) { + await renderCommand([...path, subcommand.name], subcommand); + } +} + +for (const command of json.commands) { + await renderCommand([command.name], command); +} diff --git a/.scripts/zcli-json.ts b/.scripts/zcli-json.ts new file mode 100644 index 0000000..8cf3e66 --- /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, [root.name])], + }; + }); + } + + 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" } }