Updated specs for module tool
@@ -1,24 +1,31 @@
|
|||||||
# Getiyo Module Tool
|
# Getiyo Module Tool
|
||||||
|
|
||||||
The GetiyoModuleTool (or GMT in short) is the development tool for Getiyo. It can create development environments, build/install modules and publish them to the [ModuleStore](./ModuleStore). GMT has four modes which are described below.
|
The GetiyoModuleTool (or GMT in short) is the development tool for Getiyo. It can create development environments, build/install modules and publish them to the [ModuleStore](./ModuleStore). GMT has four modes which are described below.
|
||||||
|
|
||||||
## build - ```gmt build```
|
## gmt `build`
|
||||||
|
|
||||||
Build a module to the `.dist` directory.
|
Build a module to the `.dist` directory.
|
||||||
|Argument|Description|
|
|Argument|Description|
|
||||||
|-|-|
|
|-|-|
|
||||||
--output-server|Output the build to your local server. Requires ip & port to be set (See [set](./GetiyoModuleTool#set-gmt-set-property-value))
|
--output-server|Output the build to your local server. Requires ip & port to be set (See [set](./GetiyoModuleTool#set-gmt-set-property-value))
|
||||||
--stop-server|Restart the server when the build is finished. Requires development mode to be turned on in the [config](./Config).
|
--stop-server|Restart the server when the build is finished. Requires development mode to be turned on in the [config](./Config).
|
||||||
|
|
||||||
## create - ```gmt create```
|
## gmt `create`
|
||||||
|
|
||||||
Create a new development environment. GMT will ask some questions to generate the wanted environment settings.
|
Create a new development environment. GMT will ask some questions to generate the wanted environment settings.
|
||||||
|
|
||||||
## install - ```gmt install```
|
## gmt `install`
|
||||||
|
|
||||||
Install the current build in .dist to your local server.
|
Install the current build in .dist to your local server.
|
||||||
|
|
||||||
## set - ```gmt set <property> <value```
|
## gmt `publish`
|
||||||
|
|
||||||
|
Publish the latest build to the [ModuleStore](./ModuleStore).
|
||||||
|
|
||||||
|
## gmt `set <property> <value`
|
||||||
|
|
||||||
Update a GMT settings.
|
Update a GMT settings.
|
||||||
|Property|Description|
|
|Property|Description|
|
||||||
|ip|Local server ip address
|
|ip|Local server ip address.
|
||||||
|port|Local server port
|
|port|Local server port.
|
||||||
|
|publishkey|Publish key for the module store.
|
||||||
## publish - ```gmt publish```
|
|
||||||
Publish the latest build to the ModuleStore. This requires a publish-key (see [ModuleStore](./ModuleStore)).
|
|
||||||
|
|||||||
Reference in New Issue
Block a user