diff --git a/docs/docs/cli/corso_backup_create_exchange.md b/docs/docs/cli/corso_backup_create_exchange.md index b7022caf3..a438a63bf 100644 --- a/docs/docs/cli/corso_backup_create_exchange.md +++ b/docs/docs/cli/corso_backup_create_exchange.md @@ -7,15 +7,27 @@ hide_title: true Backup M365 Exchange service data ```bash -corso backup create exchange --all | --user [flags] +corso backup create exchange --user | '*' [flags] +``` + +### Examples + +```bash +# Backup all Exchange data for Alice +corso backup create exchange --user alice@example.com + +# Backup only Exchange contacts for Alice and Bob +corso backup create exchange --user alice@example.com,bob@example.com --data contacts + +# Backup all Exchange data for all M365 users +corso backup create exchange --user '*' ``` ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| -|`--all`||`false`|Backup all Exchange data for all users| -|`--user`||``|Backup Exchange data by user ID; accepts * to select all users| +|`--user`||``|Backup Exchange data by user ID; accepts '*' to select all users| |`--data`||``|Select one or more types of data to backup: email, contacts, or events| |`--help`|`-h`|`false`|help for exchange| diff --git a/docs/docs/cli/corso_backup_create_onedrive.md b/docs/docs/cli/corso_backup_create_onedrive.md index 2df53cc1d..6cc419550 100644 --- a/docs/docs/cli/corso_backup_create_onedrive.md +++ b/docs/docs/cli/corso_backup_create_onedrive.md @@ -7,14 +7,27 @@ hide_title: true Backup M365 OneDrive service data ```bash -corso backup create onedrive --user | * [flags] +corso backup create onedrive --user | '*' [flags] +``` + +### Examples + +```bash +# Backup OneDrive data for Alice +corso backup create onedrive --user alice@example.com + +# Backup OneDrive for Alice and Bob +corso backup create onedrive --user alice@example.com,bob@example.com + +# Backup all OneDrive data for all M365 users +corso backup create onedrive --user '*' ``` ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| -|`--user`||``|Backup OneDrive data by user ID; accepts * to select all users.
Required
| +|`--user`||``|Backup OneDrive data by user ID; accepts '*' to select all users.
Required
| |`--help`|`-h`|`false`|help for onedrive| ### Global and inherited flags diff --git a/docs/docs/cli/corso_backup_delete_exchange.md b/docs/docs/cli/corso_backup_delete_exchange.md index 7f399d902..10a76582f 100644 --- a/docs/docs/cli/corso_backup_delete_exchange.md +++ b/docs/docs/cli/corso_backup_delete_exchange.md @@ -10,6 +10,13 @@ Delete backed-up M365 Exchange service data corso backup delete exchange --backup [flags] ``` +### Examples + +```bash +# Delete Exchange backup with ID 1234abcd-12ab-cd34-56de-1234abcd +corso backup delete exchange --backup 1234abcd-12ab-cd34-56de-1234abcd +``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_backup_delete_onedrive.md b/docs/docs/cli/corso_backup_delete_onedrive.md index 4fbcb63f8..411f68b1e 100644 --- a/docs/docs/cli/corso_backup_delete_onedrive.md +++ b/docs/docs/cli/corso_backup_delete_onedrive.md @@ -10,6 +10,13 @@ Delete backed-up M365 OneDrive service data corso backup delete onedrive --backup [flags] ``` +### Examples + +```bash +# Delete OneDrive backup with ID 1234abcd-12ab-cd34-56de-1234abcd +corso backup delete onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd +``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_backup_details_exchange.md b/docs/docs/cli/corso_backup_details_exchange.md index a13200f6c..d0ceff1e4 100644 --- a/docs/docs/cli/corso_backup_details_exchange.md +++ b/docs/docs/cli/corso_backup_details_exchange.md @@ -10,27 +10,46 @@ Shows the details of a M365 Exchange service backup corso backup details exchange --backup [flags] ``` +### Examples + +```bash +# Explore Alice's items in backup 1234abcd-12ab-cd34-56de-1234abcd +corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd --user alice@example.com + +# Explore Alice's emails with subject containing "Hello world" in folder "Inbox" from a specific backup +corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com --email-subject "Hello world" --email-folder Inbox + +# Explore Bobs's events occurring after start of 2022 from a specific backup +corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user bob@example.com --event-starts-after 2022-01-01T00:00:00 + +# Explore Alice's contacts with name containing Andy from a specific backup +corso backup details exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com --contact-name Andy +``` + ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| |`--backup`|||ID of the backup to explore.
Required
| -|`--user`||``|Select backup details by user ID; accepts * to select all users.| -|`--email`||``|Select backup details for emails by email ID; accepts * to select all emails.| -|`--email-folder`||``|Select backup details for emails within a folder; accepts * to select all email folders.| +|`--user`||``|Select backup details by user ID; accepts '*' to select all users.| +|`--email`||``|Select backup details for emails by email ID; accepts '*' to select all emails.| +|`--email-folder`||``|Select backup details for emails within a folder; accepts '*' to select all email folders.| |`--email-subject`|||Select backup details for emails with a subject containing this value.| |`--email-sender`|||Select backup details for emails from a specific sender.| |`--email-received-after`|||Select backup details for emails received after this datetime.| |`--email-received-before`|||Select backup details for emails received before this datetime.| -|`--event`||``|Select backup details for events by event ID; accepts * to select all events.| -|`--event-calendar`||``|Select backup details for events under a calendar; accepts * to select all events.| +|`--event`||``|Select backup details for events by event ID; accepts '*' to select all events.| +|`--event-calendar`||``|Select backup details for events under a calendar; accepts '*' to select all events.| |`--event-subject`|||Select backup details for events with a subject containing this value.| |`--event-organizer`|||Select backup details for events from a specific organizer.| |`--event-recurs`|||Select backup details for recurring events. Use `--event-recurs false` to select non-recurring events.| |`--event-starts-after`|||Select backup details for events starting after this datetime.| |`--event-starts-before`|||Select backup details for events starting before this datetime.| -|`--contact`||``|Select backup details for contacts by contact ID; accepts * to select all contacts.| -|`--contact-folder`||``|Select backup details for contacts within a folder; accepts * to select all contact folders.| +|`--contact`||``|Select backup details for contacts by contact ID; accepts '*' to select all contacts.| +|`--contact-folder`||``|Select backup details for contacts within a folder; accepts '*' to select all contact folders.| |`--contact-name`|||Select backup details for contacts whose contact name contains this value.| |`--help`|`-h`|`false`|help for exchange| diff --git a/docs/docs/cli/corso_backup_details_onedrive.md b/docs/docs/cli/corso_backup_details_onedrive.md index 2a7c78063..c31bab9f7 100644 --- a/docs/docs/cli/corso_backup_details_onedrive.md +++ b/docs/docs/cli/corso_backup_details_onedrive.md @@ -10,17 +10,32 @@ Shows the details of a M365 OneDrive service backup corso backup details onedrive --backup [flags] ``` +### Examples + +```bash +# Explore Alice's files from backup 1234abcd-12ab-cd34-56de-1234abcd +corso backup details onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd --user alice@example.com + +# Explore Alice or Bob's files with name containing "Fiscal 22" in folder "Reports" +corso backup details onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com,bob@example.com --file-name "Fiscal 22" --folder "Reports" + +# Explore Alice's files created before end of 2015 from a specific backup +corso backup details onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com --file-created-before 2015-01-01T00:00:00 +``` + ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| |`--backup`|||ID of the backup to explore.
Required
| -|`--folder`||``|Select backup details by OneDrive folder; defaults to root| -|`--file-name`||``|Select backup details by OneDrive file name| -|`--file-created-after`|||Select files created after this datetime| -|`--file-created-before`|||Select files created before this datetime| -|`--file-modified-after`|||Select files modified after this datetime| -|`--file-modified-before`|||Select files modified before this datetime| +|`--folder`||``|Select backup details by OneDrive folder; defaults to root.| +|`--file`||``|Select backup details by file name or ID.| +|`--file-created-after`|||Select backup details for files created after this datetime.| +|`--file-created-before`|||Select backup details for files created before this datetime.| +|`--file-modified-after`|||Select backup details for files modified after this datetime.| +|`--file-modified-before`|||Select backup details for files modified before this datetime.| |`--help`|`-h`|`false`|help for onedrive| ### Global and inherited flags diff --git a/docs/docs/cli/corso_backup_list_exchange.md b/docs/docs/cli/corso_backup_list_exchange.md index 1d388e30d..797f56275 100644 --- a/docs/docs/cli/corso_backup_list_exchange.md +++ b/docs/docs/cli/corso_backup_list_exchange.md @@ -10,6 +10,7 @@ List the history of M365 Exchange service backups corso backup list exchange [flags] ``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_backup_list_onedrive.md b/docs/docs/cli/corso_backup_list_onedrive.md index 6706a8822..75b62daf6 100644 --- a/docs/docs/cli/corso_backup_list_onedrive.md +++ b/docs/docs/cli/corso_backup_list_onedrive.md @@ -10,6 +10,7 @@ List the history of M365 OneDrive service backups corso backup list onedrive [flags] ``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_env.md b/docs/docs/cli/corso_env.md index b58f9d0b6..4674571eb 100644 --- a/docs/docs/cli/corso_env.md +++ b/docs/docs/cli/corso_env.md @@ -10,6 +10,7 @@ A guide to using environment variables in Corso. corso env [flags] ``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_repo_connect_s3.md b/docs/docs/cli/corso_repo_connect_s3.md index 4c49a1b3f..1acd4c9b4 100644 --- a/docs/docs/cli/corso_repo_connect_s3.md +++ b/docs/docs/cli/corso_repo_connect_s3.md @@ -10,6 +10,19 @@ Ensures a connection to an existing S3 repository. corso repo connect s3 --bucket [flags] ``` +### Examples + +```bash +# Connect to a Corso repo in AWS S3 bucket named "my-bucket" +corso repo connect s3 --bucket my-bucket + +# Connect to a Corso repo in AWS S3 bucket named "my-bucket" using a prefix +corso repo connect s3 --bucket my-bucket --prefix my-prefix + +# Connect to a Corso repo in an S3 compliant storage provider +corso repo connect s3 --bucket my-bucket --endpoint https://my-s3-server-endpoint +``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_repo_init_s3.md b/docs/docs/cli/corso_repo_init_s3.md index 3349ad14d..7d2e244f1 100644 --- a/docs/docs/cli/corso_repo_init_s3.md +++ b/docs/docs/cli/corso_repo_init_s3.md @@ -10,6 +10,19 @@ Bootstraps a new S3 repository and connects it to your m356 account. corso repo init s3 --bucket [flags] ``` +### Examples + +```bash +# Create a new Corso repo in AWS S3 bucket named "my-bucket" +corso repo init s3 --bucket my-bucket + +# Create a new Corso repo in AWS S3 bucket named "my-bucket" using a prefix +corso repo init s3 --bucket my-bucket --prefix my-prefix + +# Create a new Corso repo in an S3 compliant storage provider +corso repo init s3 --bucket my-bucket --endpoint https://my-s3-server-endpoint +``` + ### Flags |Flag|Short|Default|Help| diff --git a/docs/docs/cli/corso_restore_exchange.md b/docs/docs/cli/corso_restore_exchange.md index 640707430..6ea0ce454 100644 --- a/docs/docs/cli/corso_restore_exchange.md +++ b/docs/docs/cli/corso_restore_exchange.md @@ -10,27 +10,45 @@ Restore M365 Exchange service data corso restore exchange --backup [flags] ``` +### Examples + +```bash +# Restore emails with ID 98765abcdef and 12345abcdef from a specific backup +corso restore exchange --backup 1234abcd-12ab-cd34-56de-1234abcd --email 98765abcdef,12345abcdef + +# Restore Alice's emails with subject containing "Hello world" in "Inbox" from a specific backup +corso restore exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com --email-subject "Hello world" --email-folder Inbox + +# Restore Bobs's entire calendar from a specific backup +corso restore exchange --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user bob@example.com --event-calendar Calendar + +# Restore contact with ID abdef0101 from a specific backup +corso restore exchange --backup 1234abcd-12ab-cd34-56de-1234abcd --contact abdef0101 +``` + ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| |`--backup`|||ID of the backup to restore.
Required
| -|`--user`||``|Restore data by user ID; accepts * to select all users.| -|`--email`||``|Restore emails by ID; accepts * to select all emails.| -|`--email-folder`||``|Restore emails within a folder; accepts * to select all email folders.| +|`--user`||``|Restore data by user ID; accepts '*' to select all users.| +|`--email`||``|Restore emails by ID; accepts '*' to select all emails.| +|`--email-folder`||``|Restore emails within a folder; accepts '*' to select all email folders.| |`--email-subject`|||Restore emails with a subject containing this value.| |`--email-sender`|||Restore emails from a specific sender.| |`--email-received-after`|||Restore emails received after this datetime.| |`--email-received-before`|||Restore emails received before this datetime.| -|`--event`||``|Restore events by event ID; accepts * to select all events.| -|`--event-calendar`||``|Restore events under a calendar; accepts * to select all event calendars.| +|`--event`||``|Restore events by event ID; accepts '*' to select all events.| +|`--event-calendar`||``|Restore events under a calendar; accepts '*' to select all event calendars.| |`--event-subject`|||Restore events with a subject containing this value.| |`--event-organizer`|||Restore events from a specific organizer.| |`--event-recurs`|||Restore recurring events. Use `--event-recurs false` to restore non-recurring events.| |`--event-starts-after`|||Restore events starting after this datetime.| |`--event-starts-before`|||Restore events starting before this datetime.| -|`--contact`||``|Restore contacts by contact ID; accepts * to select all contacts.| -|`--contact-folder`||``|Restore contacts within a folder; accepts * to select all contact folders.| +|`--contact`||``|Restore contacts by contact ID; accepts '*' to select all contacts.| +|`--contact-folder`||``|Restore contacts within a folder; accepts '*' to select all contact folders.| |`--contact-name`|||Restore contacts whose contact name contains this value.| |`--help`|`-h`|`false`|help for exchange| diff --git a/docs/docs/cli/corso_restore_onedrive.md b/docs/docs/cli/corso_restore_onedrive.md index 9b4ad5be6..30de482d8 100644 --- a/docs/docs/cli/corso_restore_onedrive.md +++ b/docs/docs/cli/corso_restore_onedrive.md @@ -10,14 +10,29 @@ Restore M365 OneDrive service data corso restore onedrive --backup [flags] ``` +### Examples + +```bash +# Restore file with ID 98765abcdef +corso restore onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd --file 98765abcdef + +# Restore Alice's file named "FY2021 Planning.xlsx in "Documents/Finance Reports" from a specific backup +corso restore onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd \ + --user alice@example.com --file "FY2021 Planning.xlsx" --folder "Documents/Finance Reports" + +# Restore all files from Bob's folder that were created before 2020 when captured in a specific backup +corso restore onedrive --backup 1234abcd-12ab-cd34-56de-1234abcd + --user bob@example.com --folder "Documents/Finance Reports" --file-created-before 2020-01-01T00:00:00 +``` + ### Flags |Flag|Short|Default|Help| |:----|:-----|:-------|:----| |`--backup`|||ID of the backup to restore.
Required
| -|`--user`||``|Restore data by user ID; accepts * to select all users.| +|`--user`||``|Restore data by user ID; accepts '*' to select all users.| |`--folder`||``|Restore items by OneDrive folder; defaults to root| -|`--file-name`||``|Restore items by OneDrive file name| +|`--file`||``|Restore items by file name or ID| |`--file-created-after`|||Restore files created after this datetime| |`--file-created-before`|||Restore files created before this datetime| |`--file-modified-after`|||Restore files modified after this datetime|