Skip to content
Merged
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.mdx
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-cli-api) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 22-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-patch.mdx
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-cli-api) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 22-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-post.mdx
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-cli-api) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 22-Jan-2025
44 changes: 44 additions & 0 deletions docs/reference/replicated-cli-api-put.mdx
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-cli-api) - Make ad-hoc API calls to the Replicated API

###### Auto generated by spf13/cobra on 22-Jan-2025
59 changes: 0 additions & 59 deletions docs/reference/replicated-cli-api.md

This file was deleted.

28 changes: 28 additions & 0 deletions docs/reference/replicated-cli-api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# replicated api

Make ad-hoc API calls to the Replicated API

### Options

```
-h, --help help for api
```

### 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) - Manage your Commercial Software Distribution Lifecycle using Replicated
* [replicated api get](replicated-cli-api-get) - Make ad-hoc GET API calls to the Replicated API
* [replicated api patch](replicated-cli-api-patch) - Make ad-hoc PATCH API calls to the Replicated API
* [replicated api post](replicated-cli-api-post) - Make ad-hoc POST API calls to the Replicated API
* [replicated api put](replicated-cli-api-put) - Make ad-hoc PUT API calls to the Replicated API

###### Auto generated by spf13/cobra on 22-Jan-2025
28 changes: 0 additions & 28 deletions docs/reference/replicated-cli-app-create.md

This file was deleted.

52 changes: 52 additions & 0 deletions docs/reference/replicated-cli-app-create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# replicated app create

Create a new application

### Synopsis

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
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")
```

### 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 app](replicated-cli-app) - Manage applications

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

This file was deleted.

Loading
Loading