diff --git a/docs/Makefile b/docs/Makefile index df96b51f4..0d1e3e3b9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -45,6 +45,7 @@ build: genclidocs genclidocs: ${MDGEN_BINARY} @echo 'Auto-generating Corso CLI docs...' + rm -rf docs/cli docker run --rm -it \ -v ${CORSO_REPO}:${CORSO_REPO_CONTAINER} -v ${CORSO_BUILD_DIR}:${CORSO_BUILD_DIR} \ --workdir ${CORSO_REPO_CONTAINER}/src \ diff --git a/docs/docs/cli/corso.md b/docs/docs/cli/corso.md deleted file mode 100644 index 192efd68c..000000000 --- a/docs/docs/cli/corso.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "corso" -hide_title: true ---- -## corso - -Protect your Microsoft 365 data. - -### Synopsis - -Reliable, secure, and efficient data protection for Microsoft 365. - -``` -corso [flags] -``` - -### Options - -``` - --config-file string config file (default is $HOME/.corso) (default "/home/runner/.corso.toml") - -h, --help help for corso - --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 -``` - -### SEE ALSO - -* [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 restore](corso_restore.md) - Restore your service data - diff --git a/docs/docs/cli/corso_backup.md b/docs/docs/cli/corso_backup.md deleted file mode 100644 index 8df90c463..000000000 --- a/docs/docs/cli/corso_backup.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "corso backup" -hide_title: true ---- -## corso backup - -Backup your service data - -### Synopsis - -Backup the data stored in one of your M365 services. - -``` -corso backup [flags] -``` - -### Options - -``` - -h, --help help for backup -``` - -### 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. -* [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 list](corso_backup_list.md) - List the history of backups for a service - diff --git a/docs/docs/cli/corso_backup_create.md b/docs/docs/cli/corso_backup_create.md deleted file mode 100644 index 77d4fc232..000000000 --- a/docs/docs/cli/corso_backup_create.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "corso backup create" -hide_title: true ---- -## corso backup create - -Backup an M365 Service - -``` -corso backup create [flags] -``` - -### Options - -``` - -h, --help help for create -``` - -### 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 create exchange](corso_backup_create_exchange.md) - Backup M365 Exchange service data - diff --git a/docs/docs/cli/corso_backup_delete.md b/docs/docs/cli/corso_backup_delete.md deleted file mode 100644 index 765c24401..000000000 --- a/docs/docs/cli/corso_backup_delete.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -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 - diff --git a/docs/docs/cli/corso_backup_details.md b/docs/docs/cli/corso_backup_details.md deleted file mode 100644 index 416ef9c84..000000000 --- a/docs/docs/cli/corso_backup_details.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "corso backup details" -hide_title: true ---- -## corso backup details - -Shows the details of a backup for a service - -``` -corso backup details [flags] -``` - -### Options - -``` - -h, --help help for details -``` - -### 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 details exchange](corso_backup_details_exchange.md) - Shows the details of a M365 Exchange service backup - diff --git a/docs/docs/cli/corso_backup_list.md b/docs/docs/cli/corso_backup_list.md deleted file mode 100644 index a690486d2..000000000 --- a/docs/docs/cli/corso_backup_list.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "corso backup list" -hide_title: true ---- -## corso backup list - -List the history of backups for a service - -``` -corso backup list [flags] -``` - -### Options - -``` - -h, --help help for list -``` - -### 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 list exchange](corso_backup_list_exchange.md) - List the history of M365 Exchange service backups - diff --git a/docs/docs/cli/corso_repo.md b/docs/docs/cli/corso_repo.md deleted file mode 100644 index 635e0a56c..000000000 --- a/docs/docs/cli/corso_repo.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "corso repo" -hide_title: true ---- -## corso repo - -Manage your repositories - -### Synopsis - -Initialize, configure, and connect to your account backup repositories. - -``` -corso repo [flags] -``` - -### Options - -``` - -h, --help help for repo -``` - -### 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. -* [corso repo connect](corso_repo_connect.md) - Connect to a repository. -* [corso repo init](corso_repo_init.md) - Initialize a repository. - diff --git a/docs/docs/cli/corso_repo_connect.md b/docs/docs/cli/corso_repo_connect.md deleted file mode 100644 index 71401fc1d..000000000 --- a/docs/docs/cli/corso_repo_connect.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "corso repo connect" -hide_title: true ---- -## corso repo connect - -Connect to a repository. - -### Synopsis - -Connect to an existing repository. - -``` -corso repo connect [flags] -``` - -### Options - -``` - -h, --help help for connect -``` - -### 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](corso_repo.md) - Manage your repositories -* [corso repo connect s3](corso_repo_connect_s3.md) - Connect to a S3 repository - diff --git a/docs/docs/cli/corso_repo_init.md b/docs/docs/cli/corso_repo_init.md deleted file mode 100644 index c8ccfb99e..000000000 --- a/docs/docs/cli/corso_repo_init.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "corso repo init" -hide_title: true ---- -## corso repo init - -Initialize a repository. - -### Synopsis - -Create a new repository to store your backups. - -``` -corso repo init [flags] -``` - -### Options - -``` - -h, --help help for init -``` - -### 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](corso_repo.md) - Manage your repositories -* [corso repo init s3](corso_repo_init_s3.md) - Initialize a S3 repository - diff --git a/docs/docs/cli/corso_restore.md b/docs/docs/cli/corso_restore.md deleted file mode 100644 index 144612641..000000000 --- a/docs/docs/cli/corso_restore.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "corso restore" -hide_title: true ---- -## corso restore - -Restore your service data - -### Synopsis - -Restore the data stored in one of your M365 services. - -``` -corso restore [flags] -``` - -### Options - -``` - -h, --help help for restore -``` - -### 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. -* [corso restore exchange](corso_restore_exchange.md) - Restore M365 Exchange service data - diff --git a/docs/sidebars.js b/docs/sidebars.js index 22eba8a1d..6b9ecddf8 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -28,6 +28,7 @@ const sidebars = { label: 'Command Line Reference', link: { slug: 'cli/corso', + description: 'Explore the commonly used Corso CLI commands', type: 'generated-index', }, items: [