Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@ps-kwang
ps-kwang committed May 29, 2024
1 parent aca61b6 commit 0f05aff
Show file tree
Hide file tree
Showing 179 changed files with 4,242 additions and 3,431 deletions.
2 changes: 1 addition & 1 deletion .assets/pspace.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"name": "pspace",
"version": "0.1.0-dev",
"commit": "development",
"buildDate": "2024-05-23T22:39:21.821Z",
"buildDate": "2024-05-29T18:11:30.955Z",
"description": "A CLI for using the Paperspace API. \n\nIt allows you to authenticate, launch deployments, do logging, and more.\n\n* Deploy an ML app with the `deployment` command\n* View a deployed app with the `deployment open` command\n* Check the status of a deployment with the `deployment status` command\n\nRead the full documentation at: https://docs.paperspace.com/",
"summary": "A CLI for using the Paperspace API."
},
Expand Down
196 changes: 0 additions & 196 deletions .assets/pspace/autoscaling-group.md
View file

This file was deleted.

37 changes: 37 additions & 0 deletions .assets/pspace/autoscaling-group/autoscaling-group.md
View file
Original file line number Diff line number Diff line change
@@ -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. |
````
26 changes: 26 additions & 0 deletions .assets/pspace/autoscaling-group/create.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
17 changes: 17 additions & 0 deletions .assets/pspace/autoscaling-group/delete.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
17 changes: 17 additions & 0 deletions .assets/pspace/autoscaling-group/get.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
23 changes: 23 additions & 0 deletions .assets/pspace/autoscaling-group/help/commands.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
List autoscaling-group commands

Example:

```
$ pspace autoscaling-group help commands commands
```

### Usage

```
pspace autoscaling-group help commands [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |
| `all` | a | Show all commands, including hidden ones | false |
30 changes: 30 additions & 0 deletions .assets/pspace/autoscaling-group/help/help.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Show help for a autoscaling-group command

### Usage

```
pspace autoscaling-group help [command]
pspace autoscaling-group help [arguments] [flags]
```

### Flags

| Name | Aliases | Description | Required |
| ----------- | ------- | ------------------------------------------------------------ | -------- |
| `log-level` | l | Enable debug logging. | false |
| `json` | j | Output JSON | false |
| `api-key` | | A Paperspace public API Key used for authenticating requests | false |
| `help` | h | Show help for a command | false |

#### Subcommands

| Subcommand | Description |
| ---------- | ------------------------------- |
| `commands` | List autoscaling-group commands |

Example:

````
$ pspace autoscaling-group help commands commands
``` |
````
30 changes: 30 additions & 0 deletions .assets/pspace/autoscaling-group/list.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
Loading

0 comments on commit 0f05aff

Please sign in to comment.