larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs Auto-Generation (#618)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot] 2022-09-01 00:24:20 +00:00 committed by GitHub
parent 7a25a7b70e
commit 7d5e72925a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 178 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs/cli/corso.md
View File

@ -1,3 +1,7 @@
---
title: "corso"
hide_title: true
---
## corso ## corso
Protect your Microsoft 365 data. Protect your Microsoft 365 data.
@ -16,13 +20,14 @@ corso [flags]
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
-h, --help help for corso -h, --help help for corso
--json output data in JSON format --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 -v, --version current version info
``` ```
### SEE ALSO ### SEE ALSO
* [corso backup](corso_backup.md) - Backup your service data * [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 repo](corso_repo.md) - Manage your repositories
* [corso restore](corso_restore.md) - Restore your service data * [corso restore](corso_restore.md) - Restore your service data
###### Auto generated by spf13/cobra on 11-Aug-2022

7
docs/docs/cli/corso_backup.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup"
hide_title: true
---
## corso backup ## corso backup
Backup your service data Backup your service data
@ -21,13 +25,14 @@ corso backup [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso](corso.md) - Protect your Microsoft 365 data. * [corso](corso.md) - Protect your Microsoft 365 data.
* [corso backup create](corso_backup_create.md) - Backup an M365 Service * [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 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 * [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
docs/docs/cli/corso_backup_create.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup create"
hide_title: true
---
## corso backup create ## corso backup create
Backup an M365 Service Backup an M365 Service
@ -17,6 +21,7 @@ corso backup create [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -24,4 +29,3 @@ corso backup create [flags]
* [corso backup](corso_backup.md) - Backup your service data * [corso backup](corso_backup.md) - Backup your service data
* [corso backup create exchange](corso_backup_create_exchange.md) - Backup M365 Exchange 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
docs/docs/cli/corso_backup_create_exchange.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup create exchange"
hide_title: true
---
## corso backup create exchange ## corso backup create exchange
Backup M365 Exchange service data Backup M365 Exchange service data
@ -20,10 +24,10 @@ corso backup create exchange [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso backup create](corso_backup_create.md) - Backup an M365 Service * [corso backup create](corso_backup_create.md) - Backup an M365 Service
###### Auto generated by spf13/cobra on 11-Aug-2022

31
docs/docs/cli/corso_backup_delete.md Normal file
View File

@ -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
docs/docs/cli/corso_backup_delete_exchange.md Normal file
View File

@ -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
docs/docs/cli/corso_backup_details.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup details"
hide_title: true
---
## corso backup details ## corso backup details
Shows the details of a backup for a service Shows the details of a backup for a service
@ -17,6 +21,7 @@ corso backup details [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -24,4 +29,3 @@ corso backup details [flags]
* [corso backup](corso_backup.md) - Backup your service data * [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 * [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
docs/docs/cli/corso_backup_details_exchange.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup details exchange"
hide_title: true
---
## corso backup details exchange ## corso backup details exchange
Shows the details of a M365 Exchange service backup Shows the details of a M365 Exchange service backup
@ -10,12 +14,16 @@ corso backup details exchange [flags]
``` ```
--backup string ID of the backup containing the details to be shown --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 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-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-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-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 --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 -h, --help help for exchange
--user strings Select backup details by user ID; accepts * to select all users --user strings Select backup details by user ID; accepts * to select all users
``` ```
@ -25,10 +33,10 @@ corso backup details exchange [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso backup details](corso_backup_details.md) - Shows the details of a backup for a service * [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
docs/docs/cli/corso_backup_list.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup list"
hide_title: true
---
## corso backup list ## corso backup list
List the history of backups for a service List the history of backups for a service
@ -17,6 +21,7 @@ corso backup list [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -24,4 +29,3 @@ corso backup list [flags]
* [corso backup](corso_backup.md) - Backup your service data * [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 * [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
docs/docs/cli/corso_backup_list_exchange.md
View File

@ -1,3 +1,7 @@
---
title: "corso backup list exchange"
hide_title: true
---
## corso backup list exchange ## corso backup list exchange
List the history of M365 Exchange service backups List the history of M365 Exchange service backups
@ -17,10 +21,10 @@ corso backup list exchange [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso backup list](corso_backup_list.md) - List the history of backups 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

34
docs/docs/cli/corso_env.md Normal file
View File

@ -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
docs/docs/cli/corso_repo.md
View File

@ -1,3 +1,7 @@
---
title: "corso repo"
hide_title: true
---
## corso repo ## corso repo
Manage your repositories Manage your repositories
@ -21,6 +25,7 @@ corso repo [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -29,4 +34,3 @@ corso repo [flags]
* [corso repo connect](corso_repo_connect.md) - Connect to a repository. * [corso repo connect](corso_repo_connect.md) - Connect to a repository.
* [corso repo init](corso_repo_init.md) - Initialize a repository. * [corso repo init](corso_repo_init.md) - Initialize a repository.
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_repo_connect.md
View File

@ -1,3 +1,7 @@
---
title: "corso repo connect"
hide_title: true
---
## corso repo connect ## corso repo connect
Connect to a repository. Connect to a repository.
@ -21,6 +25,7 @@ corso repo connect [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -28,4 +33,3 @@ corso repo connect [flags]
* [corso repo](corso_repo.md) - Manage your repositories * [corso repo](corso_repo.md) - Manage your repositories
* [corso repo connect s3](corso_repo_connect_s3.md) - Connect to a S3 repository * [corso repo connect s3](corso_repo_connect_s3.md) - Connect to a S3 repository
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_repo_connect_s3.md
View File

@ -1,3 +1,7 @@
---
title: "corso repo connect s3"
hide_title: true
---
## corso repo connect s3 ## corso repo connect s3
Connect to a S3 repository Connect to a S3 repository
@ -25,10 +29,10 @@ corso repo connect s3 [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso repo connect](corso_repo_connect.md) - Connect to a repository. * [corso repo connect](corso_repo_connect.md) - Connect to a repository.
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_repo_init.md
View File

@ -1,3 +1,7 @@
---
title: "corso repo init"
hide_title: true
---
## corso repo init ## corso repo init
Initialize a repository. Initialize a repository.
@ -21,6 +25,7 @@ corso repo init [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -28,4 +33,3 @@ corso repo init [flags]
* [corso repo](corso_repo.md) - Manage your repositories * [corso repo](corso_repo.md) - Manage your repositories
* [corso repo init s3](corso_repo_init_s3.md) - Initialize a S3 repository * [corso repo init s3](corso_repo_init_s3.md) - Initialize a S3 repository
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_repo_init_s3.md
View File

@ -1,3 +1,7 @@
---
title: "corso repo init s3"
hide_title: true
---
## corso repo init s3 ## corso repo init s3
Initialize a S3 repository Initialize a S3 repository
@ -25,10 +29,10 @@ corso repo init s3 [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso repo init](corso_repo_init.md) - Initialize a repository. * [corso repo init](corso_repo_init.md) - Initialize a repository.
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_restore.md
View File

@ -1,3 +1,7 @@
---
title: "corso restore"
hide_title: true
---
## corso restore ## corso restore
Restore your service data Restore your service data
@ -21,6 +25,7 @@ corso restore [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
@ -28,4 +33,3 @@ corso restore [flags]
* [corso](corso.md) - Protect your Microsoft 365 data. * [corso](corso.md) - Protect your Microsoft 365 data.
* [corso restore exchange](corso_restore_exchange.md) - Restore M365 Exchange service data * [corso restore exchange](corso_restore_exchange.md) - Restore M365 Exchange service data
###### Auto generated by spf13/cobra on 11-Aug-2022

6
docs/docs/cli/corso_restore_exchange.md
View File

@ -1,3 +1,7 @@
---
title: "corso restore exchange"
hide_title: true
---
## corso restore exchange ## corso restore exchange
Restore M365 Exchange service data Restore M365 Exchange service data
@ -25,10 +29,10 @@ corso restore exchange [flags]
``` ```
--config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml")
--json output data in JSON format --json output data in JSON format
--log-level string set the log level to debug|info|warn|error (default "info")
``` ```
### SEE ALSO ### SEE ALSO
* [corso restore](corso_restore.md) - Restore your service data * [corso restore](corso_restore.md) - Restore your service data
###### Auto generated by spf13/cobra on 11-Aug-2022