Hasura CLI Configuration Reference¶

Introduction¶

Hasura CLI commands can get key values from flags, ENV variables, a .env file or the configuration file config.yaml.

Configuration file¶

In order for the Hasura CLI to work, the config.yaml file is required (created automatically via the hasura init command). The configuration file can be configured with the following config keys:

version:
endpoint:
admin_secret:
insecure_skip_tls_verify:
certificate_authority:
access_key: #deprecated
api_paths:
  query:
  graphql:
  config:
  pg_dump:
  version:
metadata_directory:
migrations_directory:
actions:
  kind:
  handler_webhook_baseurl:
  codegen:
    framework:
    output_dir:
    uri:

Environment variables¶

The configuration can also be set in the form of environment variables:

CLI flags¶

The above keys can be set using command-line flags as well. The corresponding flag, for the ENV vars or the configuration keys, can be found in the respective commands reference manual.

.env file¶

Alternatively, environment variables can also be read from the .env file, created manually by the user, at the project root directory. A global flag, --envfile, is available to explicitly get the .env file created by the user, which defaults to .env if no flag is provided.

It’s important to note that this will not override an ENV variable that already exists.

Example:

hasura console --envfile production.env

The above command will read ENV vars from the production.env file present at the project root directory.