Overview

EzyPlatform is a collection of tools designed to support the development of projects based on EzyPlatform.

You can install the EzyPlatform SDK following the instructions here. For Linux, you will use the ezy.sh command, and for Windows, you will use the ezy.bat command.

List of Commands

The EzyPlatform SDK provides the following commands.

Help

Display basic usage instructions for other commands.

Format:

ezy.sh [help | h | -h | --help]

You can choose any of the help | h | -h | --help commands.

Example:

ezy.sh help

Create Project

Create a project based on EzyPlatform.

Format:

ezy.sh [create | create-project | cp | -cp] <project name> -g <group name, example: com.your_company> -p [package name, example: com.your_company.my_project] -v [version, example: 1.0.0] -i [inclusive modules: all,admin-plugin,socket-app,socket-plugin,theme,web-plugin] -e [exclusive modules: admin-plugin,socket-app,socket-plugin,theme,web-plugin] -a [author] -o [output directory]

Where:

1. You can choose any of the create | create-project | cp | -cp commands.
2. <project name>: This is the mandatory project name, for example, hello-world.
3. -g: This is the mandatory group name, for example, com.your_company.
4. -p: This is the package name and is optional, for example, com.your_company.my_project. If not provided, the package name will be generated by combining the group name with the project name in lowercase and with underscores. For example, com.your_company.hello_world.
5. -v: This is the project version and is optional, for example, 1.0.0. If not provided, the version will default to 1.0.0.
6. -i: These are the module types to be created, listed in the all,admin-plugin,socket-app,socket-plugin,theme,web-plugin and are optional. all means all, and if you don't specify anything, it will default to creating all module types.
7. -e: These are the module types to be excluded, listed in admin-plugin,socket-app,socket-plugin,theme,web-plugin and are optional. If not specified, it defaults to the module types in the -i parameter or all if the -i parameter is not provided.
8. -a: This is the author's name and is optional.
9. -o: This is the project's output directory and is optional. If not provided, it defaults to the current directory.

Example:

ezy.sh cp hello-world -g com.example -p com.example.helloworld -i admin-plugin,web-plugin -e theme -a youngmonkeys -o examples

Link Projects

EzyPlatform allows projects to be linked together for source code reuse.

Format:

ezy.sh link, l, -l [project name, example: my-project] -m [module types: all,admin-plugin,socket-app,socket-plugin,theme,web-plugin]

Where:

1. You can use any of the link, l, -l commands.
2. -m: The module type you want to link, listed in all,admin-plugin,socket-app,socket-plugin,theme,web-plugin and is optional. all means all, and if you don't specify anything, it defaults to all.

Example:

ezy.sh link ezymail -m all

Set Project Version

Format:

ezy.sh set-version, sv, -sv <version>

Where:

1. You can use any of the set-version, sv, -sv commands.
2. <version>: This is the version you want to set and is mandatory.

Example:

ezy.sh sv 1.0.0

Remove Lower Version Libraries

For example, if you have two files for library a named a-1.0.0.jar and a-2.0.0.jar, a-1.0.0.jar will be removed.

Example:

ezy.sh remove-lower-version-libs

Package Project

This command will package the project into a .zip file following the EzyPlatform standard.

Format:

ezy.sh package, p, -p [module name, example: my-project-admin-plugin]

Where:

1. You can use any of the package, p, -p commands.
2. [module name]: This is the name of the module you want to package. If not provided, it defaults to the current directory.

Example:

ezy.sh package

Export Project

This command will export the project components that have been built to the EzyPlatform directory (EZYPLATFORM_HOME).

Format:

ezy.sh export, e, -e [module name, example: my-project-admin-plugin]

Where:

1. You can use any of the package, p, -p commands.
2. [module name]: This is the name of the module you want to package. If not provided, it defaults to the current directory.

Example:

ezy.sh export