Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Commit

Permalink
Docs Auto-Generation (#618)
Browse files Browse the repository at this point in the history
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
  • Loading branch information
github-actions[bot] authored Sep 1, 2022
1 parent 7a25a7b commit 7d5e729
Show file tree
Hide file tree
Showing 18 changed files with 178 additions and 16 deletions.
7 changes: 6 additions & 1 deletion docs/docs/cli/corso.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso"
hide_title: true
---
## corso

Protect your Microsoft 365 data.
Expand All @@ -16,13 +20,14 @@ corso [flags]
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
-h, --help help for corso
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
-v, --version current version info
```

### SEE ALSO

* [corso backup](corso_backup.md) - Backup your service data
* [corso env](corso_env.md) - env var guide
* [corso repo](corso_repo.md) - Manage your repositories
* [corso restore](corso_restore.md) - Restore your service data

###### Auto generated by spf13/cobra on 11-Aug-2022
7 changes: 6 additions & 1 deletion docs/docs/cli/corso_backup.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup"
hide_title: true
---
## corso backup

Backup your service data
Expand All @@ -21,13 +25,14 @@ corso backup [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso](corso.md) - Protect your Microsoft 365 data.
* [corso backup create](corso_backup_create.md) - Backup an M365 Service
* [corso backup delete](corso_backup_delete.md) - Deletes a backup for a service
* [corso backup details](corso_backup_details.md) - Shows the details of a backup for a service
* [corso backup list](corso_backup_list.md) - List the history of backups for a service

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_backup_create.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup create"
hide_title: true
---
## corso backup create

Backup an M365 Service
Expand All @@ -17,11 +21,11 @@ corso backup create [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup](corso_backup.md) - Backup your service data
* [corso backup create exchange](corso_backup_create_exchange.md) - Backup M365 Exchange service data

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_backup_create_exchange.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup create exchange"
hide_title: true
---
## corso backup create exchange

Backup M365 Exchange service data
Expand All @@ -20,10 +24,10 @@ corso backup create exchange [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup create](corso_backup_create.md) - Backup an M365 Service

###### Auto generated by spf13/cobra on 11-Aug-2022
31 changes: 31 additions & 0 deletions docs/docs/cli/corso_backup_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "corso backup delete"
hide_title: true
---
## corso backup delete

Deletes a backup for a service

```
corso backup delete [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup](corso_backup.md) - Backup your service data
* [corso backup delete exchange](corso_backup_delete_exchange.md) - Delete backed-up M365 Exchange service data

31 changes: 31 additions & 0 deletions docs/docs/cli/corso_backup_delete_exchange.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "corso backup delete exchange"
hide_title: true
---
## corso backup delete exchange

Delete backed-up M365 Exchange service data

```
corso backup delete exchange [flags]
```

### Options

```
--backup string ID of the backup containing the details to be shown
-h, --help help for exchange
```

### Options inherited from parent commands

```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup delete](corso_backup_delete.md) - Deletes a backup for a service

6 changes: 5 additions & 1 deletion docs/docs/cli/corso_backup_details.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup details"
hide_title: true
---
## corso backup details

Shows the details of a backup for a service
Expand All @@ -17,11 +21,11 @@ corso backup details [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup](corso_backup.md) - Backup your service data
* [corso backup details exchange](corso_backup_details_exchange.md) - Shows the details of a M365 Exchange service backup

###### Auto generated by spf13/cobra on 11-Aug-2022
12 changes: 10 additions & 2 deletions docs/docs/cli/corso_backup_details_exchange.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup details exchange"
hide_title: true
---
## corso backup details exchange

Shows the details of a M365 Exchange service backup
Expand All @@ -10,12 +14,16 @@ corso backup details exchange [flags]

```
--backup string ID of the backup containing the details to be shown
--contact strings Select backup details by contact ID; accepts * to select all contacts
--contact-folder strings Select backup details by contact folder ID; accepts * to select all contact folders
--email strings Select backup details by emails ID; accepts * to select all emails
--email-folder strings Select backup details by email folder ID; accepts * to select all email folderss
--email-folder strings Select backup details by email folder ID; accepts * to select all email folders
--email-received-after string Select backup details where the email was received after this datetime
--email-received-before string Select backup details where the email was received before this datetime
--email-sender string Select backup details where the email sender matches this user id
--email-subject string Select backup details where the email subject lines contain this value
--event strings Select backup details by event ID; accepts * to select all events
--event-calendar strings Select backup details by event calendar ID; accepts * to select all events
-h, --help help for exchange
--user strings Select backup details by user ID; accepts * to select all users
```
Expand All @@ -25,10 +33,10 @@ corso backup details exchange [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup details](corso_backup_details.md) - Shows the details of a backup for a service

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_backup_list.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup list"
hide_title: true
---
## corso backup list

List the history of backups for a service
Expand All @@ -17,11 +21,11 @@ corso backup list [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup](corso_backup.md) - Backup your service data
* [corso backup list exchange](corso_backup_list_exchange.md) - List the history of M365 Exchange service backups

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_backup_list_exchange.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso backup list exchange"
hide_title: true
---
## corso backup list exchange

List the history of M365 Exchange service backups
Expand All @@ -17,10 +21,10 @@ corso backup list exchange [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso backup list](corso_backup_list.md) - List the history of backups for a service

###### Auto generated by spf13/cobra on 11-Aug-2022
34 changes: 34 additions & 0 deletions docs/docs/cli/corso_env.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "corso env"
hide_title: true
---
## corso env

env var guide

### Synopsis

A guide to using environment variables in Corso.

```
corso env [flags]
```

### Options

```
-h, --help help for env
```

### Options inherited from parent commands

```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso](corso.md) - Protect your Microsoft 365 data.

6 changes: 5 additions & 1 deletion docs/docs/cli/corso_repo.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso repo"
hide_title: true
---
## corso repo

Manage your repositories
Expand All @@ -21,6 +25,7 @@ corso repo [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO
Expand All @@ -29,4 +34,3 @@ corso repo [flags]
* [corso repo connect](corso_repo_connect.md) - Connect to a repository.
* [corso repo init](corso_repo_init.md) - Initialize a repository.

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_repo_connect.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso repo connect"
hide_title: true
---
## corso repo connect

Connect to a repository.
Expand All @@ -21,11 +25,11 @@ corso repo connect [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso repo](corso_repo.md) - Manage your repositories
* [corso repo connect s3](corso_repo_connect_s3.md) - Connect to a S3 repository

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_repo_connect_s3.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso repo connect s3"
hide_title: true
---
## corso repo connect s3

Connect to a S3 repository
Expand Down Expand Up @@ -25,10 +29,10 @@ corso repo connect s3 [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso repo connect](corso_repo_connect.md) - Connect to a repository.

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_repo_init.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso repo init"
hide_title: true
---
## corso repo init

Initialize a repository.
Expand All @@ -21,11 +25,11 @@ corso repo init [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso repo](corso_repo.md) - Manage your repositories
* [corso repo init s3](corso_repo_init_s3.md) - Initialize a S3 repository

###### Auto generated by spf13/cobra on 11-Aug-2022
6 changes: 5 additions & 1 deletion docs/docs/cli/corso_repo_init_s3.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: "corso repo init s3"
hide_title: true
---
## corso repo init s3

Initialize a S3 repository
Expand Down Expand Up @@ -25,10 +29,10 @@ corso repo init s3 [flags]
```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
```

### SEE ALSO

* [corso repo init](corso_repo_init.md) - Initialize a repository.

###### Auto generated by spf13/cobra on 11-Aug-2022
Loading

0 comments on commit 7d5e729

Please sign in to comment.