diff --git a/docs/docs/cli/corso_backup_create_exchange.md b/docs/docs/cli/corso_backup_create_exchange.md index e00de67f6..9d7cb4c18 100644 --- a/docs/docs/cli/corso_backup_create_exchange.md +++ b/docs/docs/cli/corso_backup_create_exchange.md @@ -1,33 +1,28 @@ --- -title: "corso backup create exchange" +title: corso backup create exchange hide_title: true --- ## corso backup create exchange Backup M365 Exchange service data -``` +```bash corso backup create exchange [flags] ``` -### Options +### Flags -``` - --all Backup all Exchange data for all users - --data strings Select one or more types of data to backup: email, contacts, or events - -h, --help help for exchange - --user strings Backup Exchange data by user ID; accepts * to select all users -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--all`||`false`|Backup all Exchange data for all users +|`--data`||`[]`|Select one or more types of data to backup: email, contacts, or events +|`--help`|`-h`|`false`|help for exchange +|`--user`||`[]`|Backup Exchange data by user ID; accepts * to select all users -### 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 create](corso_backup_create.md) - Backup an M365 Service +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_backup_delete_exchange.md b/docs/docs/cli/corso_backup_delete_exchange.md index 096a21aa7..f59b741c5 100644 --- a/docs/docs/cli/corso_backup_delete_exchange.md +++ b/docs/docs/cli/corso_backup_delete_exchange.md @@ -1,31 +1,26 @@ --- -title: "corso backup delete exchange" +title: corso backup delete exchange hide_title: true --- ## corso backup delete exchange Delete backed-up M365 Exchange service data -``` +```bash corso backup delete exchange [flags] ``` -### Options +### Flags -``` - --backup string ID of the backup containing the details to be shown - -h, --help help for exchange -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--backup`|||ID of the backup containing the details to be shown +|`--help`|`-h`|`false`|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 +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_backup_details_exchange.md b/docs/docs/cli/corso_backup_details_exchange.md index e9a4246bd..c930131ae 100644 --- a/docs/docs/cli/corso_backup_details_exchange.md +++ b/docs/docs/cli/corso_backup_details_exchange.md @@ -1,48 +1,43 @@ --- -title: "corso backup details exchange" +title: corso backup details exchange hide_title: true --- ## corso backup details exchange Shows the details of a M365 Exchange service backup -``` +```bash corso backup details exchange [flags] ``` -### Options +### 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 - --contact-name string Select backup details where the contact name contains this value - --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 folders - --email-received-after string Restore mail where the email was received after this datetime - --email-received-before string Restore mail where the email was received before this datetime - --email-sender string Restore mail where the email sender matches this user id - --email-subject string Restore mail 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 - --event-organizer string Select backup details where the event organizer user id contains this value - --event-recurs string Select backup details if the event recurs. Use --event-recurs false to select where the event does not recur. - --event-starts-after string Select backup details where the event starts after this datetime - --event-starts-before string Select backup details where the event starts before this datetime - --event-subject string Select backup details where the event subject contains this value - -h, --help help for exchange - --user strings Select backup details by user ID; accepts * to select all users -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--backup`|||ID of the backup containing the details to be shown +|`--contact`||`[]`|Select backup details by contact ID; accepts * to select all contacts +|`--contact-folder`||`[]`|Select backup details by contact folder ID; accepts * to select all contact folders +|`--contact-name`|||Select backup details where the contact name contains this value +|`--email`||`[]`|Select backup details by emails ID; accepts * to select all emails +|`--email-folder`||`[]`|Select backup details by email folder ID; accepts * to select all email folders +|`--email-received-after`|||Restore mail where the email was received after this datetime +|`--email-received-before`|||Restore mail where the email was received before this datetime +|`--email-sender`|||Restore mail where the email sender matches this user id +|`--email-subject`|||Restore mail where the email subject lines contain this value +|`--event`||`[]`|Select backup details by event ID; accepts * to select all events +|`--event-calendar`||`[]`|Select backup details by event calendar ID; accepts * to select all events +|`--event-organizer`|||Select backup details where the event organizer user id contains this value +|`--event-recurs`|||Select backup details if the event recurs. Use --event-recurs false to select where the event does not recur. +|`--event-starts-after`|||Select backup details where the event starts after this datetime +|`--event-starts-before`|||Select backup details where the event starts before this datetime +|`--event-subject`|||Select backup details where the event subject contains this value +|`--help`|`-h`|`false`|help for exchange +|`--user`||`[]`|Select backup details by user ID; accepts * to select all users -### 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 details](corso_backup_details.md) - Shows the details of a backup for a service +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_backup_list_exchange.md b/docs/docs/cli/corso_backup_list_exchange.md index 42ac23219..ecdd1d111 100644 --- a/docs/docs/cli/corso_backup_list_exchange.md +++ b/docs/docs/cli/corso_backup_list_exchange.md @@ -1,30 +1,25 @@ --- -title: "corso backup list exchange" +title: corso backup list exchange hide_title: true --- ## corso backup list exchange List the history of M365 Exchange service backups -``` +```bash corso backup list exchange [flags] ``` -### Options +### Flags -``` - -h, --help help for exchange -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--help`|`-h`|`false`|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 list](corso_backup_list.md) - List the history of backups for a service +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_env.md b/docs/docs/cli/corso_env.md index c6b300363..5855227c2 100644 --- a/docs/docs/cli/corso_env.md +++ b/docs/docs/cli/corso_env.md @@ -1,34 +1,25 @@ --- -title: "corso env" +title: corso env hide_title: true --- ## corso env -env var guide - -### Synopsis - A guide to using environment variables in Corso. -``` +```bash corso env [flags] ``` -### Options +### Flags -``` - -h, --help help for env -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--help`|`-h`|`false`|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. +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_repo_connect_s3.md b/docs/docs/cli/corso_repo_connect_s3.md index e9edebf5d..430fdbcad 100644 --- a/docs/docs/cli/corso_repo_connect_s3.md +++ b/docs/docs/cli/corso_repo_connect_s3.md @@ -1,37 +1,28 @@ --- -title: "corso repo connect s3" +title: corso repo connect s3 hide_title: true --- ## corso repo connect s3 -Connect to a S3 repository - -### Synopsis - Ensures a connection to an existing S3 repository. -``` +```bash corso repo connect s3 [flags] ``` -### Options +### Flags -``` - --bucket string Name of the S3 bucket (required). - --endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") - -h, --help help for s3 - --prefix string Prefix applied to objects in the bucket. -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--bucket`|||Name of the S3 bucket (required). +|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication. +|`--help`|`-h`|`false`|help for s3 +|`--prefix`|||Prefix applied to objects in the bucket. -### 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 repo connect](corso_repo_connect.md) - Connect to a repository. +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_repo_init_s3.md b/docs/docs/cli/corso_repo_init_s3.md index 8557edbdc..c148a8d39 100644 --- a/docs/docs/cli/corso_repo_init_s3.md +++ b/docs/docs/cli/corso_repo_init_s3.md @@ -1,37 +1,28 @@ --- -title: "corso repo init s3" +title: corso repo init s3 hide_title: true --- ## corso repo init s3 -Initialize a S3 repository - -### Synopsis - Bootstraps a new S3 repository and connects it to your m356 account. -``` +```bash corso repo init s3 [flags] ``` -### Options +### Flags -``` - --bucket string Name of the S3 bucket (required). - --endpoint string Server endpoint for S3 communication. (default "s3.amazonaws.com") - -h, --help help for s3 - --prefix string Prefix applied to objects in the bucket. -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--bucket`|||Name of the S3 bucket (required). +|`--endpoint`||`s3.amazonaws.com`|Server endpoint for S3 communication. +|`--help`|`-h`|`false`|help for s3 +|`--prefix`|||Prefix applied to objects in the bucket. -### 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 repo init](corso_repo_init.md) - Initialize a repository. +### Global and inherited flags +|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 diff --git a/docs/docs/cli/corso_restore_exchange.md b/docs/docs/cli/corso_restore_exchange.md index 7301b134d..aa7fc679e 100644 --- a/docs/docs/cli/corso_restore_exchange.md +++ b/docs/docs/cli/corso_restore_exchange.md @@ -1,48 +1,43 @@ --- -title: "corso restore exchange" +title: corso restore exchange hide_title: true --- ## corso restore exchange Restore M365 Exchange service data -``` +```bash corso restore exchange [flags] ``` -### Options +### Flags -``` - --backup string ID of the backup to restore - --contact strings Restore contacts by ID; accepts * to select all contacts - --contact-folder strings Restore all contacts within the folder ID; accepts * to select all contact folders - --contact-name string Restore contacts where the contact name contains this value - --email strings Restore emails by ID; accepts * to select all emails - --email-folder strings Restore all emails by folder ID; accepts * to select all email folders - --email-received-after string Restore mail where the email was received after this datetime - --email-received-before string Restore mail where the email was received before this datetime - --email-sender string Restore mail where the email sender matches this user id - --email-subject string Restore mail where the email subject lines contain this value - --event strings Restore events by ID; accepts * to select all events - --event-calendar strings Restore events by calendar ID; accepts * to select all event calendars - --event-organizer string Restore events where the event organizer user id contains this value - --event-recurs string Restore events if the event recurs. Use --event-recurs false to select where the event does not recur. - --event-starts-after string Restore events where the event starts after this datetime - --event-starts-before string Restore events where the event starts before this datetime - --event-subject string Restore events where the event subject contains this value - -h, --help help for exchange - --user strings Restore all data by user ID; accepts * to select all users -``` +|Flag|Short|Default|Help +|:----|:-----|:-------|:---- +|`--backup`|||ID of the backup to restore +|`--contact`||`[]`|Restore contacts by ID; accepts * to select all contacts +|`--contact-folder`||`[]`|Restore all contacts within the folder ID; accepts * to select all contact folders +|`--contact-name`|||Restore contacts where the contact name contains this value +|`--email`||`[]`|Restore emails by ID; accepts * to select all emails +|`--email-folder`||`[]`|Restore all emails by folder ID; accepts * to select all email folders +|`--email-received-after`|||Restore mail where the email was received after this datetime +|`--email-received-before`|||Restore mail where the email was received before this datetime +|`--email-sender`|||Restore mail where the email sender matches this user id +|`--email-subject`|||Restore mail where the email subject lines contain this value +|`--event`||`[]`|Restore events by ID; accepts * to select all events +|`--event-calendar`||`[]`|Restore events by calendar ID; accepts * to select all event calendars +|`--event-organizer`|||Restore events where the event organizer user id contains this value +|`--event-recurs`|||Restore events if the event recurs. Use --event-recurs false to select where the event does not recur. +|`--event-starts-after`|||Restore events where the event starts after this datetime +|`--event-starts-before`|||Restore events where the event starts before this datetime +|`--event-subject`|||Restore events where the event subject contains this value +|`--help`|`-h`|`false`|help for exchange +|`--user`||`[]`|Restore all data by user ID; accepts * to select all users -### 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 restore](corso_restore.md) - Restore your service data +### Global and inherited flags +|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