Inherited Options

These options can be provided to most GX commands.

1. --config

The application YAML configuration file.

GX automatically searches for the config file in the current directory. As a result, the --config option is optional.

If there are multiple YAML files in the current directory, an error is thrown; indicating the need for one to be specified using--config.

2. --gxFile

The properties file for gx.

Please refer to the Properties File section for additional information.

3. --quiet

Logs errors only.

4. --env_name

Environment scope of the application.

By default, this is read from the application YAML file and defaults to default.

This enables multiple developers to load their own copy of the same application, isolated from each other, by loading into specific "Environments".

Here are additional ways to set the environment name. Here they are, in order of precedence from highest to lowest:

  1. --env_name

  2. env_name field in the application YAML configuration file.

  3. $GRAINITE_ENV environment variable.

  4. gx.env_name in the gx config file (located at ~/.gx by default.).

5. --host

The IP address of the Grainite server.

Default: localhost.

6. --port

The data service port of the Grainite server.

Default: 5056.

7. --health_port

The health check endpoint port for the Grainite server.

Gx performs a health check before running any command that requires connecting to the server. This can be disabled by using --skip_health_check.

Default: 5064.

8. --skip_health_check

Set this flag to skip performing a server health check.

Default: false.

9. --verbose

Set this flag to print out stack traces for errors.

Default: false.

10. --tls

Use TLS.

Client certificates must be set in the gx properties file to use this TLS. Refer to the 'Using Grainite with TLS" page for more information.

Default: false.

11. --pass

Client PKCS 12 certificate password. To be used with --tls.

If TLS is enabled and the password for the PKCS 12 certificate isn't provided, the user will be prompted to enter the password at runtime.

Default: not set.

Last updated