@golemio/cli

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 locally (recommended)

$ cd my-project

# With Yarn
$ yarn add --dev @golemio/cli
# For Mongo support, run yarn add --dev install mongoose mongodb-restore-dump

# With npm
$ npm install --save-dev @golemio/cli
# For Mongo support, run npm install --save-dev mongoose mongodb-restore-dump

# Test it out
$ yarn golemio
$ npm exec golemio

Install globally

# With Yarn
$ yarn global add @golemio/cli
# For Mongo support, run yarn global add mongoose mongodb-restore-dump

# With npm
$ npm install -g @golemio/cli
# For Mongo support, run npm install -g mongoose mongodb-restore-dump

# Test it out
$ golemio

Commands summary

Command	Description
golemio	Default command (welcome)
golemio help	View available commands
golemio migrate-db help	View available migration commands and flags
golemio migrate-db create <name>	Create new migration scripts (--postgres or --mongo)
golemio migrate-db up	Execute up migrations (--postgres and/or --mongo)
golemio migrate-db down	Execute down migrations (--postgres and/or --mongo)
golemio migrate-db reset	Reset all executed migrations (--postgres and/or --mongo)
golemio import-db-data help	View available db data import commands and flags
golemio import-db-data	Import db data (--postgres and/or --mongo)

Environmental variables

Variable	Example	Required
POSTGRES_CONN	postgres://oict:oict-pass@localhost/oict-test	:white_check_mark: (mdb and idd postgres)
MONGO_CONN	mongodb://localhost:27017/oict-test	:white_check_mark: (mdb and idd mongo)
POSTGRES_MIGRATIONS_DIR	db/migrations/postgresql (default)	:negative_squared_cross_mark:
SQL_DUMP_FILES	db/example/*.sql	:white_check_mark: (idd postgres)
MONGO_DATA_PATHS	db/example/**/mongo_data	:white_check_mark: (idd mongo)

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

Changelog

[1.2.2] - 2022-05-02

Changed

• Stop printing "public" as a secondary schema in the summary matrix
• Print migrations' location (module or path) in the summary matrix