@golemio/cli v1.5.0

Golemio CLI

Golemio CLI is a collection of executables intended to be used with Golemio projects and modules

Install the CLI

Prerequisites

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

Install globally

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

# With yarn
$ yarn global add @golemio/cli

# Test it out
$ golemio

Install locally

$ cd my-project

# With npm
$ npm install --save-dev @golemio/cli

# With Yarn
$ yarn add --dev @golemio/cli

# Test it out
$ npm run golemio
$ yarn golemio

Commands summary

Environmental variables

Development

Prerequisites

• Yarn (https://yarnpkg.com)

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)

$ yarn
$ 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

$ yarn 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

$ yarn test-integration

License

MIT