Skip to content

Commit d396625

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

File tree

120 files changed

+4094
-2535
lines changed

Some content is hidden

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

120 files changed

+4094
-2535
lines changed

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

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_api.md) - 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.md‎

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_api.md) - 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.md‎

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_api.md) - 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.md‎

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_api.md) - 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: 20 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,28 @@
1-
import Help from "../partials/replicated-cli/_help.mdx"
1+
# replicated api
22

3-
# api
3+
Make ad-hoc API calls to the Replicated API
44

5-
Make adhoc calls to the Vendor API v3. Uses your local credentials and prints the response unmodified. For more information, see the [Vendor API v3 documentation](https://replicated-vendor-api.readme.io/reference/createapp).
5+
### Options
66

7-
## Usage
8-
9-
```bash
10-
replicated api [command]
117
```
12-
13-
Pass the PATH of the request as the final argument. Do not include the host or version. Replicated recommends piping the output to jq for easier reading.
14-
15-
### Available Commands
16-
17-
<table>
18-
<tr>
19-
<th>Command</th>
20-
<th>Description</th>
21-
</tr>
22-
<tr>
23-
<td>get</td>
24-
<td>Make adhoc GET API calls to the Vendor API v3</td>
25-
</tr>
26-
<tr>
27-
<td>post</td>
28-
<td>Make adhoc POST API calls to the Vendor API v3</td>
29-
</tr>
30-
<tr>
31-
<td>put</td>
32-
<td>Make adhoc PUT API calls to the Vendor API v3</td>
33-
</tr>
34-
</table>
35-
36-
### Flags
37-
38-
<table>
39-
<tr>
40-
<th width="30%">Flag</th>
41-
<th width="20%">Type (if applicable)</th>
42-
<th width="50%">Description</th>
43-
</tr>
44-
<Help/>
45-
</table>
46-
47-
## Examples
48-
49-
```bash
50-
replicated api get /v3/apps
8+
-h, --help help for api
519
```
5210

53-
```bash
54-
replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"put-example"}'
11+
### Options inherited from parent commands
12+
5513
```
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.md) - Manage your Commercial Software Distribution Lifecycle using Replicated
23+
* [replicated api get](replicated_api_get.md) - Make ad-hoc GET API calls to the Replicated API
24+
* [replicated api patch](replicated_api_patch.md) - Make ad-hoc PATCH API calls to the Replicated API
25+
* [replicated api post](replicated_api_post.md) - Make ad-hoc POST API calls to the Replicated API
26+
* [replicated api put](replicated_api_put.md) - Make ad-hoc PUT API calls to the Replicated API
5627

57-
```bash
58-
replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"post-example"}'
59-
```
28+
###### Auto generated by spf13/cobra on 21-Jan-2025

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

Lines changed: 45 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,52 @@
1-
import Token from "../partials/replicated-cli/_token.mdx"
2-
import Help from "../partials/replicated-cli/_help.mdx"
1+
# replicated app create
32

4-
# app create
3+
Create a new application
54

6-
Create an application.
5+
### Synopsis
76

8-
## Usage
9-
```bash
10-
replicated app create NAME
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")
1137
```
1238

13-
<table>
14-
<tr>
15-
<th width="30%">Flag</th>
16-
<th width="20%">Type (if applicable)</th>
17-
<th width="50%">Description</th>
18-
</tr>
19-
<Help/>
20-
<Token/>
21-
</table>
39+
### Options inherited from parent commands
2240

23-
## Examples
24-
```bash
25-
replicated app create cli-app
26-
ID NAME SLUG SCHEDULER
27-
1xy9t8G9CO0PRGzTwSwWFkMUjZO cli-app cli-app kots
2841
```
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_app.md) - Manage applications
51+
52+
###### Auto generated by spf13/cobra on 21-Jan-2025

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

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

0 commit comments

Comments
 (0)