From e780bd0ba2238a369316cb548adca1471667519f Mon Sep 17 00:00:00 2001 From: Mees van der Wijk Date: Thu, 28 Aug 2025 00:49:03 +0200 Subject: [PATCH] Updated specs --- GetiyoModuleTool.md | 8 ++++++-- ModuleClientAPI.md | 10 +++++----- ModuleConfigCondition.md | 2 +- ModuleConfigProperty.md | 2 +- ModuleConfigTrigger.md | 2 +- ModuleEnvironment.md | 41 +++++++++++++++++++++------------------- V2ModuleStructure.md | 2 +- 7 files changed, 37 insertions(+), 30 deletions(-) diff --git a/GetiyoModuleTool.md b/GetiyoModuleTool.md index bcf7e4e..89cd86f 100644 --- a/GetiyoModuleTool.md +++ b/GetiyoModuleTool.md @@ -22,14 +22,18 @@ Watch a module workspace and combine on `b` keypress. Create a new development environment. GMT will ask some questions to generate the wanted environment settings. -## `install` +## `upgrade` -Install the current build in .dist to your local server. +Upgrade the [ModuleServerAPI](./ModuleServerAPIIntroduction) and [ModuleClientAPI](./ModuleClientAPIIntroduction) type definitions within a existing module workspace. ## `publish` Publish the latest build to the [ModuleStore](./ModuleStore). +## `install` + +Install the current build in .dist to your local server. + ## `set ` - * `gmt set port ` -[Full documentation of the GetiyoModuleTool.](./GetiyoModuleTool.md) \ No newline at end of file +1. Open the root directory of the module environment in a terminal. +2. Run `gmt build` +3. Additionally, you can also let GMT automatically install the module to your local server with the argument `--output-server` +4. You can also restart the server with `--stop-server` but development mode has to be turned on and you have to configure your server details first with: + - `gmt set ip ` + - `gmt set port ` + +[Full documentation of the GetiyoModuleTool.](./GetiyoModuleTool) diff --git a/V2ModuleStructure.md b/V2ModuleStructure.md index 52359d4..0986928 100644 --- a/V2ModuleStructure.md +++ b/V2ModuleStructure.md @@ -29,7 +29,7 @@ Module Root ## Module.ts -The module.ts file serves as the central configuration file for each module in Getiyo. Unlike the old `module.json` file it has full type definitions making it easier to configure. It contains essential metadata that informs Getiyo about the module's identity, as well as the module's properties, triggers, and conditions. The [GetiyoModuleTool](./GetiyoModuleTool) can automatically generate this file for you, streamlining the setup process. However, if you want to modify or add properties, triggers, or conditions, you can refer to the module.json section in the documentation. To learn more about the [module.ts](./ModuleTS.md) file. +The module.ts file serves as the central configuration file for each module in Getiyo. Unlike the old `module.json` file it has full type definitions making it easier to configure. It contains essential metadata that informs Getiyo about the module's identity, as well as the module's properties, triggers, and conditions. The [GetiyoModuleTool](./GetiyoModuleTool) can automatically generate this file for you, streamlining the setup process. However, if you want to modify or add properties, triggers, or conditions, you can refer to the module.json section in the documentation. To learn more about the [module.ts](./ModuleTS) file. ## Server-Side