@golemio/cli v1.7.3

Golemio CLI

Golemio CLI is a collection of executables intended for use with Golemio services and modules

Install the CLI

Prerequisites

• Node.js version 14 or later (https://nodejs.org)

Install locally (recommended)

$ cd my-project

# With Yarn
$ yarn add --dev @golemio/cli
# For Portman support, run yarn add --dev @apideck/portman@^1.16.1

# With npm
$ npm install --save-dev @golemio/cli
# For Portman support, run npm install --save-dev @apideck/portman@^1.16.1

# Test it out
$ yarn golemio
$ npm exec golemio

Install globally

# With Yarn
$ yarn global add @golemio/cli

# With npm
$ npm install -g @golemio/cli

# Test it out
$ golemio

Commands summary

Read release_management_CZ for more info to release command.

Environmental variables

The value of the variable GITLAB_API_TOKEN should be created in GitLab User Settings page Access Tokens. Token scopes are api, read_repository and write_repository.

Development

Local environment

To set up your local development environment, install project dependencies and create .env file in the root of the project (see .env.template for reference)

$ npm install
$ cp .env.template .env

Now you can run the CLI in development mode, just type

$ ./bin/golemio.js

You don't need to compile the source code as the script automatically registers the ts-node loader in development mode

Unit tests

Unit tests are located at test/unit. You can run them by typing

$ npm run test-unit

Integration tests

Integration tests are located at test/integration. You can run them by typing

# Run local services, recommended
$ docker-compose up -d

$ npm run test-integration

License

MIT