Rename Lightning App CLI (#19440)

(cherry picked from commit 0acd5f9)

Author: justusschock

.github/workflows/ci-pkg-install.yml

@@ -79,7 +79,7 @@ jobs:
         if: |
           ((matrix.pkg-name == 'lightning' || matrix.pkg-name == 'notset') && matrix.pkg-extra == 'app') ||
           matrix.pkg-name == 'app'
-        run: lightning --version
+        run: lightning_app --version
 
       - name: DocTests actions
         working-directory: .actions/

docs/source-app/basics.rst

@@ -85,7 +85,7 @@ And here's the output you get when running the above application using **Lightni
 
 .. code-block:: console
 
-    $ lightning run app docs/source/code_samples/quickstart/app_01.py
+    $ lightning_app run app docs/source/code_samples/quickstart/app_01.py
       INFO: Your app has started. View it in your browser: http://127.0.0.1:7501/view
       State: {'works': {'w_1': {'vars': {'counter': 1}}, 'w_2': {'vars': {'counter': 0}}}}
 
@@ -175,7 +175,7 @@ Here's the output you get when running the above application using **Lightning C
 
 .. code-block:: console
 
-    $ lightning run app docs/source/code_samples/quickstart/app_02.py
+    $ lightning_app run app docs/source/code_samples/quickstart/app_02.py
       INFO: Your app has started. View it in your browser: http://127.0.0.1:7501/view
       # After you have clicked `run` on the UI.
       0.0 0.0
@@ -230,7 +230,7 @@ When running the above app, we see the following logs:
 
 .. code-block:: console
 
-    $ lightning run app docs/source/code_samples/quickstart/app/app_0.py
+    $ lightning_app run app docs/source/code_samples/quickstart/app/app_0.py
       INFO: Your app has started. View it in your browser: http://127.0.0.1:7501/view
       # After you have clicked `run` on the UI.
       0.0, 0.0

docs/source-app/get_started/go_beyond_training_content.rst

@@ -56,7 +56,7 @@ Install this App by typing:
 
 .. code-block:: bash
 
-    lightning install app lightning/quick-start
+    lightning_app install app lightning/quick-start
 
 Verify the App was successfully installed:
 
@@ -74,7 +74,7 @@ Run the app locally with the ``run`` command 🤯
 
 .. code:: bash
 
-    lightning run app app.py
+    lightning_app run app app.py
 
 ----
 
@@ -86,7 +86,7 @@ Add the ``--cloud`` argument to run on the `Lightning.AI cloud <http://lightning
 
 .. code:: bash
 
-    lightning run app app.py --cloud
+    lightning_app run app app.py --cloud
 
 ..
     Your app should look like this one (|qs_live_app|)

docs/source-app/get_started/jumpstart_from_app_gallery.rst

@@ -54,7 +54,7 @@ User Workflow
 
     .. code-block:: bash
 
-        lightning install app lightning/hackernews-app
+        lightning_app install app lightning/hackernews-app
 
 #. Go through the installation steps.
 
@@ -71,7 +71,7 @@ User Workflow
     .. code-block:: bash
 
         cd LAI-Hackernews-App
-        lightning run app app.py
+        lightning_app run app app.py
 
     .. video:: https://pl-public-data.s3.amazonaws.com/assets_lightning/hackernews.mp4
         :poster: https://pl-public-data.s3.amazonaws.com/assets_lightning/hackernews.png

docs/source-app/get_started/training_with_apps.rst

@@ -65,13 +65,13 @@ To run your app, copy the following command to your local terminal:
 
 .. code-block:: bash
 
-    lightning run app app.py
+    lightning_app run app app.py
 
 Simply add ``--cloud`` to run this application in the cloud with a GPU machine 🤯
 
 .. code-block:: bash
 
-    lightning run app app.py --cloud
+    lightning_app run app app.py --cloud
 
 
 Congratulations! Now, you know how to run a `PyTorch Lightning <https://github.com/Lightning-AI/lightning/tree/master/src/lightning/pytorch>`_ script with Lightning Apps.

docs/source-app/glossary/command_lines/command_lines.rst

@@ -16,7 +16,7 @@ A Command-line Interface (CLI) is an user interface (UI) in a terminal to intera
 
 .. note::
 
-    The Lightning guideline to build CLI is `lightning <VERB> <NOUN> ...` or `<ACTION> <OBJECT> ...`.
+    The Lightning guideline to build CLI is `lightning_app <VERB> <NOUN> ...` or `<ACTION> <OBJECT> ...`.
 
 As an example, Lightning provides a CLI to interact with your Lightning Apps and the `lightning.ai <https://lightning.ai/>`_ platform as follows:
 

docs/source-app/glossary/environment_variables.rst

@@ -6,13 +6,13 @@ Environment Variables
 
 If your App is using configuration values you don't want to commit with your App source code, you can use environment variables.
 
-Lightning allows you to set environment variables when running the App from the CLI with the `lightning run app` command. You can use environment variables to pass any values to the App, and avoiding sticking those values in the source code.
+Lightning allows you to set environment variables when running the App from the CLI with the `lightning_app run app` command. You can use environment variables to pass any values to the App, and avoiding sticking those values in the source code.
 
 Set one or multiple variables using the **--env** option:
 
 .. code:: bash
 
-    lightning run app app.py --cloud --env FOO=BAR --env BAZ=FAZ
+    lightning_app run app app.py --cloud --env FOO=BAR --env BAZ=FAZ
 
 Environment variables are available in all Flows and Works, and can be accessed as follows:
 

docs/source-app/glossary/secrets.rst

@@ -45,13 +45,13 @@ Use a secret
 
 .. code:: bash
 
-    lightning run app app.py --cloud --secret <environment-variable>=<secret-name>
+    lightning_app run app app.py --cloud --secret <environment-variable>=<secret-name>
 
 In this example, the command would be:
 
 .. code:: bash
 
-    lightning run app app.py --cloud --secret api_token=github_api_token
+    lightning_app run app app.py --cloud --secret api_token=github_api_token
 
 
 The ``--secret`` option can be used for multiple Secrets, and alongside the ``--env`` option.
@@ -60,7 +60,7 @@ Here's an example:
 
 .. code:: bash
 
-    lightning run app app.py --cloud --env FOO=bar --secret MY_APP_SECRET=my-secret --secret ANOTHER_SECRET=another-secret
+    lightning_app run app app.py --cloud --env FOO=bar --secret MY_APP_SECRET=my-secret --secret ANOTHER_SECRET=another-secret
 
 
 ----

docs/source-app/glossary/use_local_lightning.rst

@@ -9,7 +9,7 @@ git clone https://github.com/Lightning-AI/lightning.git
 cd lightning
 pip install -e .
 export PACKAGE_LIGHTNING=1  # <- this is the magic to use your version (not mainstream PyPI)!
-lightning run app app.py --cloud
+lightning_app run app app.py --cloud
 ```
 
 By setting `PACKAGE_LIGHTNING=1`, lightning packages the lightning source code in your local directory in addition to your app source code and uploads them to the cloud.

docs/source-app/landing_app_run.bash

@@ -2,4 +2,4 @@
 pip install lightning
 
 # run the app on the --cloud (--setup installs deps automatically)
-lightning run app app.py --setup --cloud
+lightning_app run app app.py --setup --cloud