diff --git a/docs/docs/cli/corso_backup_create_exchange.md b/docs/docs/cli/corso_backup_create_exchange.md index 9d7cb4c18..adc74c25e 100644 --- a/docs/docs/cli/corso_backup_create_exchange.md +++ b/docs/docs/cli/corso_backup_create_exchange.md @@ -12,17 +12,18 @@ corso backup create exchange [flags] ### Flags -|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 +|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| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_create_onedrive.md b/docs/docs/cli/corso_backup_create_onedrive.md new file mode 100644 index 000000000..fc9357a3b --- /dev/null +++ b/docs/docs/cli/corso_backup_create_onedrive.md @@ -0,0 +1,27 @@ +--- +title: corso backup create onedrive +hide_title: true +--- +## corso backup create onedrive + +Backup M365 OneDrive service data + +```bash +corso backup create onedrive [flags] +``` + +### Flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--help`|`-h`|`false`|help for onedrive| +|`--user`||`[]`|Backup OneDrive data by user ID; accepts * to select all users| + +### Global and inherited flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_delete_exchange.md b/docs/docs/cli/corso_backup_delete_exchange.md index f59b741c5..f5b226cea 100644 --- a/docs/docs/cli/corso_backup_delete_exchange.md +++ b/docs/docs/cli/corso_backup_delete_exchange.md @@ -12,15 +12,16 @@ corso backup delete exchange [flags] ### Flags -|Flag|Short|Default|Help -|:----|:-----|:-------|:---- -|`--backup`|||ID of the backup containing the details to be shown -|`--help`|`-h`|`false`|help for exchange +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--backup`|||ID of the backup containing the details to be shown| +|`--help`|`-h`|`false`|help for exchange| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_delete_onedrive.md b/docs/docs/cli/corso_backup_delete_onedrive.md new file mode 100644 index 000000000..8569b386b --- /dev/null +++ b/docs/docs/cli/corso_backup_delete_onedrive.md @@ -0,0 +1,27 @@ +--- +title: corso backup delete onedrive +hide_title: true +--- +## corso backup delete onedrive + +Delete backed-up M365 OneDrive service data + +```bash +corso backup delete onedrive [flags] +``` + +### Flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--backup`|||ID of the backup containing the details to be shown| +|`--help`|`-h`|`false`|help for onedrive| + +### Global and inherited flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_details_exchange.md b/docs/docs/cli/corso_backup_details_exchange.md index c930131ae..bd3f66fc1 100644 --- a/docs/docs/cli/corso_backup_details_exchange.md +++ b/docs/docs/cli/corso_backup_details_exchange.md @@ -12,32 +12,33 @@ corso backup details exchange [flags] ### Flags -|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 +|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| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_details_onedrive.md b/docs/docs/cli/corso_backup_details_onedrive.md new file mode 100644 index 000000000..d19d57709 --- /dev/null +++ b/docs/docs/cli/corso_backup_details_onedrive.md @@ -0,0 +1,27 @@ +--- +title: corso backup details onedrive +hide_title: true +--- +## corso backup details onedrive + +Shows the details of a M365 OneDrive service backup + +```bash +corso backup details onedrive [flags] +``` + +### Flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--backup`|||ID of the backup containing the details to be shown| +|`--help`|`-h`|`false`|help for onedrive| + +### Global and inherited flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_list_exchange.md b/docs/docs/cli/corso_backup_list_exchange.md index ecdd1d111..1d388e30d 100644 --- a/docs/docs/cli/corso_backup_list_exchange.md +++ b/docs/docs/cli/corso_backup_list_exchange.md @@ -12,14 +12,15 @@ corso backup list exchange [flags] ### Flags -|Flag|Short|Default|Help -|:----|:-----|:-------|:---- -|`--help`|`-h`|`false`|help for exchange +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--help`|`-h`|`false`|help for exchange| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_backup_list_onedrive.md b/docs/docs/cli/corso_backup_list_onedrive.md new file mode 100644 index 000000000..6706a8822 --- /dev/null +++ b/docs/docs/cli/corso_backup_list_onedrive.md @@ -0,0 +1,26 @@ +--- +title: corso backup list onedrive +hide_title: true +--- +## corso backup list onedrive + +List the history of M365 OneDrive service backups + +```bash +corso backup list onedrive [flags] +``` + +### Flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--help`|`-h`|`false`|help for onedrive| + +### Global and inherited flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_env.md b/docs/docs/cli/corso_env.md index 5855227c2..b58f9d0b6 100644 --- a/docs/docs/cli/corso_env.md +++ b/docs/docs/cli/corso_env.md @@ -12,14 +12,15 @@ corso env [flags] ### Flags -|Flag|Short|Default|Help -|:----|:-----|:-------|:---- -|`--help`|`-h`|`false`|help for env +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--help`|`-h`|`false`|help for env| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_repo_connect_s3.md b/docs/docs/cli/corso_repo_connect_s3.md index 430fdbcad..c42533362 100644 --- a/docs/docs/cli/corso_repo_connect_s3.md +++ b/docs/docs/cli/corso_repo_connect_s3.md @@ -12,17 +12,18 @@ corso repo connect s3 [flags] ### Flags -|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. +|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.| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_repo_init_s3.md b/docs/docs/cli/corso_repo_init_s3.md index c148a8d39..2270c608e 100644 --- a/docs/docs/cli/corso_repo_init_s3.md +++ b/docs/docs/cli/corso_repo_init_s3.md @@ -12,17 +12,18 @@ corso repo init s3 [flags] ### Flags -|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. +|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.| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_restore_exchange.md b/docs/docs/cli/corso_restore_exchange.md index aa7fc679e..8960b310e 100644 --- a/docs/docs/cli/corso_restore_exchange.md +++ b/docs/docs/cli/corso_restore_exchange.md @@ -12,32 +12,33 @@ corso restore exchange [flags] ### Flags -|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 +|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| ### 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 +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering| diff --git a/docs/docs/cli/corso_restore_onedrive.md b/docs/docs/cli/corso_restore_onedrive.md new file mode 100644 index 000000000..1d8b3a2fc --- /dev/null +++ b/docs/docs/cli/corso_restore_onedrive.md @@ -0,0 +1,28 @@ +--- +title: corso restore onedrive +hide_title: true +--- +## corso restore onedrive + +Restore M365 OneDrive service data + +```bash +corso restore onedrive [flags] +``` + +### Flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--backup`|||ID of the backup to restore| +|`--help`|`-h`|`false`|help for onedrive| +|`--user`||`[]`|Restore all data by user ID; accepts * to select all users| + +### Global and inherited flags + +|Flag|Short|Default|Help| +|:----|:-----|:-------|:----| +|`--config-file`||`$HOME/.corso.toml`|config file location (default is $HOME/.corso.toml)| +|`--json`||`false`|output data in JSON format| +|`--log-level`||`info`|set the log level to debug|info|warn|error| +|`--no-stats`||`false`|disable anonymous usage statistics gathering|