Skip to content

Commit 46eed6c

Browse files
ytimocinpops-ci-bot
ytimocin
and
pops-ci-bot
authored
Update CLI documentation for v0.0.2 (#5)
Signed-off-by: pops-ci-bot <pops-ci-bot@users.noreply.github.com> Co-authored-by: pops-ci-bot <pops-ci-bot@users.noreply.github.com>
1 parent ac98529 commit 46eed6c

26 files changed

Lines changed: 899 additions & 0 deletions

‎content/en/cli/pops.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
type: docs
3+
title: "pops CLI reference"
4+
linkTitle: "pops"
5+
slug: pops
6+
url: /reference/cli/pops/
7+
description: "Details on the pops Prompt-Ops CLI command"
8+
---
9+
## pops
10+
11+
Prompt-Ops manages your infrastructure using natural language.
12+
13+
### Options
14+
15+
```
16+
-h, --help help for pops
17+
```
18+
19+
### SEE ALSO
20+
21+
* [pops connection]({{< ref pops_connection.md >}}) - Manage your infrastructure connections using natural language.
22+
* [pops version]({{< ref pops_version.md >}}) - Print the version number of Prompt-Ops
23+
24+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
type: docs
3+
title: "pops connection CLI reference"
4+
linkTitle: "pops connection"
5+
slug: pops_connection
6+
url: /reference/cli/pops_connection/
7+
description: "Details on the pops connection Prompt-Ops CLI command"
8+
---
9+
## pops connection
10+
11+
Manage your infrastructure connections using natural language.
12+
13+
### Synopsis
14+
15+
16+
Prompt-Ops manages your infrastructure using natural language.
17+
18+
**Cloud Connection:**
19+
- **Types**: Azure, AWS
20+
- **Commands**: create, delete, open, list, types
21+
- **Example**: 'pops connection cloud create' creates a connection to a cloud provider.
22+
23+
**Database Connection:**
24+
- **Types**: MySQL, PostgreSQL, MongoDB
25+
- **Commands**: create, delete, open, list, types
26+
- **Example**: 'pops connection db create' creates a connection to a database.
27+
28+
**Kubernetes Connection:**
29+
- **Types**: Any available Kubernetes cluster
30+
- **Commands**: create, delete, open, list, types
31+
- **Example**: 'pops connection kubernetes create' creates a connection to a Kubernetes cluster.
32+
33+
More connection types and features are coming soon!
34+
35+
### Examples
36+
37+
```
38+
39+
- **pops connection create** - Create a connection by selecting from available types.
40+
- **pops connection open** - Open a connection by selecting from available connections.
41+
- **pops connection delete** - Delete a connection by selecting from available connections.
42+
- **pops connection delete --all** - Delete all available connections.
43+
- **pops connection list** - List all available connections.
44+
45+
```
46+
47+
### Options
48+
49+
```
50+
-h, --help help for connection
51+
```
52+
53+
### SEE ALSO
54+
55+
* [pops]({{< ref pops.md >}}) - Prompt-Ops manages your infrastructure using natural language.
56+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
57+
* [pops connection create]({{< ref pops_connection_create.md >}}) - Create a new connection
58+
* [pops connection db]({{< ref pops_connection_db.md >}}) - Manage database connections.
59+
* [pops connection delete]({{< ref pops_connection_delete.md >}}) - Delete a connection or all connections
60+
* [pops connection kubernetes]({{< ref pops_connection_kubernetes.md >}}) - Manage kubernetes connections.
61+
* [pops connection list]({{< ref pops_connection_list.md >}}) - List all connections
62+
* [pops connection open]({{< ref pops_connection_open.md >}}) - Open a connection
63+
* [pops connection types]({{< ref pops_connection_types.md >}}) - List all available connection types
64+
65+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud CLI reference"
4+
linkTitle: "pops connection cloud"
5+
slug: pops_connection_cloud
6+
url: /reference/cli/pops_connection_cloud/
7+
description: "Details on the pops connection cloud Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud
10+
11+
Manage cloud provider connections.
12+
13+
### Synopsis
14+
15+
16+
Cloud Connection:
17+
18+
- Available Cloud connection types: Azure and AWS.
19+
- Commands: create, delete, open, list, types.
20+
- Examples:
21+
* 'pops connection cloud create' creates a connection to a cloud provider.
22+
* 'pops connection cloud open' opens an existing cloud connection.
23+
* 'pops connection cloud list' lists all cloud connections.
24+
* 'pops connection cloud delete' deletes a cloud connection.
25+
* 'pops connection cloud types' lists all available cloud connection types (for now; Azure and AWS).
26+
27+
More connection types and features are coming soon!
28+
29+
### Options
30+
31+
```
32+
-h, --help help for cloud
33+
```
34+
35+
### SEE ALSO
36+
37+
* [pops connection]({{< ref pops_connection.md >}}) - Manage your infrastructure connections using natural language.
38+
* [pops connection cloud create]({{< ref pops_connection_cloud_create.md >}}) - Create a new cloud connection.
39+
* [pops connection cloud delete]({{< ref pops_connection_cloud_delete.md >}}) - Delete a cloud connection or all cloud connections
40+
* [pops connection cloud list]({{< ref pops_connection_cloud_list.md >}}) - List all cloud connections
41+
* [pops connection cloud open]({{< ref pops_connection_cloud_open.md >}}) - Open an existing cloud connection.
42+
* [pops connection cloud types]({{< ref pops_connection_cloud_types.md >}}) - List all available cloud connection types
43+
44+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud_create.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud create CLI reference"
4+
linkTitle: "pops connection cloud create"
5+
slug: pops_connection_cloud_create
6+
url: /reference/cli/pops_connection_cloud_create/
7+
description: "Details on the pops connection cloud create Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud create
10+
11+
Create a new cloud connection.
12+
13+
### Synopsis
14+
15+
16+
Cloud Connection:
17+
18+
- Available Cloud connection types: Azure, AWS, and GCP.
19+
- Commands: create, delete, open, list, types.
20+
- Examples:
21+
* 'pops connection cloud create' creates a connection interactively.
22+
* 'pops connection cloud create --name my-azure-conn --provider azure' creates a connection non-interactively.
23+
24+
25+
```
26+
pops connection cloud create [flags]
27+
```
28+
29+
### Options
30+
31+
```
32+
-h, --help help for create
33+
--name string Name of the cloud connection
34+
--provider string Cloud provider (azure, aws, gcp)
35+
```
36+
37+
### SEE ALSO
38+
39+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
40+
41+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud_delete.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud delete CLI reference"
4+
linkTitle: "pops connection cloud delete"
5+
slug: pops_connection_cloud_delete
6+
url: /reference/cli/pops_connection_cloud_delete/
7+
description: "Details on the pops connection cloud delete Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud delete
10+
11+
Delete a cloud connection or all cloud connections
12+
13+
### Synopsis
14+
15+
Delete a cloud connection or all cloud connections.
16+
17+
You can specify the connection name either as a positional argument or using the --name flag.
18+
19+
Examples:
20+
pops connection cloud delete my-cloud-connection
21+
pops connection cloud delete --name my-cloud-connection
22+
pops connection cloud delete --all
23+
24+
25+
```
26+
pops connection cloud delete [connection-name] [flags]
27+
```
28+
29+
### Options
30+
31+
```
32+
--all Delete all cloud connections
33+
-h, --help help for delete
34+
--name string Name of the cloud connection to delete
35+
```
36+
37+
### SEE ALSO
38+
39+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
40+
41+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud_list.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud list CLI reference"
4+
linkTitle: "pops connection cloud list"
5+
slug: pops_connection_cloud_list
6+
url: /reference/cli/pops_connection_cloud_list/
7+
description: "Details on the pops connection cloud list Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud list
10+
11+
List all cloud connections
12+
13+
### Synopsis
14+
15+
List all cloud connections that have been set up.
16+
17+
```
18+
pops connection cloud list [flags]
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for list
25+
```
26+
27+
### SEE ALSO
28+
29+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
30+
31+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud_open.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud open CLI reference"
4+
linkTitle: "pops connection cloud open"
5+
slug: pops_connection_cloud_open
6+
url: /reference/cli/pops_connection_cloud_open/
7+
description: "Details on the pops connection cloud open Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud open
10+
11+
Open an existing cloud connection.
12+
13+
### Synopsis
14+
15+
Open a cloud connection to access its shell.
16+
17+
You can specify the connection name either as a positional argument or using the --name flag.
18+
19+
Examples:
20+
pops connection cloud open my-azure-conn
21+
pops connection cloud open --name my-azure-conn
22+
23+
24+
```
25+
pops connection cloud open [connection-name] [flags]
26+
```
27+
28+
### Options
29+
30+
```
31+
-h, --help help for open
32+
--name string Name of the cloud connection
33+
```
34+
35+
### SEE ALSO
36+
37+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
38+
39+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_cloud_types.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
type: docs
3+
title: "pops connection cloud types CLI reference"
4+
linkTitle: "pops connection cloud types"
5+
slug: pops_connection_cloud_types
6+
url: /reference/cli/pops_connection_cloud_types/
7+
description: "Details on the pops connection cloud types Prompt-Ops CLI command"
8+
---
9+
## pops connection cloud types
10+
11+
List all available cloud connection types
12+
13+
### Synopsis
14+
15+
List all available cloud connection types
16+
17+
```
18+
pops connection cloud types [flags]
19+
```
20+
21+
### Options
22+
23+
```
24+
-h, --help help for types
25+
```
26+
27+
### SEE ALSO
28+
29+
* [pops connection cloud]({{< ref pops_connection_cloud.md >}}) - Manage cloud provider connections.
30+
31+
###### Auto generated by spf13/cobra on 15-Jan-2025

‎content/en/cli/pops_connection_create.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
type: docs
3+
title: "pops connection create CLI reference"
4+
linkTitle: "pops connection create"
5+
slug: pops_connection_create
6+
url: /reference/cli/pops_connection_create/
7+
description: "Details on the pops connection create Prompt-Ops CLI command"
8+
---
9+
## pops connection create
10+
11+
Create a new connection
12+
13+
### Synopsis
14+
15+
Create a new connection
16+
17+
```
18+
pops connection create [flags]
19+
```
20+
21+
### Examples
22+
23+
```
24+
pops connection create
25+
```
26+
27+
### Options
28+
29+
```
30+
-h, --help help for create
31+
```
32+
33+
### SEE ALSO
34+
35+
* [pops connection]({{< ref pops_connection.md >}}) - Manage your infrastructure connections using natural language.
36+
37+
###### Auto generated by spf13/cobra on 15-Jan-2025

0 commit comments

Comments
 (0)