Gatec NPM | npm.io

Note The use is only allowed if you are part of the GATEC S/A organization.

Installing

Use the npx program, built into the npm cli (or similar features with other package managers) to ensure that you run a managed version of the Gatec CLI.

Using npm:

$ npm install -g gatec

Using yarn:

$ yarn global add gatec

Using pnpm:

$ pnpm add -g gatec

or use npx:

$ npx gatec ...commands

How to use

Global installation or running within your application

Help for showing commands

$ gatec --help

Update Permission

$ gatec config permission

NPX

You can invoke CLI commands directly from your OS command line through the nest executable. See the available nest commands by entering the following:

$ npx gatec --help

Get help on an individual command using the following construct. Substitute any command, like app, package e etc, the example below to get detailed help on that command:

$ npx gatec app --help

API

All gatec commands follow the same format:

$ npx gatec commandOrAlias requiredArg [options]

App Command

Start

Compiles and runs an application in development mode.

$ npx gatec app start

Build

Compiles an application into an output folder in production mode.

$ npx gatec app build

New

Create a new standard mode application with all boilerplate files needed to run.

$ npx gatec app new [nameFolder]

*nameFolder mandatory option accepts a folder name relative to the current folder, to create in the current folder use .*

*--install or -i optional parameter installs dependencies at the end of the build process.*

Generate

Generate a structure according to the entity name

$ npx gatec app generate [collection] [nameEntity]

*collection mandatory option accepts the following options: 'all' | 'domain', 'application', 'main', 'presentation'. .*
*nameEntity mandatory option accepts alphabetic string. .*

Packages Command

Build

Compiles the package to an output folder in production mode.

$ npx gatec packages build

Config Command

Permission

Add or update your credentials for private @gatec packages

$ npx gatec config permission

*--global configure permissions globally per user*

*--envFile optional parameter to set permissions through an .env file, enter the path to the file*

Docs Command

Show documentation Gatec

$ npx gatec docs

License

All rights reserved. Distributed under the following terms:
The use is only allowed if you are part of the GATEC S/A organization, any > modification, use or editing must be authorized.
IF YOU ARE NOT ASSOCIATED WITH THE COMPANY GATEC S/A, YOU ARE NOT AUTHORIZED TO ACCESS OR USE OR ALLOW ANY USER TO ACCESS OR USE ANY PART OF THE CORPORATE EDITION OF THE CLI SOFTWARE.

cli