mads command line tool reference
General usage: mads <command> [subcommand] [arguments]. Help for each command is available with mads help <command>.
Global options
| Option | Description |
|---|---|
-h, --help |
Shows the help |
-v, --verbose |
Shows additional output |
--version |
Platform and tool versions, latest published version and install kind |
--update |
Updates the tool (Homebrew or Git clone) or explains how to |
--prefs |
Shows the mads preferences |
--edit |
Edits the mads preferences (for example M2_HOME) |
--clear |
Clears the mads cache |
--clean |
Removes the MADS artifacts from the local Maven repository |
Commands
create
Creates a new project.
| Subcommand | Description |
|---|---|
module |
Creates a module (default) |
runtime |
Creates a runtime for a module |
app |
Creates an app for a module |
cnn |
Creates a connection file for a module |
userid |
Creates or updates a user id |
generate
Generates the entity model and other resources.
| Subcommand | Description |
|---|---|
module |
Generates every resource of the module |
model |
Generates the database entity model (Java) |
dart |
Generates the Dart entity model |
texts |
Generates the text resources |
params |
Generates the parameter dictionary |
bundle |
Generates the application bundle |
dbschema |
Generates the database schema from an existing database |
module
Module utilities. Options: --modulePath, -n/--moduleName, --out, --defaultRuntime, --version.
| Subcommand | Description |
|---|---|
list |
Lists the available MADS modules |
version |
Manages the module version |
generate |
Generates every resource of the module |
test |
Runs the module tests |
build |
Compiles, packages and installs into the local Maven repository |
deploy |
Deploys the module to the Maven repository |
update |
Updates the module's IDE resources |
app
App utilities. Options: --modulePath, --runtime, --default, --version.
| Subcommand | Description |
|---|---|
list |
Lists the available apps |
version |
Manages the app version |
update |
Updates the app's IDE resources |
run
Runs a module with its default runtime or with --runtime <name>. Options: --list, --modulePath, --locale, --username, --password, --nosplash. The app subcommand downloads and runs an app from the WAPP repository.
pub
Publishes to the WAPP service.
| Subcommand | Description |
|---|---|
module |
Publishes a module |
app |
Publishes an app |
role |
Manages the WAPP service roles |
test
mads test module runs the tests of a module.
doc
| Subcommand | Description |
|---|---|
generate |
Generates the database documentation |
publish |
Publishes the documentation to a remote server |
devtool
Opens the development tools of a module.
| Subcommand | Description |
|---|---|
domains |
Domains inspector |
db |
Database inspector |
dbsync |
Database synchronisation |
security |
Security tool |
texts |
Resource translation |
migrate and fix
mads migrate module: migrates a module from MADS 4.6 to MADS V5.mads fix module: fixes a module so it is compatible with MADS V5.
Environment variables
| Variable | Use |
|---|---|
JAVA_HOME_MADS |
JDK that runs mads (takes precedence over java in PATH and JAVA_HOME) |
M2_HOME |
Maven installation used by the module commands |
MADS_NO_UPDATE_CHECK |
When set, disables the new version check |