branch_io_cli 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57e3295339b988ee4f835a92154eb15e45ae1df5655930902ebc5c43f1a33e0
-  data.tar.gz: 6b9b929afa148c9aa389116ac73e8d0eb8143ea5fed06285e389819371496c24
+  metadata.gz: c19de7b1fee926331d25dec07b8f5af3c3ddd099d7a935bdf724499da2dc0684
+  data.tar.gz: 8777a15c765285fcdc8de2db03c26bae564c7f3557d2bc1e2bdf5b593e99595e
 SHA512:
-  metadata.gz: 0f8a5e5132646571ed123b8546b8ceee45e998d0cc06356854d133c93cf544313302100f6058f22ecafa5a859f1459fd0c89b983745d3fadd865c2f95d7b0ee4
-  data.tar.gz: b37bd6a57304fb87f0ff721e30d1d7281bf52f1b0cfd6872b23b6cbd46494a4b5345b1f3925dfe6fc322f4365606b053aacb28aaad9b1875e5eae93d889dfe01
+  metadata.gz: 6ea8a70c65a8234a83f541c1c67191e26d2dd20e0e20f4bb5a6a645e667b3db37aca91c54a9071cbaef13977697f37f4cab3aa9c7845059eb201f7d0b5391be5
+  data.tar.gz: d31b0cff7755187e94f6e7ce9be04f27b83ca3fee7b52e1db95c9c2f3f365fdc8d5bfffa2881e3e2b041e949047edd25595ac629cbc38093e634654e421ecec1

data/README.md

@@ -59,6 +59,9 @@ Currently command-line completion for bash is much more extensive than for zsh.
 
 ## Commands
 
+<!-- The following is generated. Do not edit by hand. Run rake readme to -->
+<!-- regenerate this section. -->
+<!-- BEGIN COMMAND REFERENCE -->
 ### Setup command
 
 ```bash
@@ -98,7 +101,9 @@ This can be suppressed using `--no-patch-source`.
 
 #### Prerequisites
 
-Before using this command, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup` command, you need:
+Before using this command, make sure to set up your app in the Branch Dashboard
+(https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/
+for details. To use the `setup` command, you need:
 
 - Branch key(s), either live, test or both
 - Domain name(s) used for Branch links
@@ -109,6 +114,14 @@ the `pod` or `carthage` command may be required. If not found, the CLI will
 offer to install and set up these command-line tools for you. Alternately, you can arrange
 that the relevant commands are available in your `PATH`.
 
+All parameters are optional. A live key or test key, or both is required, as well
+as at least one domain. Specify `--live-key`, `--test-key` or both and `--app-link-subdomain`,
+`--domains` or both. If these are not specified, this command will prompt you
+for this information.
+
+See https://github.com/BranchMetrics/branch_io_cli#setup-command for more information.
+
+
 #### Options
 
 |Option|Description|
@@ -118,77 +131,92 @@ that the relevant commands are available in your `PATH`.
 |-t, --trace|Prints a stack trace when exceptions are raised|
 |-L, --live-key key_live_xxxx|Branch live key|
 |-T, --test-key key_test_yyyy|Branch test key|
-|--app-link-subdomain myapp|Branch app.link subdomain, e.g. myapp for myapp.app.link|
 |-D, --domains example.com,www.example.com|Comma-separated list of custom domain(s) or non-Branch domain(s)|
+|--app-link-subdomain myapp|Branch app.link subdomain, e.g. myapp for myapp.app.link|
 |-U, --uri-scheme myurischeme[://]|Custom URI scheme used in the Branch Dashboard for this app|
 |-s, --setting [BRANCH_KEY_SETTING]|Use a custom build setting for the Branch key (default: Use Info.plist)|
-|--test-configurations|List of configurations that use the test key with a custom build setting (default: Debug configurations)|
+|--test-configurations config1,config2|List of configurations that use the test key with a custom build setting (default: Debug configurations)|
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
 |--target MyAppTarget|Name of a target to modify in the Xcode project|
 |--podfile /path/to/Podfile|Path to the Podfile for the project|
 |--cartfile /path/to/Cartfile|Path to the Cartfile for the project|
-|--carthage-command <command>|Command to use when installing from Carthage (default: update --platform ios)|
+|--carthage-command <command>|Command to run when installing from Carthage (default: update --platform ios)|
 |--frameworks AdSupport,CoreSpotlight,SafariServices|Comma-separated list of system frameworks to add to the project|
 |--[no-]pod-repo-update|Update the local podspec repo before installing (default: yes)|
 |--[no-]validate|Validate Universal Link configuration (default: yes)|
 |--[no-]force|Update project even if Universal Link validation fails (default: no)|
 |--[no-]add-sdk|Add the Branch framework to the project (default: yes)|
 |--[no-]patch-source|Add Branch SDK calls to the AppDelegate (default: yes)|
-|--[no-]commit [message]|Commit the results to Git (default: no)|
+|--commit [message]|Commit the results to Git|
+|--[no-]check-repo-changes|Check for uncommitted changes to a git repo (default: yes)|
 
-All parameters are optional. A live key or test key, or both is required, as well as at least one domain.
-Specify --live-key, --test-key or both and --app-link-subdomain, --domains or both. If these are not
-specified, this command will prompt you for the information.
 
 #### Examples
 
+
 ##### Test without validation (can use dummy keys and domains)
 
 ```bash
 branch_io setup -L key_live_xxxx -D myapp.app.link --no-validate
 ```
 
+
 ##### Use both live and test keys
 
 ```bash
 branch_io setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link
 ```
 
+
 ##### Use custom or non-Branch domains
 
 ```bash
 branch_io setup -D myapp.app.link,example.com,www.example.com
 ```
 
+
 ##### Avoid pod repo update
 
 ```bash
 branch_io setup --no-pod-repo-update
 ```
 
+
 ##### Install using carthage bootstrap
 
 ```bash
 branch_io --carthage-command "bootstrap --no-use-binaries"
 ```
 
+
+
+
 ### Validate command
 
 ```bash
 branch_io validate [OPTIONS]
 ```
 
-This command validates all Universal Link domains configured in a project without making any modification.
-It validates both Branch and non-Branch domains. Unlike web-based Universal Link validators,
-this command operates directly on the project. It finds the bundle and
-signing team identifiers in the project as well as the app's Associated Domains.
-It requests the apple-app-site-association file for each domain and validates
-the file against the project's settings.
+This command validates all Universal Link domains configured in a project without making any
+modification. It validates both Branch and non-Branch domains. Unlike web-based Universal
+Link validators, this command operates directly on the project. It finds the bundle and
+signing team identifiers in the project as well as the app's Associated Domains. It requests
+the apple-app-site-association file for each domain and validates the file against the
+project's settings.
 
 Only app targets are supported for this command. By default, it will validate the first.
 If your project has multiple app targets, specify the `--target` option to validate other
 targets.
 
+All parameters are optional. If `--domains` is specified, the list of Universal Link domains in
+the Associated Domains entitlement must exactly match this list, without regard to order. If
+no `--domains` are provided, validation passes if at least one Universal Link domain is
+configured and passes validation, and no Universal Link domain is present that does not pass
+validation.
+
+See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
+
+
 #### Options
 
 |Option|Description|
@@ -196,18 +224,13 @@ targets.
 |-h, --help|Prints a list of commands or help for each command|
 |-v, --version|Prints the current version of the CLI|
 |-t, --trace|Prints a stack trace when exceptions are raised|
-|-D, --domains example.com,www.example.com|Comma-separated list of domains. May include app.link subdomains.|
+|-D, --domains example.com,www.example.com|Comma-separated list of domains to validate (Branch domains or non-Branch domains) (default: [])|
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
-|--target MyAppTarget|Name of a target to modify in the Xcode project|
+|--target MyAppTarget|Name of a target to validate in the Xcode project|
+
 
-All parameters are optional. If `--domains` is specified, the list of Universal Link domains in the
-Associated Domains entitlement must exactly match this list, without regard to order. If no `--domains`
-are provided, validation passes if at least one Universal Link domain is configured and passes validation,
-and no Universal Link domain is present that does not pass validation.
 
-#### Return value
 
-If validation passes, this command returns 0. If validation fails, it returns 1.
 
 ### Report command
 
@@ -220,6 +243,7 @@ _Work in progress_
 This command optionally cleans and then builds a workspace or project, generating a verbose
 report with additional diagnostic information suitable for opening a support ticket.
 
+
 #### Options
 
 |Option|Description|
@@ -229,18 +253,42 @@ report with additional diagnostic information suitable for opening a support tic
 |-t, --trace|Prints a stack trace when exceptions are raised|
 |--workspace MyProject.xcworkspace|Path to an Xcode workspace|
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project|
-|--target MyAppTarget|Name of a target to modify in the Xcode project|
-|--scheme MyAppScheme|Name of a scheme to build|
-|--configuration Debug/Release/CustomConfig|Name of a build configuration (default: Scheme-dependent)|
-|--sdk iphonesimulator|Name of an SDK to use with xcodebuild (default: iphonesimulator)|
-|--[no-]clean|Clean before building (default: yes)|
-|-H, --[no-]header-only|Show a diagnostic header and exit without cleaning or building (default: no)|
-|--[no-]pod-repo-update|Update the local podspec repo before installing (default: yes)|
+|--scheme MyProjectScheme|A scheme from the project or workspace to build|
+|--target MyProjectTarget|A target to build|
+|--configuration Debug/Release/CustomConfigName|The build configuration to use (default: Scheme-dependent)|
+|--sdk iphoneos|Passed as -sdk to xcodebuild (default: iphonesimulator)|
 |--podfile /path/to/Podfile|Path to the Podfile for the project|
 |--cartfile /path/to/Cartfile|Path to the Cartfile for the project|
-|-o, --out ./report.txt|Path to use for the generated report (default: ./report.txt)|
+|--[no-]clean|Clean before attempting to build (default: yes)|
+|-H, --[no-]header-only|Write a report header to standard output and exit (default: no)|
+|--[no-]pod-repo-update|Update the local podspec repo before installing (default: yes)|
+|-o, --out ./report.txt|Report output path (default: ./report.txt)|
+
+
+
+
+
+<!-- END COMMAND REFERENCE -->
 
 ## Examples
 
 See the [examples](./examples) folder for several example projects that can be
 used to exercise the CLI.
+
+## Rake task
+
+You can use these commands easily with Rake:
+
+```Ruby
+require 'branch_io_cli/rake_task'
+BranchIOCLI::RakeTask.new
+```
+
+This defines the tasks `branch:report`, `branch:setup` and `branch:validate`.
+Each takes a path or an array of paths for a project directory as the first
+argument, followed by an options Hash with keys derived from the command-line
+arguments. For example:
+
+```Ruby
+Rake::Task["branch:validate"].invoke ".", domains: %w(example.com www.example.com)
+```

data/lib/assets/completions/completion.bash

@@ -13,7 +13,7 @@ _branch_io_complete()
 
     setup_opts="$global_opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
     setup_opts="$setup_opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command --setting -s"
-    setup_opts="$setup_opts --test-configurations --no-test-configurations"
+    setup_opts="$setup_opts --test-configurations --no-test-configurations --no-check-repo-changes"
     # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
     setup_opts="$setup_opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
 

data/lib/assets/completions/completion.zsh

@@ -6,7 +6,7 @@ _branch_io_complete() {
   opts="-h --help -t --trace -v --version"
   opts="$opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
   opts="$opts --xcodeproj --target --frameworks --podfile --cartfile --carthage-command --setting -s"
-  opts="$opts --test-configurations --no-test-configurations"
+  opts="$opts --test-configurations --no-test-configurations --no-check-repo-changes"
   # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
   opts="$opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
 

data/lib/assets/templates/command.erb

@@ -0,0 +1,31 @@
+<%= header "#{@command.command_name.to_s.capitalize} command", 3 %>
+
+```bash
+branch_io <%= @command.command_name %> [OPTIONS]
+```
+
+<%= render "#{@command.command_name}_description" %>
+
+<%= header "Options", 4 %>
+
+|Option|Description|
+|------|-----------|
+|-h, --help|Prints a list of commands or help for each command|
+|-v, --version|Prints the current version of the CLI|
+|-t, --trace|Prints a stack trace when exceptions are raised|
+<%= table_options %>
+
+<% if @command.respond_to?(:examples) && !@command.examples.blank? %>
+<%= header "Examples", 4 %>
+<% @command.examples.each_key do |text| %>
+<% example = @command.examples[text] %>
+<%= header text, 5 %>
+
+```bash
+<%= example %>
+```
+<% end %>
+<% end %>
+
+<% if @command.respond_to?(:return_value) && !@command.return_value.nil? %>
+<% end %>

data/lib/assets/templates/program_description.erb

@@ -0,0 +1,2 @@
+Command-line tool to integrate the Branch SDK into mobile app projects (currently
+iOS only) and validate Universal Link domains

data/lib/assets/templates/report_description.erb

@@ -0,0 +1,4 @@
+<%= italics 'Work in progress' %>
+
+This command optionally cleans and then builds a workspace or project, generating a verbose
+report with additional diagnostic information suitable for opening a support ticket.

data/lib/assets/templates/setup_description.erb

@@ -0,0 +1,52 @@
+Integrates the Branch SDK into a native app project. This currently supports iOS only.
+It will infer the project location if there is exactly one .xcodeproj anywhere under
+the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
+the project location using the <%= option :xcodeproj %> option, or the CLI will prompt you for the
+location.
+
+If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
+configuration file and the dependencies updated to include the Branch framework.
+This behavior may be suppressed using <%= option :no_add_sdk %>. If no Podfile or Cartfile
+is found, and Branch.framework is not already among the project's dependencies,
+you will be prompted for a number of choices, including setting up CocoaPods or
+Carthage for the project or directly installing the Branch.framework.
+
+By default, all supplied Universal Link domains are validated. If validation passes,
+the setup continues. If validation fails, no further action is taken. Suppress
+validation using <%= option :no_validate %> or force changes when validation fails using
+<%= option :force %>.
+
+By default, this command will look for the first app target in the project. Test
+targets are not supported. To set up an extension target, supply the <%= option :target %> option.
+
+All relevant target settings are modified. The Branch keys are added to the Info.plist,
+along with the <%= highlight 'branch_universal_link_domains' %> key for custom domains (when <%= option :domains %>
+is used). For app targets, all domains are added to the project's Associated Domains
+entitlement. An entitlements file is also added for app targets if none is found.
+Optionally, if <%= option :frameworks %> is specified, this command can add a list of system
+frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
+
+A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
+This can be suppressed using <%= option :no_patch_source %>.
+
+<%= header 'Prerequisites', 4 %>
+
+Before using this command, make sure to set up your app in the Branch Dashboard
+(https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/
+for details. To use the <%= highlight 'setup' %> command, you need:
+
+- Branch key(s), either live, test or both
+- Domain name(s) used for Branch links
+- Location of your Xcode project (may be inferred in simple projects)
+
+If using the <%= option :commit %> option, <%= highlight 'git' %> is required. If not using <%= option :no_add_sdk %>,
+the <%= highlight 'pod' %> or <%= highlight 'carthage' %> command may be required. If not found, the CLI will
+offer to install and set up these command-line tools for you. Alternately, you can arrange
+that the relevant commands are available in your <%= highlight 'PATH' %>.
+
+All parameters are optional. A live key or test key, or both is required, as well
+as at least one domain. Specify <%= option :live_key %>, <%= option :test_key %> or both and <%= option :app_link_subdomain %>,
+<%= option :domains %> or both. If these are not specified, this command will prompt you
+for this information.
+
+See https://github.com/BranchMetrics/branch_io_cli#setup-command for more information.

data/lib/assets/templates/validate_description.erb

@@ -0,0 +1,18 @@
+This command validates all Universal Link domains configured in a project without making any
+modification. It validates both Branch and non-Branch domains. Unlike web-based Universal
+Link validators, this command operates directly on the project. It finds the bundle and
+signing team identifiers in the project as well as the app's Associated Domains. It requests
+the apple-app-site-association file for each domain and validates the file against the
+project's settings.
+
+Only app targets are supported for this command. By default, it will validate the first.
+If your project has multiple app targets, specify the <%= option :target %> option to validate other
+targets.
+
+All parameters are optional. If <%= option :domains %> is specified, the list of Universal Link domains in
+the Associated Domains entitlement must exactly match this list, without regard to order. If
+no <%= option :domains %> are provided, validation passes if at least one Universal Link domain is
+configured and passes validation, and no Universal Link domain is present that does not pass
+validation.
+
+See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.

data/lib/branch_io_cli.rb

@@ -2,5 +2,6 @@ require "branch_io_cli/cli"
 require "branch_io_cli/command"
 require "branch_io_cli/configuration"
 require "branch_io_cli/core_ext"
+require "branch_io_cli/format"
 require "branch_io_cli/helper"
 require "branch_io_cli/version"

data/lib/branch_io_cli/cli.rb

@@ -1,116 +1,31 @@
 require "rubygems"
 require "commander"
+require "branch_io_cli/format"
 
 module BranchIOCLI
   class CLI
     include Commander::Methods
+    include Format::CommanderFormat
 
     def run
       program :name, "Branch.io command-line interface"
       program :version, VERSION
-      program :description, <<EOF
-Command-line tool to integrate the Branch SDK into mobile app projects (currently
-iOS only) and validate Universal Link domains
-EOF
+      program :description, render(:program_description)
 
       command :setup do |c|
         c.syntax = "branch_io setup [OPTIONS]"
         c.summary = "Integrates the Branch SDK into a native app project"
-        c.description = <<EOF
-Integrates the Branch SDK into a native app project. This currently supports iOS only.
-It will infer the project location if there is exactly one .xcodeproj anywhere under
-the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
-the project location using the <%= color('--xcodeproj', BOLD) %> option, or the CLI will prompt you for the
-location.
-
-If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
-configuration file and the dependencies updated to include the Branch framework.
-This behavior may be suppressed using <%= color('--no-add-sdk', BOLD) %>. If no Podfile or Cartfile
-is found, and Branch.framework is not already among the project's dependencies,
-you will be prompted for a number of choices, including setting up CocoaPods or
-Carthage for the project or directly installing the Branch.framework.
-
-By default, all supplied Universal Link domains are validated. If validation passes,
-the setup continues. If validation fails, no further action is taken. Suppress
-validation using <%= color('--no-validate', BOLD) %> or force changes when validation fails using
-<%= color('--force', BOLD) %>.
-
-By default, this command will look for the first app target in the project. Test
-targets are not supported. To set up an extension target, supply the <%= color('--target', BOLD) %> option.
-
-All relevant target settings are modified. The Branch keys are added to the Info.plist,
-along with the <%= color('branch_universal_link_domains', BOLD) %> key for custom domains (when <%= color('--domains', BOLD) %>
-is used). For app targets, all domains are added to the project's Associated Domains
-entitlement. An entitlements file is also added for app targets if none is found.
-Optionally, if <%= color('--frameworks', BOLD) %> is specified, this command can add a list of system
-frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
-
-A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
-This can be suppressed using <%= color('--no-patch-source', BOLD) %>.
-
-<%= color('Prerequisites', BOLD) %>
-
-Before using this command, make sure to set up your app in the Branch Dashboard
-(https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/
-for details. To use the <%= color('setup', BOLD) %> command, you need:
-
-- Branch key(s), either live, test or both
-- Domain name(s) used for Branch links
-- Location of your Xcode project (may be inferred in simple projects)
-
-If using the <%= color('--commit', BOLD) %> option, <%= color('git', BOLD) %> is required. If not using <%= color('--no-add-sdk', BOLD) %>,
-the <%= color('pod', BOLD) %> or <%= color('carthage', BOLD) %> command may be required. If not found, the CLI will
-offer to install and set up these command-line tools for you. Alternately, you can arrange
-that the relevant commands are available in your <%= color('PATH', BOLD) %>.
-
-All parameters are optional. A live key or test key, or both is required, as well
-as at least one domain. Specify <%= color('--live-key', BOLD) %>, <%= color('--test-key', BOLD) %> or both and <%= color('--app-link-subdomain', BOLD) %>,
-<%= color('--domains', BOLD) %> or both. If these are not specified, this command will prompt you
-for this information.
-
-See https://github.com/BranchMetrics/branch_io_cli#setup-command for more information.
-EOF
-
-        # Required Branch params
-        c.option "-L", "--live-key key_live_xxxx", String, "Branch live key"
-        c.option "-T", "--test-key key_test_yyyy", String, "Branch test key"
-        c.option "--app-link-subdomain myapp", String, "Branch app.link subdomain, e.g. myapp for myapp.app.link"
-        c.option "-D", "--domains example.com,www.example.com", Array, "Comma-separated list of custom domain(s) or non-Branch domain(s)"
-        c.option "-U", "--uri-scheme myurischeme[://]", String, "Custom URI scheme used in the Branch Dashboard for this app"
-        c.option "-s", "--setting [BRANCH_KEY_SETTING]", String, "Use a custom build setting for the Branch key (default: Use Info.plist)"
-        c.option "--[no-]test-configurations [config1,config2]", Array, "List of configurations that use the test key with a custom build setting (default: Debug configurations)"
-
-        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
-        c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"
-        c.option "--podfile /path/to/Podfile", String, "Path to the Podfile for the project"
-        c.option "--cartfile /path/to/Cartfile", String, "Path to the Cartfile for the project"
-        c.option "--carthage-command <command>", String, "Command to run when installing from Carthage (default: update --platform ios)"
-        c.option "--frameworks AdSupport,CoreSpotlight,SafariServices", Array, "Comma-separated list of system frameworks to add to the project"
-
-        c.option "--[no-]pod-repo-update", "Update the local podspec repo before installing (default: yes)"
-        c.option "--[no-]validate", "Validate Universal Link configuration (default: yes)"
-        c.option "--[no-]force", "Update project even if Universal Link validation fails (default: no)"
-        c.option "--[no-]add-sdk", "Add the Branch framework to the project (default: yes)"
-        c.option "--[no-]patch-source", "Add Branch SDK calls to the AppDelegate (default: yes)"
-        c.option "--[no-]commit [message]", String, "Commit the results to Git (default: no)"
-
-        c.example "Test without validation (can use dummy keys and domains)", "branch_io setup -L key_live_xxxx -D myapp.app.link --no-validate"
-        c.example "Use both live and test keys", "branch_io setup -L key_live_xxxx -T key_test_yyyy -D myapp.app.link"
-        c.example "Use custom or non-Branch domains", "branch_io setup -D myapp.app.link,example.com,www.example.com"
-        c.example "Avoid pod repo update", "branch_io setup --no-pod-repo-update"
-        c.example "Install using carthage bootstrap", "branch_io --carthage-command \"bootstrap --no-use-binaries\""
+        c.description = render :setup_description
+
+        add_options_for_command :setup, c
+
+        Command::SetupCommand.examples.each_key do |text|
+          example = Command::SetupCommand.examples[text]
+          c.example text, example
+        end
 
         c.action do |args, options|
-          options.default(
-            # Defaults for boolean options
-            pod_repo_update: true,
-            validate: true,
-            force: false,
-            add_sdk: true,
-            patch_source: true,
-            commit: false,
-            carthage_command: "update --platform ios"
-          )
+          options.default Configuration::SetupConfiguration.defaults
           Command::SetupCommand.new(options).run!
         end
       end
@@ -118,32 +33,12 @@ EOF
       command :validate do |c|
         c.syntax = "branch_io validate [OPTIONS]"
         c.summary = "Validates all Universal Link domains configured in a project"
-        c.description = <<EOF
-This command validates all Universal Link domains configured in a project without making any
-modification. It validates both Branch and non-Branch domains. Unlike web-based Universal
-Link validators, this command operates directly on the project. It finds the bundle and
-signing team identifiers in the project as well as the app's Associated Domains. It requests
-the apple-app-site-association file for each domain and validates the file against the
-project's settings.
-
-Only app targets are supported for this command. By default, it will validate the first.
-If your project has multiple app targets, specify the <%= color('--target', BOLD) %> option to validate other
-targets.
-
-All parameters are optional. If <%= color('--domains', BOLD) %> is specified, the list of Universal Link domains in
-the Associated Domains entitlement must exactly match this list, without regard to order. If
-no <%= color('--domains', BOLD) %> are provided, validation passes if at least one Universal Link domain is
-configured and passes validation, and no Universal Link domain is present that does not pass
-validation.
-
-See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
-EOF
-
-        c.option "-D", "--domains example.com,www.example.com", Array, "Comma-separated list of domains to validate (Branch domains or non-Branch domains)"
-        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project to update"
-        c.option "--target MyAppTarget", String, "Name of a target to modify in the Xcode project"
+        c.description = render :validate_description
+
+        add_options_for_command :validate, c
 
         c.action do |args, options|
+          options.default Configuration::ValidateConfiguration.defaults
           valid = Command::ValidateCommand.new(options).run!
           exit_code = valid ? 0 : 1
           exit exit_code
@@ -153,39 +48,47 @@ EOF
       command :report do |c|
         c.syntax = "branch_io report [OPTIONS]"
         c.summary = "Generate and optionally submit a build diagnostic report."
-        c.description = <<EOF
-<%= color('Work in progress', BOLD) %>
-
-This command optionally cleans and then builds a workspace or project, generating a verbose
-report with additional diagnostic information suitable for opening a support ticket.
-EOF
-
-        c.option "--xcodeproj MyProject.xcodeproj", String, "Path to an Xcode project"
-        c.option "--workspace MyProject.xcworkspace", String, "Path to an Xcode workspace"
-        c.option "--scheme MyProjectScheme", String, "A scheme from the project or workspace to build"
-        c.option "--target MyProjectTarget", String, "A target to build"
-        c.option "--configuration Debug|Release|CustomConfigName", String, "The build configuration to use (default: Scheme-dependent)"
-        c.option "--sdk iphonesimulator", String, "Passed as -sdk to xcodebuild (default: iphonesimulator)"
-        c.option "--podfile /path/to/Podfile", String, "Path to the Podfile for the project"
-        c.option "--cartfile /path/to/Cartfile", String, "Path to the Cartfile for the project"
-        c.option "--[no-]clean", "Clean before attempting to build (default: yes)"
-        c.option "-H", "--[no-]header-only", "Write a report header to standard output and exit"
-        c.option "--[no-]pod-repo-update", "Update the local podspec repo before installing (default: yes)"
-        c.option "-o", "--out ./report.txt", String, "Report output path (default: ./report.txt)"
+        c.description = render :report_description
+
+        add_options_for_command :report, c
 
         c.action do |args, options|
-          options.default(
-            clean: true,
-            header_only: false,
-            sdk: "iphonesimulator",
-            out: "./report.txt",
-            pod_repo_update: true
-          )
+          options.default Configuration::ReportConfiguration.defaults
           Command::ReportCommand.new(options).run!
         end
       end
 
       run!
     end
+
+    def add_options_for_command(name, c)
+      configuration_class = Object.const_get("BranchIOCLI")
+                                  .const_get("Configuration")
+                                  .const_get("#{name.to_s.capitalize}Configuration")
+      available_options = configuration_class.available_options
+      available_options.each do |option|
+        args = option.aliases
+        declaration = "--"
+        declaration += "[no-]" if option.negatable
+        declaration += "#{option.name.to_s.gsub(/_/, '-')} "
+        if option.example
+          declaration += "[" if option.argument_optional
+          declaration += option.example
+          declaration += "]" if option.argument_optional
+        end
+        args << declaration
+        args << option.type if option.type
+
+        if option.type.nil?
+          default_value = option.default_value ? "yes" : "no"
+        else
+          default_value = option.default_value
+        end
+
+        default_string = default_value ? " (default: #{default_value})" : nil
+        args << "#{option.description}#{default_string}"
+        c.option(*args)
+      end
+    end
   end
 end