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

Docs Auto-Generation (#803)

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-09 14:38:58 +00:00 committed by GitHub
parent 6f7cf00188
commit 5f85b6f061
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 142 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/docs/cli/corso_backup_create_exchange.md
View File

@ -1,33 +1,28 @@
--- ---
title: "corso backup create exchange" title: corso backup create exchange
hide_title: true hide_title: true
--- ---
## corso backup create exchange ## corso backup create exchange
Backup M365 Exchange service data Backup M365 Exchange service data
``` ```bash
corso backup create exchange [flags] corso backup create exchange [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--all Backup all Exchange data for all users |:----|:-----|:-------|:----
--data strings Select one or more types of data to backup: email, contacts, or events |`--all`||`false`|Backup all Exchange data for all users
-h, --help help for exchange |`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events
--user strings Backup Exchange data by user ID; accepts * to select all users |`--help`|`-h`|`false`|help for exchange
``` |`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users
### Options inherited from parent commands ### Global and inherited 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
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

31
docs/docs/cli/corso_backup_delete_exchange.md
View File

@ -1,31 +1,26 @@
--- ---
title: "corso backup delete exchange" title: corso backup delete exchange
hide_title: true hide_title: true
--- ---
## corso backup delete exchange ## corso backup delete exchange
Delete backed-up M365 Exchange service data Delete backed-up M365 Exchange service data
``` ```bash
corso backup delete exchange [flags] corso backup delete exchange [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--backup string ID of the backup containing the details to be shown |:----|:-----|:-------|:----
-h, --help help for exchange |`--backup`|||ID of the backup containing the details to be shown
``` |`--help`|`-h`|`false`|help for exchange
### Options inherited from parent commands ### Global and inherited 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 delete](corso_backup_delete.md) - Deletes a backup for a service
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

65
docs/docs/cli/corso_backup_details_exchange.md
View File

@ -1,48 +1,43 @@
--- ---
title: "corso backup details exchange" title: corso backup details exchange
hide_title: true 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
``` ```bash
corso backup details exchange [flags] corso backup details exchange [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--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 |`--backup`|||ID of the backup containing the details to be shown
--contact-folder strings Select backup details by contact folder ID; accepts * to select all contact folders |`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts
--contact-name string Select backup details where the contact name contains this value |`--contact-folder`||`[]`|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 |`--contact-name`|||Select backup details where the contact name contains this value
--email-folder strings Select backup details by email folder ID; accepts * to select all email folders |`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails
--email-received-after string Restore mail where the email was received after this datetime |`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders
--email-received-before string Restore mail where the email was received before this datetime |`--email-received-after`|||Restore mail where the email was received after this datetime
--email-sender string Restore mail where the email sender matches this user id |`--email-received-before`|||Restore mail where the email was received before this datetime
--email-subject string Restore mail where the email subject lines contain this value |`--email-sender`|||Restore mail where the email sender matches this user id
--event strings Select backup details by event ID; accepts * to select all events |`--email-subject`|||Restore mail where the email subject lines contain this value
--event-calendar strings Select backup details by event calendar ID; accepts * to select all events |`--event`||`[]`|Select backup details by event ID; accepts * to select all events
--event-organizer string Select backup details where the event organizer user id contains this value |`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events
--event-recurs string Select backup details if the event recurs. Use --event-recurs false to select where the event does not recur. |`--event-organizer`|||Select backup details where the event organizer user id contains this value
--event-starts-after string Select backup details where the event starts after this datetime |`--event-recurs`|||Select backup details if the event recurs. Use --event-recurs false to select where the event does not recur.
--event-starts-before string Select backup details where the event starts before this datetime |`--event-starts-after`|||Select backup details where the event starts after this datetime
--event-subject string Select backup details where the event subject contains this value |`--event-starts-before`|||Select backup details where the event starts before this datetime
-h, --help help for exchange |`--event-subject`|||Select backup details where the event subject contains this value
--user strings Select backup details by user ID; accepts * to select all users |`--help`|`-h`|`false`|help for exchange
``` |`--user`||`[]`|Select backup details by user ID; accepts * to select all users
### Options inherited from parent commands ### Global and inherited 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
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

29
docs/docs/cli/corso_backup_list_exchange.md
View File

@ -1,30 +1,25 @@
--- ---
title: "corso backup list exchange" title: corso backup list exchange
hide_title: true 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
``` ```bash
corso backup list exchange [flags] corso backup list exchange [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
-h, --help help for exchange |:----|:-----|:-------|:----
``` |`--help`|`-h`|`false`|help for exchange
### Options inherited from parent commands ### Global and inherited 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
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

33
docs/docs/cli/corso_env.md
View File

@ -1,34 +1,25 @@
--- ---
title: "corso env" title: corso env
hide_title: true hide_title: true
--- ---
## corso env ## corso env
env var guide
### Synopsis
A guide to using environment variables in Corso. A guide to using environment variables in Corso.
``` ```bash
corso env [flags] corso env [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
-h, --help help for env |:----|:-----|:-------|:----
``` |`--help`|`-h`|`false`|help for env
### Options inherited from parent commands ### Global and inherited 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.
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

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

@ -1,37 +1,28 @@
--- ---
title: "corso repo connect s3" title: corso repo connect s3
hide_title: true hide_title: true
--- ---
## corso repo connect s3 ## corso repo connect s3
Connect to a S3 repository
### Synopsis
Ensures a connection to an existing S3 repository. Ensures a connection to an existing S3 repository.
``` ```bash
corso repo connect s3 [flags] corso repo connect s3 [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--bucket string Name of the S3 bucket (required). |:----|:-----|:-------|:----
--endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") |`--bucket`|||Name of the S3 bucket (required).
-h, --help help for s3 |`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.
--prefix string Prefix applied to objects in the bucket. |`--help`|`-h`|`false`|help for s3
``` |`--prefix`|||Prefix applied to objects in the bucket.
### Options inherited from parent commands ### Global and inherited 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.
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

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

@ -1,37 +1,28 @@
--- ---
title: "corso repo init s3" title: corso repo init s3
hide_title: true hide_title: true
--- ---
## corso repo init s3 ## corso repo init s3
Initialize a S3 repository
### Synopsis
Bootstraps a new S3 repository and connects it to your m356 account. Bootstraps a new S3 repository and connects it to your m356 account.
``` ```bash
corso repo init s3 [flags] corso repo init s3 [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--bucket string Name of the S3 bucket (required). |:----|:-----|:-------|:----
--endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") |`--bucket`|||Name of the S3 bucket (required).
-h, --help help for s3 |`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication.
--prefix string Prefix applied to objects in the bucket. |`--help`|`-h`|`false`|help for s3
``` |`--prefix`|||Prefix applied to objects in the bucket.
### Options inherited from parent commands ### Global and inherited 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.
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error

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

@ -1,48 +1,43 @@
--- ---
title: "corso restore exchange" title: corso restore exchange
hide_title: true hide_title: true
--- ---
## corso restore exchange ## corso restore exchange
Restore M365 Exchange service data Restore M365 Exchange service data
``` ```bash
corso restore exchange [flags] corso restore exchange [flags]
``` ```
### Options ### Flags
``` |Flag|Short|Default|Help
--backup string ID of the backup to restore |:----|:-----|:-------|:----
--contact strings Restore contacts by ID; accepts * to select all contacts |`--backup`|||ID of the backup to restore
--contact-folder strings Restore all contacts within the folder ID; accepts * to select all contact folders |`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts
--contact-name string Restore contacts where the contact name contains this value |`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders
--email strings Restore emails by ID; accepts * to select all emails |`--contact-name`|||Restore contacts where the contact name contains this value
--email-folder strings Restore all emails by folder ID; accepts * to select all email folders |`--email`||`[]`|Restore emails by ID; accepts * to select all emails
--email-received-after string Restore mail where the email was received after this datetime |`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders
--email-received-before string Restore mail where the email was received before this datetime |`--email-received-after`|||Restore mail where the email was received after this datetime
--email-sender string Restore mail where the email sender matches this user id |`--email-received-before`|||Restore mail where the email was received before this datetime
--email-subject string Restore mail where the email subject lines contain this value |`--email-sender`|||Restore mail where the email sender matches this user id
--event strings Restore events by ID; accepts * to select all events |`--email-subject`|||Restore mail where the email subject lines contain this value
--event-calendar strings Restore events by calendar ID; accepts * to select all event calendars |`--event`||`[]`|Restore events by ID; accepts * to select all events
--event-organizer string Restore events where the event organizer user id contains this value |`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars
--event-recurs string Restore events if the event recurs. Use --event-recurs false to select where the event does not recur. |`--event-organizer`|||Restore events where the event organizer user id contains this value
--event-starts-after string Restore events where the event starts after this datetime |`--event-recurs`|||Restore events if the event recurs. Use --event-recurs false to select where the event does not recur.
--event-starts-before string Restore events where the event starts before this datetime |`--event-starts-after`|||Restore events where the event starts after this datetime
--event-subject string Restore events where the event subject contains this value |`--event-starts-before`|||Restore events where the event starts before this datetime
-h, --help help for exchange |`--event-subject`|||Restore events where the event subject contains this value
--user strings Restore all data by user ID; accepts * to select all users |`--help`|`-h`|`false`|help for exchange
``` |`--user`||`[]`|Restore all data by user ID; accepts * to select all users
### Options inherited from parent commands ### Global and inherited 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 restore](corso_restore.md) - Restore your service data
|Flag|Short|Default|Help
|:----|:-----|:-------|:----
|`--config-file`||`/home/runner/.corso.toml`|config file (default is $HOME/.corso)
|`--json`||`false`|output data in JSON format
|`--log-level`||`info`|set the log level to debug|info|warn|error