diff --git a/README.md b/README.md index 2b6bc33..3d3db96 100644 --- a/README.md +++ b/README.md @@ -140,13 +140,13 @@ Options: --fu The GitLab instance URL for fetch repositories (example: https://gitlab.local/) [env: GTLBSTR_FETCH_URL=] --ft - Your personal GitLab token for fetch repositories [env: GTLBSTR_FETCH_TOKEN=] + Your personal GitLab token for fetching repositories [env: GTLBSTR_FETCH_TOKEN=] --bu - The GitLab instance URL for backup repositories (example: https://backup-gitlab.local/) [env: GTLBSTR_BACKUP_URL=] + The GitLab instance URL for backup repositories (example: ) [env: GTLBSTR_BACKUP_URL=] --bt Your personal GitLab token for backup repositories [env: GTLBSTR_BACKUP_TOKEN=] - --bg - A target created group on backup GitLab for push repositories [env: GTLBSTR_BACKUP_GROUP=] + --bg + A target created group on backup GitLab for pushing repositories. Besides the numeric ID, the encoded path can also be used, see https://docs.gitlab.com/api/rest/#encoding [env: GTLBSTR_BACKUP_GROUP=] -i, --include Include regexp patterns (cannot be used together with --exclude flag, may be repeated) [env: GTLBSTR_INCLUDE=] -x, --exclude @@ -167,8 +167,8 @@ Options: Download projects explicitly owned by user [env: GTLBSTR_ONLY_OWNED=] --only-membership Download only user's projects [env: GTLBSTR_ONLY_MEMBERSHIP=] - --group - Download projects only in group [env: GTLBSTR_GROUP=] + --group + Download projects only in group. Besides the numeric ID, the encoded path can also be used, see https://docs.gitlab.com/api/rest/#encoding [env: GTLBSTR_GROUP=] --download-ssh Enable download by ssh instead of http. An authorized ssh key is required [env: GTLBSTR_DOWNLOAD_SSH=] --upload-ssh diff --git a/src/cli.rs b/src/cli.rs index 3668100..b7a8fa9 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -10,7 +10,7 @@ use anyhow::{bail, Result}; #[command(author, version, about)] /// A tool for cloning all available repositories in a GitLab instance struct Cli { - /// The GitLab instance URL for fetch repositories (example: ) + /// The GitLab instance URL for fetching repositories (example: ) #[arg( long, value_parser, @@ -19,7 +19,7 @@ struct Cli { )] fu: String, - /// Your personal GitLab token for fetch repositories + /// Your personal GitLab token for fetching repositories #[arg( long, value_parser, @@ -46,12 +46,12 @@ struct Cli { )] bt: Option, - /// A target created group on backup GitLab for push repositories + /// A target created group on backup GitLab for pushing repositories. Besides the numeric ID, the encoded path can also be used, see https://docs.gitlab.com/api/rest/#encoding #[arg( long, value_parser, env = "GTLBSTR_BACKUP_GROUP", - value_name = "BACKUP GROUP" + value_name = "BACKUP GROUP ID" )] bg: Option, @@ -63,7 +63,7 @@ struct Cli { #[arg(short = 'x', long, env = "GTLBSTR_EXCLUDE", value_name = "PATTERN")] exclude: Option>, - /// A destination local folder for save downloaded repositories + /// A destination local folder for saving downloaded repositories #[arg( long, short, @@ -112,8 +112,8 @@ struct Cli { #[arg(long, env = "GTLBSTR_ONLY_MEMBERSHIP")] only_membership: bool, - /// Download projects only in group - #[arg(long, env = "GTLBSTR_GROUP")] + /// Download projects only in group. Besides the numeric ID, the encoded path can also be used, see https://docs.gitlab.com/api/rest/#encoding + #[arg(long, value_name = "GROUP ID", env = "GTLBSTR_GROUP")] group: Option, /// Enable download by ssh instead of http. An authorized ssh key is required