Skip to content

Commit 14d76e5

Browse files
author
Replicated Release Pipeline
committed
Update Replicated CLI docs for v0.88.1
1 parent 181db81 commit 14d76e5

File tree

160 files changed

+4419
-2860
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

160 files changed

+4419
-2860
lines changed

‎docs/reference/replicated‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# replicated
2+
3+
Manage your Commercial Software Distribution Lifecycle using Replicated
4+
5+
### Synopsis
6+
7+
The 'replicated' CLI allows Replicated customers (vendors) to manage their Commercial Software Distribution Lifecycle (CSDL) using the Replicated API.
8+
9+
### Options
10+
11+
```
12+
--app string The app slug or app id to use in all calls
13+
-h, --help help for replicated
14+
--integration-test string Set to the name of the integration test to run
15+
--log-api-calls string Log the API calls to the specified file
16+
--token string The API token to use to access your app in the Vendor API
17+
```
18+
19+
### SEE ALSO
20+
21+
* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API
22+
* [replicated app](replicated-cli-app) - Manage applications
23+
* [replicated channel](replicated-cli-channel) - List channels
24+
* [replicated cluster](replicated-cli-cluster) - Manage test Kubernetes clusters.
25+
* [replicated completion](replicated-cli-completion) - Generate completion script
26+
* [replicated customer](replicated-cli-customer) - Manage customers
27+
* [replicated default](replicated-cli-default) - Manage default values used by other commands
28+
* [replicated installer](replicated-cli-installer) - Manage Kubernetes installers
29+
* [replicated instance](replicated-cli-instance) - Manage instances
30+
* [replicated login](replicated-cli-login) - Log in to Replicated
31+
* [replicated logout](replicated-cli-logout) - Logout from Replicated
32+
* [replicated registry](replicated-cli-registry) - Manage registries
33+
* [replicated release](replicated-cli-release) - Manage app releases
34+
* [replicated version](replicated-cli-version) - Print the current version and exit
35+
* [replicated vm](replicated-cli-vm) - Manage test virtual machines.
36+
37+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# replicated api
2+
3+
Make ad-hoc API calls to the Replicated API
4+
5+
### Options
6+
7+
```
8+
-h, --help help for api
9+
```
10+
11+
### Options inherited from parent commands
12+
13+
```
14+
--app string The app slug or app id to use in all calls
15+
--integration-test string Set to the name of the integration test to run
16+
--log-api-calls string Log the API calls to the specified file
17+
--token string The API token to use to access your app in the Vendor API
18+
```
19+
20+
### SEE ALSO
21+
22+
* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated
23+
* [replicated api get](replicated-cli-api-get) - Make ad-hoc GET API calls to the Replicated API
24+
* [replicated api patch](replicated-cli-api-patch) - Make ad-hoc PATCH API calls to the Replicated API
25+
* [replicated api post](replicated-cli-api-post) - Make ad-hoc POST API calls to the Replicated API
26+
* [replicated api put](replicated-cli-api-put) - Make ad-hoc PUT API calls to the Replicated API
27+
28+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api-get‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# replicated api get
2+
3+
Make ad-hoc GET API calls to the Replicated API
4+
5+
### Synopsis
6+
7+
This is essentially like curl for the Replicated API, but
8+
uses your local credentials and prints the response unmodified.
9+
10+
We recommend piping the output to jq for easier reading.
11+
12+
Pass the PATH of the request as the final argument. Do not include the host or version.
13+
14+
```
15+
replicated api get [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
replicated api get /v3/apps
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for get
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
--app string The app slug or app id to use in all calls
34+
--integration-test string Set to the name of the integration test to run
35+
--log-api-calls string Log the API calls to the specified file
36+
--token string The API token to use to access your app in the Vendor API
37+
```
38+
39+
### SEE ALSO
40+
41+
* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API
42+
43+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api-patch‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# replicated api patch
2+
3+
Make ad-hoc PATCH API calls to the Replicated API
4+
5+
### Synopsis
6+
7+
This is essentially like curl for the Replicated API, but
8+
uses your local credentials and prints the response unmodified.
9+
10+
We recommend piping the output to jq for easier reading.
11+
12+
Pass the PATH of the request as the final argument. Do not include the host or version.
13+
14+
```
15+
replicated api patch [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
replicated api patch /v3/customer/2VffY549paATVfHSGpJhjh6Ehpy -b '{"name":"Valuable Customer"}'
22+
```
23+
24+
### Options
25+
26+
```
27+
-b, --body string JSON body to send with the request
28+
-h, --help help for patch
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--app string The app slug or app id to use in all calls
35+
--integration-test string Set to the name of the integration test to run
36+
--log-api-calls string Log the API calls to the specified file
37+
--token string The API token to use to access your app in the Vendor API
38+
```
39+
40+
### SEE ALSO
41+
42+
* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API
43+
44+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api-post‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# replicated api post
2+
3+
Make ad-hoc POST API calls to the Replicated API
4+
5+
### Synopsis
6+
7+
This is essentially like curl for the Replicated API, but
8+
uses your local credentials and prints the response unmodified.
9+
10+
We recommend piping the output to jq for easier reading.
11+
12+
Pass the PATH of the request as the final argument. Do not include the host or version.
13+
14+
```
15+
replicated api post [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"marc-waz-here"}'
22+
```
23+
24+
### Options
25+
26+
```
27+
-b, --body string JSON body to send with the request
28+
-h, --help help for post
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--app string The app slug or app id to use in all calls
35+
--integration-test string Set to the name of the integration test to run
36+
--log-api-calls string Log the API calls to the specified file
37+
--token string The API token to use to access your app in the Vendor API
38+
```
39+
40+
### SEE ALSO
41+
42+
* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API
43+
44+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api-put‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# replicated api put
2+
3+
Make ad-hoc PUT API calls to the Replicated API
4+
5+
### Synopsis
6+
7+
This is essentially like curl for the Replicated API, but
8+
uses your local credentials and prints the response unmodified.
9+
10+
We recommend piping the output to jq for easier reading.
11+
12+
Pass the PATH of the request as the final argument. Do not include the host or version.
13+
14+
```
15+
replicated api put [flags]
16+
```
17+
18+
### Examples
19+
20+
```
21+
replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"marc-waz-here2"}'
22+
```
23+
24+
### Options
25+
26+
```
27+
-b, --body string JSON body to send with the request
28+
-h, --help help for put
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--app string The app slug or app id to use in all calls
35+
--integration-test string Set to the name of the integration test to run
36+
--log-api-calls string Log the API calls to the specified file
37+
--token string The API token to use to access your app in the Vendor API
38+
```
39+
40+
### SEE ALSO
41+
42+
* [replicated api](replicated-cli-api) - Make ad-hoc API calls to the Replicated API
43+
44+
###### Auto generated by spf13/cobra on 21-Jan-2025

‎docs/reference/replicated-cli-api.md‎

Lines changed: 0 additions & 59 deletions
This file was deleted.

‎docs/reference/replicated-cli-app‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# replicated app
2+
3+
Manage applications
4+
5+
### Synopsis
6+
7+
The app command allows you to manage applications in your Replicated account.
8+
9+
This command provides a suite of subcommands for creating, listing, updating, and
10+
deleting applications. You can perform operations such as creating new apps,
11+
viewing app details, modifying app settings, and removing apps from your account.
12+
13+
Use the various subcommands to:
14+
- Create new applications
15+
- List all existing applications
16+
- View details of a specific application
17+
- Update application settings
18+
- Delete applications from your account
19+
20+
### Examples
21+
22+
```
23+
# List all applications
24+
replicated app ls
25+
26+
# Create a new application
27+
replicated app create "My New App"
28+
29+
# View details of a specific application
30+
replicated app inspect "My App Name"
31+
32+
# Delete an application
33+
replicated app delete "App to Remove"
34+
35+
# Update an application's settings
36+
replicated app update "My App" --channel stable
37+
38+
# List applications with custom output format
39+
replicated app ls --output json
40+
```
41+
42+
### Options
43+
44+
```
45+
-h, --help help for app
46+
```
47+
48+
### Options inherited from parent commands
49+
50+
```
51+
--app string The app slug or app id to use in all calls
52+
--integration-test string Set to the name of the integration test to run
53+
--log-api-calls string Log the API calls to the specified file
54+
--token string The API token to use to access your app in the Vendor API
55+
```
56+
57+
### SEE ALSO
58+
59+
* [replicated](replicated) - Manage your Commercial Software Distribution Lifecycle using Replicated
60+
* [replicated app create](replicated-cli-app-create) - Create a new application
61+
* [replicated app ls](replicated-cli-app-ls) - List applications
62+
* [replicated app rm](replicated-cli-app-rm) - Delete an application
63+
64+
###### Auto generated by spf13/cobra on 21-Jan-2025

0 commit comments

Comments
 (0)