Login help clarifications

Author: pjcdawkins

src/Command/Auth/ApiTokenLoginCommand.php

@@ -44,7 +44,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         }
         if (!$input->isInteractive()) {
             $this->stdErr->writeln('Non-interactive use of this command is not supported.');
-            $this->stdErr->writeln("\n" . $this->getApiTokenHelp('comment'));
+            $this->stdErr->writeln("\n" . $this->getNonInteractiveAuthHelp('comment'));
             return 1;
         }
 

src/Command/Auth/BrowserLoginCommand.php

@@ -32,9 +32,13 @@ protected function configure()
             ->addOption('force', 'f', InputOption::VALUE_NONE, 'Log in again, even if already logged in');
         Url::configureInput($this->getDefinition());
 
-        $help = 'Use this command to log in to the ' . $applicationName . ' using a browser.'
-            . "\n\n" . $this->getApiTokenHelp();
-        $this->setHelp($help);
+        $executable = $this->config()->get('application.executable');
+        $help = 'Use this command to log in to the ' . $applicationName . ' using a web browser.'
+            . "\n\nIt launches a temporary local website which redirects you to log in if necessary, and then captures the resulting authorization code."
+            . "\n\nYour system's default browser will be used. You can override this using the <info>--browser</info> option."
+            . "\n\nAlternatively, to log in using an API token (without a browser), run: <info>$executable auth:api-token-login</info>"
+            . "\n\n" . $this->getNonInteractiveAuthHelp();
+        $this->setHelp(\wordwrap($help, 80));
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
@@ -44,8 +48,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
         if (!$input->isInteractive()) {
-            $this->stdErr->writeln('Non-interactive login is not supported.');
-            $this->stdErr->writeln("\n" . $this->getApiTokenHelp('comment'));
+            $this->stdErr->writeln('Non-interactive use of this command is not supported.');
+            $this->stdErr->writeln("\n" . $this->getNonInteractiveAuthHelp('comment'));
             return 1;
         }
         if ($this->config()->getSessionId() !== 'default' || count($this->api()->listSessionIds()) > 1) {
@@ -174,7 +178,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->stdErr->writeln('<options=bold>Help:</>');
         $this->stdErr->writeln('  Leave this command running during login.');
         $this->stdErr->writeln('  If you need to quit, use Ctrl+C.');
-        $this->stdErr->writeln("\n" . preg_replace('/^/m', '  ', $this->getApiTokenHelp()));
         $this->stdErr->writeln('');
 
         // Wait for the file to be filled with an OAuth2 authorization code.

src/Command/Auth/PasswordLoginCommand.php

@@ -32,7 +32,7 @@ protected function configure()
             . $accountsUrl . '/user/password</info>'
             . "\n\nAlternatively, to log in to the CLI with a browser, run:\n    <info>"
             . $executable . ' auth:browser-login</info>'
-            . "\n\n" . $this->getApiTokenHelp();
+            . "\n\n" . $this->getNonInteractiveAuthHelp();
         $this->setHelp($help);
     }
 
@@ -43,8 +43,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
         if (!$input->isInteractive()) {
-            $this->stdErr->writeln('Non-interactive login is not supported.');
-            $this->stdErr->writeln("\n" . $this->getApiTokenHelp('comment'));
+            $this->stdErr->writeln('Non-interactive use of this command is not supported.');
+            $this->stdErr->writeln("\n" . $this->getNonInteractiveAuthHelp('comment'));
             return 1;
         }
 

src/Command/CommandBase.php

@@ -1560,17 +1560,17 @@ public function isEnabled()
     }
 
     /**
-     * Get help on how to use API tokens.
+     * Get help on how to use API tokens non-interactively.
      *
      * @param string $tag
      *
      * @return string
      */
-    protected function getApiTokenHelp($tag = 'info')
+    protected function getNonInteractiveAuthHelp($tag = 'info')
     {
-        $executable = $this->config()->get('application.executable');
+        $prefix = $this->config()->get('application.env_prefix');
 
-        return "To log in using an API token, run: <$tag>$executable auth:api-token-login</$tag>";
+        return "To authenticate non-interactively, configure an API token using the <$tag>${prefix}TOKEN</$tag> environment variable.";
     }
 
     /**