Skip to content

Commit 7b66f5d

Browse files
authored
Merge pull request #2987 from replicatedhq/update-cli-docs-v0.88.1-2025-01-22-011405
Update Replicated CLI docs for v0.88.1
2 parents 181db81 + 3ac5dd7 commit 7b66f5d

File tree

147 files changed

+4321
-2762
lines changed

Some content is hidden

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

147 files changed

+4321
-2762
lines changed
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 22-Jan-2025
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 22-Jan-2025
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 22-Jan-2025
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 22-Jan-2025

docs/reference/replicated-cli-api.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
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 22-Jan-2025

docs/reference/replicated-cli-app-create.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# replicated app create
2+
3+
Create a new application
4+
5+
### Synopsis
6+
7+
Create a new application in your Replicated account.
8+
9+
This command allows you to initialize a new application that can be distributed
10+
and managed using the KOTS platform. When you create a new app, it will be set up
11+
with default configurations, which you can later customize.
12+
13+
The NAME argument is required and will be used as the application's name.
14+
15+
```
16+
replicated app create NAME [flags]
17+
```
18+
19+
### Examples
20+
21+
```
22+
# Create a new app named "My App"
23+
replicated app create "My App"
24+
25+
# Create a new app and output the result in JSON format
26+
replicated app create "Another App" --output json
27+
28+
# Create a new app with a specific name and view details in table format
29+
replicated app create "Custom App" --output table
30+
```
31+
32+
### Options
33+
34+
```
35+
-h, --help help for create
36+
--output string The output format to use. One of: json|table (default: table) (default "table")
37+
```
38+
39+
### Options inherited from parent commands
40+
41+
```
42+
--app string The app slug or app id to use in all calls
43+
--integration-test string Set to the name of the integration test to run
44+
--log-api-calls string Log the API calls to the specified file
45+
--token string The API token to use to access your app in the Vendor API
46+
```
47+
48+
### SEE ALSO
49+
50+
* [replicated app](replicated-cli-app) - Manage applications
51+
52+
###### Auto generated by spf13/cobra on 22-Jan-2025

docs/reference/replicated-cli-app-delete.md

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

0 commit comments

Comments
 (0)