Update the help content

ballerina-platform · Mar 19, 2024 · b9842fc · b9842fc
1 parent 4219da0
commit b9842fc
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help b/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help
@@ -14,5 +14,5 @@ EXAMPLES
           $ bal persist generate --help
 
        Generate client objects for the model definition file inside persist directory.
-          $ bal persist generate
+          $ bal persist generate --module persist --datastore mysql
 
diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist.help b/persist-cli/src/main/resources/cli-help/ballerina-persist.help
@@ -11,7 +11,7 @@ DESCRIPTION
        data persistence in a Ballerina package. This step creates the required
        directories and configuration files. For example:
 
-           $ bal persist init
+           $ bal persist add
 
        Define the application's data model as the next step. Use the generated
        definition file in the "persist" directory to define the data model
@@ -35,7 +35,20 @@ DESCRIPTION
        API to query and manipulate the persistent data in the application.
        For example:
 
-       $ bal persist generate
+       $ bal build
+
+       Apart from the above commands, the following commands are also available:
+
+       $ bal persist init
+
+       This command initializes the package for persistence and used in one time generation of the clients.
+       This command will create a new directory named 'persist' in the project directory. The 'persist' directory will
+       contain empty model definition file which can be used to define the data model of the Ballerina project.
+
+       $ bal persist generate --module persist --datastore mysql
+
+       This command generates the client API based on the data model defined in the "persist" directory. Usually used
+       for one time generation of the client.
 
 OPTIONS
        -h, --help
@@ -44,7 +57,9 @@ OPTIONS
 BALLERINA COMMANDS
        The below is a list of available subcommands:
 
-       init            Initialize the package for persistence
+       add             Initialize the package for persistence
+       init            Initialize the package for persistence for one time code generation. Used along with
+                       `generate` command.
        generate        Generate the client API based on the data model defined in the "persist" directory
 
 Use 'bal persist <command> --help' for more information on a specific command.