Skip to content

Update CLI descriptions: misspellings & group ID explanations #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
katrinleinweber wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update CLI descriptions: misspellings & group ID explanations #405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f98ea5d
Correct minor misspellings
katrinleinweber Oct 22, 2025
3db4bb3
Clarify group IDs & paths in CLI documentation
katrinleinweber Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,13 @@ Options:
--fu <FETCH URL>
The GitLab instance URL for fetch repositories (example: https://gitlab.local/) [env: GTLBSTR_FETCH_URL=]
--ft <FETCH TOKEN>
Your personal GitLab token for fetch repositories [env: GTLBSTR_FETCH_TOKEN=]
Your personal GitLab token for fetching repositories [env: GTLBSTR_FETCH_TOKEN=]
--bu <BACKUP URL>
The GitLab instance URL for backup repositories (example: https://backup-gitlab.local/) [env: GTLBSTR_BACKUP_URL=]
The GitLab instance URL for backup repositories (example: <https://backup-gitlab.local>) [env: GTLBSTR_BACKUP_URL=]
--bt <BACKUP TOKEN>
Your personal GitLab token for backup repositories [env: GTLBSTR_BACKUP_TOKEN=]
--bg <BACKUP GROUP>
A target created group on backup GitLab for push repositories [env: GTLBSTR_BACKUP_GROUP=]
--bg <BACKUP GROUP ID>
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 <PATTERN>
Include regexp patterns (cannot be used together with --exclude flag, may be repeated) [env: GTLBSTR_INCLUDE=]
-x, --exclude <PATTERN>
Expand All @@ -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 <GROUP>
Download projects only in group [env: GTLBSTR_GROUP=]
--group <GROUP ID>
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
Expand Down
14 changes: 7 additions & 7 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://gitlab.local>)
/// The GitLab instance URL for fetching repositories (example: <https://gitlab.local>)
#[arg(
long,
value_parser,
Expand All @@ -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,
Expand All @@ -46,12 +46,12 @@ struct Cli {
)]
bt: Option<String>,

/// 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<String>,

Expand All @@ -63,7 +63,7 @@ struct Cli {
#[arg(short = 'x', long, env = "GTLBSTR_EXCLUDE", value_name = "PATTERN")]
exclude: Option<Vec<String>>,

/// A destination local folder for save downloaded repositories
/// A destination local folder for saving downloaded repositories
#[arg(
long,
short,
Expand Down Expand Up @@ -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<String>,

/// Enable download by ssh instead of http. An authorized ssh key is required
Expand Down