Merge pull request #1159 from nep/patch-13

Revise CLI usage documentation to remove `hello`

Author: TomJaeger

docs/cli/usage.md

@@ -1,41 +1,35 @@
 # CLI Usage
 
-Commands can be called in the terminal of your choice in the format of:
+Commands to control and report on many of the core operations of ExpressionEngine can be issued via the terminal of your choice in the format of:
 
-`$ php system/ee/eecli.php hello`
+`$ php system/ee/eecli.php version`
 
-This will call `eecli` with a command of `hello`. This is the Hello World of ExpressionEngine commands, and will display:
+Assuming you're in the directory that contains the system folder, this will have `php` use ExpressionEngine's Command Line Interface tool, `eecli`, to run the `version` command. 
 
-`Hello world`
-
-Commands can also request confirmation:
+This is the most basic of ExpressionEngine commands, and will display something similar to:
 
 ```
-$ php system/ee/eecli.php hello -c
-
-Hello world
-Are you liking these questions? (yes/no) [no]
-yes
-That's good to hear!
+ExpressionEngine Version: 7.5.25
+Build: 20260623
+PHP Version: 8.2.32
 ```
+You may also be able to use the CLI with PHP implied. Command line usage is a broad topic, and the details of your system may vary.
 
-Commands are also able to take interaction:
+`$ ./system/ee/eecli.php version`
 
-```
-$ php system/ee/eecli.php hello -i
+Commands can be interactive and ask you questions as they run. For example, this command will walk you through setting up the files and framework for a custom EE add-on:
 
-Hello world
-What's your name? Andy
-Pleasure to meet you, Andy!
 ```
+$ php system/ee/eecli.php make:addon
 
-WARN: **Important:** The CLI is available to every user that has SSH or terminal access to your site's webserver. It does not handle authorization inside ExpressionEngine and is relying on your server's authorization method instead. 
-
-If you want to disable CLI globally, it can be done by setting `cli_enabled` [configuration override](general/system-configuration-overrides.md#cli_enabled) to `n`.
+Let's build your add-on!
+What is the name of your add-on? 
+etc.
+```
 
 ## List All Commands
 
-To view a list of all available commands, you may use the list command:
+To view a list of all available commands, use the list command:
 
 `php system/ee/eecli.php list`
 
@@ -44,41 +38,56 @@ This will return a basic list of all available system and user-generated command
 ```
 $ php system/ee/eecli.php list
 
+------------------------------------------------------------------
 | Command             | Description                              |
 ------------------------------------------------------------------
-| hello               | The most basic of commands               |
 | list                | Lists all available commands             |
-| update              | Updates ExpressionEngine                 |
+| addons:install      | Installs add-on and all its components   |
+| backup:database     | Backup the database                      |
+| channels:list       | Lists all channels in the system         |
 | cache:clear         | Clears all ExpressionEngine caches       |
+| config:config       | Updates config values in config.php file |
 ...
 ```
 
+## Command Line Security
+
+WARN: **Important:** Unless disabled, the CLI is enabled by default and available to any person who has SSH or terminal access to your site's web server and who can run PHP scripts. The CLI does not handle authorization using ExpressionEngine's member system. It relies entirely on your server's authorization methods and simply treats a CLI user as a generic superuser.
+
+EE is available via the CLI even when EE is set to offline mode -- this mirrors a superadmin's access permissions in the control panel and makes it possible to perform maintenance and upgrades when a site is offline.
+
+If you want to disable CLI globally, this can be done by setting `cli_enabled` [configuration override](general/system-configuration-overrides.md#cli_enabled) to `n` or by running the following command:
+
+`$ php eecli.php config:config -c cli_enabled -v n` 
+
+(This would be a poor choice of command to use to test the CLI.)
+
+You can also enable and disable the CLI from [Security & Privacy Settings](control-panel/settings/security-privacy.md#enable-the-command-line-interface) in the Control Panel.
+
 ## Get Help
 
-You can get help information on any command by using the `--help` or `-h` parameter when running the command.
+You can get help information for any command by using the `--help` or `-h` parameter
 
 ```
-$ php system/ee/eecli.php hello -h
+$ php system/ee/eecli.php config:config -h
 
 SUMMARY
-    Hello World -- This is a sample command used to test the CLI
+    Update Config Values -- Gives the ability to update config values
 
 USAGE
-    Hello World php eecli.php hello
+    Update Config Values php eecli.php config:config -c is_system_on -v n
 
 DESCRIPTION
-    The most basic of commands
+    Updates config values in config.php file
 
 OPTIONS
-    --verbose
-    -v
-        Hello world, but longer
-
-    --interactive
-    -i
-        Let's interact!
+    --config-variable=<value>
+    -c <value>
+        The config item to modify
 
-    --confirm
-    -c
-        Test the confirmation
+    --value=<value>
+    -v <value>
+        The value to set the config item to
 ```
+
+Additional details may also be available here in the ExpressionEngine Docs or on the add-on developer's website.