Skip to content

Commit

Permalink
fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
ps-kwang committed May 23, 2024
1 parent e1c14d5 commit 8c607b2
Show file tree
Hide file tree
Showing 30 changed files with 2,662 additions and 2,517 deletions.
2 changes: 1 addition & 1 deletion .assets/pspace.json
Original file line number Diff line number Diff line change
Expand Up @@ -19207,4 +19207,4 @@
]
}
]
}
}
191 changes: 97 additions & 94 deletions .assets/pspace/autoscaling-group.md

Large diffs are not rendered by default.

118 changes: 64 additions & 54 deletions .assets/pspace/completion.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,54 @@
## pspace completion

Generate an autocompletion script for pspace in the specified shell.
See each sub-command's help for details on how to use the generated script.
Generate an autocompletion script for pspace in the specified shell. See each
sub-command's help for details on how to use the generated script.

### Usage

```
completion [command]
completion [flags]
completion [command]
completion [flags]
```

### Flags

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

#### Subcommands

- [bash](#bash)
- [fish](#fish)
- [help](#help)
- [zsh](#zsh)

## pspace completion bash

Generate the autocompletion script for the bash shell.

This script depends on the `bash-completion` package.
If it is not installed already, you can install it via your OS's package manager.
This script depends on the `bash-completion` package. If it is not installed
already, you can install it via your OS's package manager.

To load completions in your current shell session:

```
$ source <(completion bash bash)
```

To load completions for every new session, execute once:

Linux:

```
$ completion bash bash > /etc/bash_completion.d/pspace
```

macOS:

```
$ completion bash bash > /usr/local/etc/bash_completion.d/pspace
```
Expand All @@ -54,17 +58,17 @@ You will need to start a new shell for this setup to take effect.
### Usage

```
completion bash [flags]
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 |
| Name | Aliases | Description | Required |
| --------- | ------- | ------------------------------------------------------------ | -------- |
| log-level | l | Enable debug logging. | false |
| json | j | Output JSON | false |
| api-key | | A Paperspace public API Key used for authenticating requests | false |
| help | h | Show help for a command | false |

#### Subcommands

Expand All @@ -73,11 +77,13 @@ You will need to start a new shell for this setup to take effect.
Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

```
$ completion fish fish | source
```

To load completions for every new session, execute once:

```
$ completion fish fish > ~/.config/fish/completions/pspace.fish
```
Expand All @@ -87,18 +93,18 @@ You will need to start a new shell for this setup to take effect.
### Usage

```
completion fish [flags]
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 |
| Name | Aliases | Description | Required |
| --------------- | ------- | ------------------------------------------------------------ | -------- |
| no-descriptions | | Disable completion descriptions | false |
| log-level | l | Enable debug logging. | false |
| json | j | Output JSON | false |
| api-key | | A Paperspace public API Key used for authenticating requests | false |
| help | h | Show help for a command | false |

#### Subcommands

Expand All @@ -109,55 +115,57 @@ Show help for a completion command
### Usage

```
completion help [command]
completion help [arguments] [flags]
completion help [command]
completion help [arguments] [flags]
```

### Flags

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

#### Subcommands

- [commands](#commands)

## pspace completion help commands

List completion commands

Example:

```
$ completion help commands commands
```

### Usage

```
completion help commands [flags]
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 |
| Name | Aliases | Description | Required |
| --------- | ------- | ------------------------------------------------------------ | -------- |
| log-level | l | Enable debug logging. | false |
| json | j | Output JSON | false |
| api-key | | A Paperspace public API Key used for authenticating requests | false |
| help | h | Show help for a command | false |
| all | a | Show all commands, including hidden ones | false |

#### Subcommands

## pspace completion zsh

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
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
Expand All @@ -166,16 +174,19 @@ $ echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once:

Linux:

```
$ completion zsh zsh > "${fpath[1]}/_pspace"
```

macOS:

```
$ completion zsh zsh > /usr/local/share/zsh/site-functions/_pspace
```

Oh My Zsh:

```
$ completion zsh zsh > ~/.oh-my-zsh/completions/_pspace
```
Expand All @@ -185,18 +196,17 @@ You will need to start a new shell for this setup to take effect.
### Usage

```
completion zsh [flags]
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 |
| Name | Aliases | Description | Required |
| --------------- | ------- | ------------------------------------------------------------ | -------- |
| no-descriptions | | Disable completion descriptions | false |
| log-level | l | Enable debug logging. | false |
| json | j | Output JSON | false |
| api-key | | A Paperspace public API Key used for authenticating requests | false |
| help | h | Show help for a command | false |

#### Subcommands

Loading

0 comments on commit 8c607b2

Please sign in to comment.