diff --git a/GithubBackup.Cli/Commands/Github/Backup/BackupCommand.cs b/GithubBackup.Cli/Commands/Github/Backup/BackupCommand.cs index 5f7edee..855fe76 100644 --- a/GithubBackup.Cli/Commands/Github/Backup/BackupCommand.cs +++ b/GithubBackup.Cli/Commands/Github/Backup/BackupCommand.cs @@ -13,7 +13,12 @@ namespace GithubBackup.Cli.Commands.Github.Backup; internal static class BackupCommand { private const string CommandName = "backup"; - private const string CommandDescription = "Backup a Github user."; + + private const string CommandDescription = + """ + Backup a Github user. This command will create a new migration + for the given repositories and download it when ready. + """; public static Command Create(string[] args, CommandOptions options) { @@ -32,7 +37,7 @@ public static Command Create(string[] args, CommandOptions options) command.AddOptions(intervalArguments.Options()); command.AddOptions(loginArguments.Options()); - + command.SetHandler( (globalArgs, backupArgs) => RunAsync(args, globalArgs, backupArgs, options), new GlobalArgsBinder(options.GlobalArguments), diff --git a/GithubBackup.Cli/Commands/Github/Download/DownloadCommand.cs b/GithubBackup.Cli/Commands/Github/Download/DownloadCommand.cs index 173c627..085c926 100644 --- a/GithubBackup.Cli/Commands/Github/Download/DownloadCommand.cs +++ b/GithubBackup.Cli/Commands/Github/Download/DownloadCommand.cs @@ -11,7 +11,7 @@ namespace GithubBackup.Cli.Commands.Github.Download; internal static class DownloadCommand { private const string CommandName = "download"; - private const string CommandDescription = "Download migrations."; + private const string CommandDescription = "Download migrations for a Github user."; public static Command Create(string[] args, CommandOptions options) { diff --git a/GithubBackup.Cli/Commands/Github/Migrate/MigrateArgDescriptions.cs b/GithubBackup.Cli/Commands/Github/Migrate/MigrateArgDescriptions.cs index 63ef10a..8f6e70e 100644 --- a/GithubBackup.Cli/Commands/Github/Migrate/MigrateArgDescriptions.cs +++ b/GithubBackup.Cli/Commands/Github/Migrate/MigrateArgDescriptions.cs @@ -12,7 +12,7 @@ The repositories to backup e.g. 'owner/repo'. ); public static readonly Description LockRepositories = new("LockRepositories", "Lock Repositories", - "Lock the repositories being migrated at the start of the migration"); + "Lock the repositories being migrated at the start of the migration."); public static readonly Description ExcludeMetadata = new("ExcludeMetadata", "Exclude Metadata", "Indicates whether metadata should be excluded and only git source should be included for the migration."); @@ -21,10 +21,10 @@ The repositories to backup e.g. 'owner/repo'. "Indicates whether the repository git data should be excluded from the migration."); public static readonly Description ExcludeAttachements = new("ExcludeAttachements", "Exclude Attachements", - "Do not include attachments in the migration"); + "Do not include attachments in the migration."); public static readonly Description ExcludeReleases = - new("ExcludeReleases", "Exclude Releases", "Do not include releases in the migration"); + new("ExcludeReleases", "Exclude Releases", "Do not include releases in the migration."); public static readonly Description ExcludeOwnerProjects = new("ExcludeOwnerProjects", "Exclude Owner Projects", "Indicates whether projects owned by the organization or users should be excluded."); diff --git a/GithubBackup.Cli/Commands/Github/Migrate/MigrateCommand.cs b/GithubBackup.Cli/Commands/Github/Migrate/MigrateCommand.cs index d8030b4..e9c186a 100644 --- a/GithubBackup.Cli/Commands/Github/Migrate/MigrateCommand.cs +++ b/GithubBackup.Cli/Commands/Github/Migrate/MigrateCommand.cs @@ -11,7 +11,7 @@ namespace GithubBackup.Cli.Commands.Github.Migrate; internal static class MigrateCommand { private const string CommandName = "migrate"; - private const string CommandDescription = "Migrate a Github user."; + private const string CommandDescription = "Migrate a Github user. This command will create a new migration for the given repositories."; public static Command Create(string[] args, CommandOptions options) { diff --git a/GithubBackup.Cli/Commands/Github/Migrations/MigrationsCommand.cs b/GithubBackup.Cli/Commands/Github/Migrations/MigrationsCommand.cs index 687f586..178b253 100644 --- a/GithubBackup.Cli/Commands/Github/Migrations/MigrationsCommand.cs +++ b/GithubBackup.Cli/Commands/Github/Migrations/MigrationsCommand.cs @@ -10,7 +10,7 @@ namespace GithubBackup.Cli.Commands.Github.Migrations; internal static class MigrationsCommand { private const string CommandName = "migrations"; - private const string CommandDescription = "List migrations."; + private const string CommandDescription = "List migrations for a Github user."; public static Command Create(string[] args, CommandOptions options) { diff --git a/GithubBackup.Cli/Commands/Github/Repositories/RepositoriesCommand.cs b/GithubBackup.Cli/Commands/Github/Repositories/RepositoriesCommand.cs index c39cc27..ca65f7d 100644 --- a/GithubBackup.Cli/Commands/Github/Repositories/RepositoriesCommand.cs +++ b/GithubBackup.Cli/Commands/Github/Repositories/RepositoriesCommand.cs @@ -10,7 +10,7 @@ namespace GithubBackup.Cli.Commands.Github.Repositories; internal static class RepositoriesCommand { private const string CommandName = "repositories"; - private const string CommandDescription = "List repositories."; + private const string CommandDescription = "List repositories for a Github user."; public static Command Create(string[] args, CommandOptions options) {