diff --git a/.assets/pspace.json b/.assets/pspace.json index cacd3e3..d3cb1d6 100644 --- a/.assets/pspace.json +++ b/.assets/pspace.json @@ -4,7 +4,7 @@ "name": "pspace", "version": "0.1.0-dev", "commit": "development", - "buildDate": "2024-05-29T18:11:30.955Z", + "buildDate": "2024-05-30T13:51:15.604Z", "description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/", "summary": "A CLI for using the Paperspace API." }, diff --git a/.assets/pspace/autoscaling-group/help/commands.md b/.assets/pspace/autoscaling-group/help/commands.md deleted file mode 100644 index f854ade..0000000 --- a/.assets/pspace/autoscaling-group/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List autoscaling-group commands - -Example: - -``` -$ pspace autoscaling-group help commands commands -``` - -### Usage - -``` -pspace autoscaling-group help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/autoscaling-group/help/help.md b/.assets/pspace/autoscaling-group/help/help.md deleted file mode 100644 index 304c022..0000000 --- a/.assets/pspace/autoscaling-group/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a autoscaling-group command - -### Usage - -``` -pspace autoscaling-group help [command] -pspace autoscaling-group help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------------- | -| `commands` | List autoscaling-group commands | - -Example: - -```` -$ pspace autoscaling-group help commands commands -``` | -```` diff --git a/.assets/pspace/completion/help/commands.md b/.assets/pspace/completion/help/commands.md deleted file mode 100644 index 4500f6e..0000000 --- a/.assets/pspace/completion/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List completion commands - -Example: - -``` -$ pspace completion help commands commands -``` - -### Usage - -``` -pspace completion help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/completion/help/help.md b/.assets/pspace/completion/help/help.md deleted file mode 100644 index 04dfc22..0000000 --- a/.assets/pspace/completion/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a completion command - -### Usage - -``` -pspace completion help [command] -pspace completion help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------ | -| `commands` | List completion commands | - -Example: - -```` -$ pspace completion help commands commands -``` | -```` diff --git a/.assets/pspace/config/help/commands.md b/.assets/pspace/config/help/commands.md deleted file mode 100644 index 6e8b19c..0000000 --- a/.assets/pspace/config/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List config commands - -Example: - -``` -$ pspace config help commands commands -``` - -### Usage - -``` -pspace config help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/config/help/help.md b/.assets/pspace/config/help/help.md deleted file mode 100644 index bf314ee..0000000 --- a/.assets/pspace/config/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a config command - -### Usage - -``` -pspace config help [command] -pspace config help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List config commands | - -Example: - -```` -$ pspace config help commands commands -``` | -```` diff --git a/.assets/pspace/custom-template/help/commands.md b/.assets/pspace/custom-template/help/commands.md deleted file mode 100644 index f2573c4..0000000 --- a/.assets/pspace/custom-template/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List custom-template commands - -Example: - -``` -$ pspace custom-template help commands commands -``` - -### Usage - -``` -pspace custom-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/custom-template/help/help.md b/.assets/pspace/custom-template/help/help.md deleted file mode 100644 index a28c476..0000000 --- a/.assets/pspace/custom-template/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a custom-template command - -### Usage - -``` -pspace custom-template help [command] -pspace custom-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------------- | -| `commands` | List custom-template commands | - -Example: - -```` -$ pspace custom-template help commands commands -``` | -```` diff --git a/.assets/pspace/dataset/help/commands.md b/.assets/pspace/dataset/help/commands.md deleted file mode 100644 index a69e176..0000000 --- a/.assets/pspace/dataset/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List dataset commands - -Example: - -``` -$ pspace dataset help commands commands -``` - -### Usage - -``` -pspace dataset help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/help/help.md b/.assets/pspace/dataset/help/help.md deleted file mode 100644 index 1e6a334..0000000 --- a/.assets/pspace/dataset/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a dataset command - -### Usage - -``` -pspace dataset help [command] -pspace dataset help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List dataset commands | - -Example: - -```` -$ pspace dataset help commands commands -``` | -```` diff --git a/.assets/pspace/dataset/versions/help/commands.md b/.assets/pspace/dataset/versions/help/commands.md deleted file mode 100644 index 0c9ecb4..0000000 --- a/.assets/pspace/dataset/versions/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List versions commands - -Example: - -``` -$ pspace dataset versions help commands commands -``` - -### Usage - -``` -pspace dataset versions help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/dataset/versions/help/help.md b/.assets/pspace/dataset/versions/help/help.md deleted file mode 100644 index 9f171db..0000000 --- a/.assets/pspace/dataset/versions/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a versions command - -### Usage - -``` -pspace dataset versions help [command] -pspace dataset versions help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------- | -| `commands` | List versions commands | - -Example: - -```` -$ pspace dataset versions help commands commands -``` | -```` diff --git a/.assets/pspace/deployment/help/commands.md b/.assets/pspace/deployment/help/commands.md deleted file mode 100644 index 428ac20..0000000 --- a/.assets/pspace/deployment/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List deployment commands - -Example: - -``` -$ pspace deployment help commands commands -``` - -### Usage - -``` -pspace deployment help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/deployment/help/help.md b/.assets/pspace/deployment/help/help.md deleted file mode 100644 index 6d9eabd..0000000 --- a/.assets/pspace/deployment/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a deployment command - -### Usage - -``` -pspace deployment help [command] -pspace deployment help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------ | -| `commands` | List deployment commands | - -Example: - -```` -$ pspace deployment help commands commands -``` | -```` diff --git a/.assets/pspace/help/commands.md b/.assets/pspace/help/commands.md deleted file mode 100644 index b28a19d..0000000 --- a/.assets/pspace/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List pspace commands - -Example: - -``` -$ pspace help commands commands -``` - -### Usage - -``` -pspace help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/help/help.md b/.assets/pspace/help/help.md deleted file mode 100644 index adbb1c9..0000000 --- a/.assets/pspace/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a pspace command - -### Usage - -``` -pspace help [command] -pspace help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List pspace commands | - -Example: - -```` -$ pspace help commands commands -``` | -```` diff --git a/.assets/pspace/machine-event/help/commands.md b/.assets/pspace/machine-event/help/commands.md deleted file mode 100644 index 8dba525..0000000 --- a/.assets/pspace/machine-event/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List machine-event commands - -Example: - -``` -$ pspace machine-event help commands commands -``` - -### Usage - -``` -pspace machine-event help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine-event/help/help.md b/.assets/pspace/machine-event/help/help.md deleted file mode 100644 index c90d420..0000000 --- a/.assets/pspace/machine-event/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a machine-event command - -### Usage - -``` -pspace machine-event help [command] -pspace machine-event help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------------- | -| `commands` | List machine-event commands | - -Example: - -```` -$ pspace machine-event help commands commands -``` | -```` diff --git a/.assets/pspace/machine/help/commands.md b/.assets/pspace/machine/help/commands.md deleted file mode 100644 index 9d681a7..0000000 --- a/.assets/pspace/machine/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List machine commands - -Example: - -``` -$ pspace machine help commands commands -``` - -### Usage - -``` -pspace machine help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/machine/help/help.md b/.assets/pspace/machine/help/help.md deleted file mode 100644 index 3c22d64..0000000 --- a/.assets/pspace/machine/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a machine command - -### Usage - -``` -pspace machine help [command] -pspace machine help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List machine commands | - -Example: - -```` -$ pspace machine help commands commands -``` | -```` diff --git a/.assets/pspace/model/help/commands.md b/.assets/pspace/model/help/commands.md deleted file mode 100644 index 3293280..0000000 --- a/.assets/pspace/model/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List model commands - -Example: - -``` -$ pspace model help commands commands -``` - -### Usage - -``` -pspace model help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/model/help/help.md b/.assets/pspace/model/help/help.md deleted file mode 100644 index 96a0eeb..0000000 --- a/.assets/pspace/model/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a model command - -### Usage - -``` -pspace model help [command] -pspace model help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------- | -| `commands` | List model commands | - -Example: - -```` -$ pspace model help commands commands -``` | -```` diff --git a/.assets/pspace/os-template/help/commands.md b/.assets/pspace/os-template/help/commands.md deleted file mode 100644 index feaa79b..0000000 --- a/.assets/pspace/os-template/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List os-template commands - -Example: - -``` -$ pspace os-template help commands commands -``` - -### Usage - -``` -pspace os-template help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/os-template/help/help.md b/.assets/pspace/os-template/help/help.md deleted file mode 100644 index 6ebc649..0000000 --- a/.assets/pspace/os-template/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a os-template command - -### Usage - -``` -pspace os-template help [command] -pspace os-template help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------- | -| `commands` | List os-template commands | - -Example: - -```` -$ pspace os-template help commands commands -``` | -```` diff --git a/.assets/pspace/private-network/help/commands.md b/.assets/pspace/private-network/help/commands.md deleted file mode 100644 index 6b78e84..0000000 --- a/.assets/pspace/private-network/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List private-network commands - -Example: - -``` -$ pspace private-network help commands commands -``` - -### Usage - -``` -pspace private-network help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/private-network/help/help.md b/.assets/pspace/private-network/help/help.md deleted file mode 100644 index a92eff8..0000000 --- a/.assets/pspace/private-network/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a private-network command - -### Usage - -``` -pspace private-network help [command] -pspace private-network help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------------- | -| `commands` | List private-network commands | - -Example: - -```` -$ pspace private-network help commands commands -``` | -```` diff --git a/.assets/pspace/project/help/commands.md b/.assets/pspace/project/help/commands.md deleted file mode 100644 index 92d5b65..0000000 --- a/.assets/pspace/project/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List project commands - -Example: - -``` -$ pspace project help commands commands -``` - -### Usage - -``` -pspace project help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/project/help/help.md b/.assets/pspace/project/help/help.md deleted file mode 100644 index 8766139..0000000 --- a/.assets/pspace/project/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a project command - -### Usage - -``` -pspace project help [command] -pspace project help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | --------------------- | -| `commands` | List project commands | - -Example: - -```` -$ pspace project help commands commands -``` | -```` diff --git a/.assets/pspace/public-ip/help/commands.md b/.assets/pspace/public-ip/help/commands.md deleted file mode 100644 index a2211e8..0000000 --- a/.assets/pspace/public-ip/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List public-ip commands - -Example: - -``` -$ pspace public-ip help commands commands -``` - -### Usage - -``` -pspace public-ip help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/public-ip/help/help.md b/.assets/pspace/public-ip/help/help.md deleted file mode 100644 index d4b8e0f..0000000 --- a/.assets/pspace/public-ip/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a public-ip command - -### Usage - -``` -pspace public-ip help [command] -pspace public-ip help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ----------------------- | -| `commands` | List public-ip commands | - -Example: - -```` -$ pspace public-ip help commands commands -``` | -```` diff --git a/.assets/pspace/secret/help/commands.md b/.assets/pspace/secret/help/commands.md deleted file mode 100644 index a0b48e7..0000000 --- a/.assets/pspace/secret/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List secret commands - -Example: - -``` -$ pspace secret help commands commands -``` - -### Usage - -``` -pspace secret help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/secret/help/help.md b/.assets/pspace/secret/help/help.md deleted file mode 100644 index 067e6d7..0000000 --- a/.assets/pspace/secret/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a secret command - -### Usage - -``` -pspace secret help [command] -pspace secret help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List secret commands | - -Example: - -```` -$ pspace secret help commands commands -``` | -```` diff --git a/.assets/pspace/shared-drive/help/commands.md b/.assets/pspace/shared-drive/help/commands.md deleted file mode 100644 index 50b4c4e..0000000 --- a/.assets/pspace/shared-drive/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List shared-drive commands - -Example: - -``` -$ pspace shared-drive help commands commands -``` - -### Usage - -``` -pspace shared-drive help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/shared-drive/help/help.md b/.assets/pspace/shared-drive/help/help.md deleted file mode 100644 index 84ff740..0000000 --- a/.assets/pspace/shared-drive/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a shared-drive command - -### Usage - -``` -pspace shared-drive help [command] -pspace shared-drive help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------------- | -| `commands` | List shared-drive commands | - -Example: - -```` -$ pspace shared-drive help commands commands -``` | -```` diff --git a/.assets/pspace/snapshot/help/commands.md b/.assets/pspace/snapshot/help/commands.md deleted file mode 100644 index ee51087..0000000 --- a/.assets/pspace/snapshot/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List snapshot commands - -Example: - -``` -$ pspace snapshot help commands commands -``` - -### Usage - -``` -pspace snapshot help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/snapshot/help/help.md b/.assets/pspace/snapshot/help/help.md deleted file mode 100644 index c56ba17..0000000 --- a/.assets/pspace/snapshot/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a snapshot command - -### Usage - -``` -pspace snapshot help [command] -pspace snapshot help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------- | -| `commands` | List snapshot commands | - -Example: - -```` -$ pspace snapshot help commands commands -``` | -```` diff --git a/.assets/pspace/startup-script/help/commands.md b/.assets/pspace/startup-script/help/commands.md deleted file mode 100644 index f3e8248..0000000 --- a/.assets/pspace/startup-script/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List startup-script commands - -Example: - -``` -$ pspace startup-script help commands commands -``` - -### Usage - -``` -pspace startup-script help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/startup-script/help/help.md b/.assets/pspace/startup-script/help/help.md deleted file mode 100644 index 43f8e5a..0000000 --- a/.assets/pspace/startup-script/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a startup-script command - -### Usage - -``` -pspace startup-script help [command] -pspace startup-script help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ---------------------------- | -| `commands` | List startup-script commands | - -Example: - -```` -$ pspace startup-script help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/create/help/commands.md b/.assets/pspace/storage-provider/create/help/commands.md deleted file mode 100644 index 538e85d..0000000 --- a/.assets/pspace/storage-provider/create/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List create commands - -Example: - -``` -$ pspace storage-provider create help commands commands -``` - -### Usage - -``` -pspace storage-provider create help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/create/help/help.md b/.assets/pspace/storage-provider/create/help/help.md deleted file mode 100644 index 293b79e..0000000 --- a/.assets/pspace/storage-provider/create/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a create command - -### Usage - -``` -pspace storage-provider create help [command] -pspace storage-provider create help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List create commands | - -Example: - -```` -$ pspace storage-provider create help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/help/commands.md b/.assets/pspace/storage-provider/help/commands.md deleted file mode 100644 index ea477d1..0000000 --- a/.assets/pspace/storage-provider/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List storage-provider commands - -Example: - -``` -$ pspace storage-provider help commands commands -``` - -### Usage - -``` -pspace storage-provider help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/help/help.md b/.assets/pspace/storage-provider/help/help.md deleted file mode 100644 index e5c4c06..0000000 --- a/.assets/pspace/storage-provider/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a storage-provider command - -### Usage - -``` -pspace storage-provider help [command] -pspace storage-provider help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | ------------------------------ | -| `commands` | List storage-provider commands | - -Example: - -```` -$ pspace storage-provider help commands commands -``` | -```` diff --git a/.assets/pspace/storage-provider/update/help/commands.md b/.assets/pspace/storage-provider/update/help/commands.md deleted file mode 100644 index 089f831..0000000 --- a/.assets/pspace/storage-provider/update/help/commands.md +++ /dev/null @@ -1,23 +0,0 @@ -List update commands - -Example: - -``` -$ pspace storage-provider update help commands commands -``` - -### Usage - -``` -pspace storage-provider update help commands [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | -| `all` | a | Show all commands, including hidden ones | false | diff --git a/.assets/pspace/storage-provider/update/help/help.md b/.assets/pspace/storage-provider/update/help/help.md deleted file mode 100644 index 23be338..0000000 --- a/.assets/pspace/storage-provider/update/help/help.md +++ /dev/null @@ -1,30 +0,0 @@ -Show help for a update command - -### Usage - -``` -pspace storage-provider update help [command] -pspace storage-provider update help [arguments] [flags] -``` - -### Flags - -| Name | Aliases | Description | Required | -| ----------- | ------- | ------------------------------------------------------------ | -------- | -| `log-level` | l | Enable debug logging. | false | -| `json` | j | Output JSON | false | -| `api-key` | | A Paperspace public API Key used for authenticating requests | false | -| `help` | h | Show help for a command | false | - -#### Subcommands - -| Subcommand | Description | -| ---------- | -------------------- | -| `commands` | List update commands | - -Example: - -```` -$ pspace storage-provider update help commands commands -``` | -```` diff --git a/.scripts/generate-docs.ts b/.scripts/generate-docs.ts index 4d703aa..7f9bf4d 100644 --- a/.scripts/generate-docs.ts +++ b/.scripts/generate-docs.ts @@ -16,6 +16,9 @@ async function renderCommand( path: string[], command: ZcliJsonCommand, ) { + if (command.name === "help") { + return; + } let markdown = ""; markdown += command.description + "\n\n"; markdown += "### Usage\n\n";