Skip to main content

Command Line Interface

Introduction

It’s a tool that expedites the application setup in a local development environment and enables the publication of post-development changes on the platform. Within a few steps, you can easily complete the setup of newly created projects or current ones.

Command List

Below are the primary commands of the tool which will work as a wizard during development processes:

CommandAction
loginLogin for App Maker platform
logoutLogout from App Maker platform
setupEnables the setup of a project managed on the platform to local
setup:boilerplateEnables the setup to local with the default boilerplate
installInstalls the project to local by taking the App Maker meta.json file as reference
publishSends made developments to the platform
iosRuns the application on iOS emulator
androidRuns the application on Android emulator
startStarts the development server
clear-cacheClears the App Maker cache files
infoShow the project's meta information

login

Many processes via CLI require a membership. Some of them are setup and setup:boilerplate commands.

Example:
$ app-maker login

logout

This command enables you to safely log out of CLI.

Example:
$ app-maker logout

setup

This command enables the setup of a project managed on the App Maker platform. It’s frequently utilized for daily use.

Example:
$ app-maker setup

setup:boilerplate

This command enables the setup of an application based on the default boilerplate. It’s usually preferred to create new customer applications.

Example:
$ app-maker setup:boilerplate

install

This command installs a project via the meta.json file. If the .app-maker/meta.json file exists within a directory, it first verifies the information here and then starts the installation of the project.

Example:
$ app-maker install

publish

This command published the developments on the project (project package) on the App Maker platform. A published package will be used in following app installations.

Note: This command requires the running of the project’s root directory.

Example:
$ app-maker publish

The branch of the project that will be published on the App Maker platform can be determined with the parameter given to the command. If no parameter is given, the branch name in the meta-information is used. master or development can be given as a parameter. Branch names other than these are not accepted and the user is warned by giving an error.

Example:
$ app-maker publish master

If the branch info given as a parameter is different from the meta information, a warning message is shown to the user whether he wants to continue or not. If the user does not want to continue, the process is terminated.

ios

This command runs the application on the iOS emulator.

Example:
$ app-maker ios

android

This command runs the application on the Android emulator.

Example:
$ app-maker android

start

This command starts the development server to make developments on the application.

Example:
$ app-maker start

clear-cache

This command clears the cache memory of the yarn dependency management.

Example:
$ app-maker clear-cache

info

This command displays the project’s meta information.

Example:
 $ app-maker info