Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/reference/replicated-cli-api-get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# replicated api get

Make ad-hoc GET API calls to the Replicated API

### Synopsis

This is essentially like curl for the Replicated API, but
uses your local credentials and prints the response unmodified.

We recommend piping the output to jq for easier reading.

Pass the PATH of the request as the final argument. Do not include the host or version.

```
replicated api get [flags]
```

### Examples

```
replicated api get /v3/apps
```

### Options

```
-h, --help help for get
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated api](replicated_api.md) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 21-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-patch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# replicated api patch

Make ad-hoc PATCH API calls to the Replicated API

### Synopsis

This is essentially like curl for the Replicated API, but
uses your local credentials and prints the response unmodified.

We recommend piping the output to jq for easier reading.

Pass the PATH of the request as the final argument. Do not include the host or version.

```
replicated api patch [flags]
```

### Examples

```
replicated api patch /v3/customer/2VffY549paATVfHSGpJhjh6Ehpy -b '{"name":"Valuable Customer"}'
```

### Options

```
-b, --body string JSON body to send with the request
-h, --help help for patch
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated api](replicated_api.md) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 21-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# replicated api post

Make ad-hoc POST API calls to the Replicated API

### Synopsis

This is essentially like curl for the Replicated API, but
uses your local credentials and prints the response unmodified.

We recommend piping the output to jq for easier reading.

Pass the PATH of the request as the final argument. Do not include the host or version.

```
replicated api post [flags]
```

### Examples

```
replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"marc-waz-here"}'
```

### Options

```
-b, --body string JSON body to send with the request
-h, --help help for post
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated api](replicated_api.md) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 21-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-put.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# replicated api put

Make ad-hoc PUT API calls to the Replicated API

### Synopsis

This is essentially like curl for the Replicated API, but
uses your local credentials and prints the response unmodified.

We recommend piping the output to jq for easier reading.

Pass the PATH of the request as the final argument. Do not include the host or version.

```
replicated api put [flags]
```

### Examples

```
replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"marc-waz-here2"}'
```

### Options

```
-b, --body string JSON body to send with the request
-h, --help help for put
```

### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated api](replicated_api.md) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 21-Jan-2025
71 changes: 20 additions & 51 deletions docs/reference/replicated-cli-api.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,28 @@
import Help from "../partials/replicated-cli/_help.mdx"
# replicated api

# api
Make ad-hoc API calls to the Replicated API

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).
### Options

## Usage

```bash
replicated api [command]
```

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.

### Available Commands

<table>
<tr>
<th>Command</th>
<th>Description</th>
</tr>
<tr>
<td>get</td>
<td>Make adhoc GET API calls to the Vendor API v3</td>
</tr>
<tr>
<td>post</td>
<td>Make adhoc POST API calls to the Vendor API v3</td>
</tr>
<tr>
<td>put</td>
<td>Make adhoc PUT API calls to the Vendor API v3</td>
</tr>
</table>

### Flags

<table>
<tr>
<th width="30%">Flag</th>
<th width="20%">Type (if applicable)</th>
<th width="50%">Description</th>
</tr>
<Help/>
</table>

## Examples

```bash
replicated api get /v3/apps
-h, --help help for api
```

```bash
replicated api put /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel/2QLPm10JPkta7jO3Z3Mk4aXTPyZ -b '{"name":"put-example"}'
### Options inherited from parent commands

```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated](replicated.md) - Manage your Commercial Software Distribution Lifecycle using Replicated
* [replicated api get](replicated_api_get.md) - Make ad-hoc GET API calls to the Replicated API
* [replicated api patch](replicated_api_patch.md) - Make ad-hoc PATCH API calls to the Replicated API
* [replicated api post](replicated_api_post.md) - Make ad-hoc POST API calls to the Replicated API
* [replicated api put](replicated_api_put.md) - Make ad-hoc PUT API calls to the Replicated API

```bash
replicated api post /v3/app/2EuFxKLDxKjPNk2jxMTmF6Vxvxu/channel -b '{"name":"post-example"}'
```
###### Auto generated by spf13/cobra on 21-Jan-2025
66 changes: 45 additions & 21 deletions docs/reference/replicated-cli-app-create.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,52 @@
import Token from "../partials/replicated-cli/_token.mdx"
import Help from "../partials/replicated-cli/_help.mdx"
# replicated app create

# app create
Create a new application

Create an application.
### Synopsis

## Usage
```bash
replicated app create NAME
Create a new application in your Replicated account.

This command allows you to initialize a new application that can be distributed
and managed using the KOTS platform. When you create a new app, it will be set up
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...application that can be distributed
and managed using the KOTS platform. ...

^ not sure what the KOTS platform means here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once doc generating PR is merged, this can be addressed

with default configurations, which you can later customize.

The NAME argument is required and will be used as the application's name.

```
replicated app create NAME [flags]
```

### Examples

```
# Create a new app named "My App"
replicated app create "My App"
# Create a new app and output the result in JSON format
replicated app create "Another App" --output json
# Create a new app with a specific name and view details in table format
replicated app create "Custom App" --output table
```

### Options

```
-h, --help help for create
--output string The output format to use. One of: json|table (default: table) (default "table")
```

<table>
<tr>
<th width="30%">Flag</th>
<th width="20%">Type (if applicable)</th>
<th width="50%">Description</th>
</tr>
<Help/>
<Token/>
</table>
### Options inherited from parent commands

## Examples
```bash
replicated app create cli-app
ID NAME SLUG SCHEDULER
1xy9t8G9CO0PRGzTwSwWFkMUjZO cli-app cli-app kots
```
--app string The app slug or app id to use in all calls
--integration-test string Set to the name of the integration test to run
--log-api-calls string Log the API calls to the specified file
--token string The API token to use to access your app in the Vendor API
```

### SEE ALSO

* [replicated app](replicated_app.md) - Manage applications

###### Auto generated by spf13/cobra on 21-Jan-2025
36 changes: 0 additions & 36 deletions docs/reference/replicated-cli-app-delete.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: Paige to add redirect for this page to app rm in the netlify toml before merging

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

This file was deleted.

Loading
Loading