Skip to main content
Version: v2.x

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:
seeds_directory:
actions:
kind:
handler_webhook_baseurl:
codegen:
framework:
output_dir:
uri:
Config KeyRequiredSupported since Config VersionDefault value
versionfalse13
endpointtrue1http://localhost:8080
admin_secretfalse1
access_keyfalse1 (Deprecated)
insecure_skip_tls_verifyfalse1 (added in v1.2.0)false
certificate_authorityfalse1 (added in v1.2.0)
api_pathsfalse1
api_paths.queryfalse1v1/query
api_paths.graphqlfalse1v1/graphql
api_paths.configfalse1v1alpha1/config
api_paths.pg_dumpfalse1v1alpha1/pg_dump
api_paths.versionfalse1v1/version
metadata_directoryfalse2
migrations_directoryfalse1migrations
seeds_directoryfalse2
actionsfalse2
actions.kindtrue2synchronous
actions.handler_webhook_baseurltrue2http://localhost:3000
actions.codegenfalse2
actions.codegen.frameworktrue2
actions.codegen.output_dirtrue2
actions.codegen.urifalse2
Note

The above structure is for the config v3 file which is supported since v2.0.0-alpha.1. Refer to this page on how to upgrade to config v2.

Environment variables

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

ENV variableConfig file keyDescription
HASURA_GRAPHQL_VERSIONversionConfig version to be used.
HASURA_GRAPHQL_ENDPOINTendpointhttp(s) endpoint for Hasura GraphQL engine.
HASURA_GRAPHQL_ADMIN_SECRETadmin_secretAdmin secret for Hasura GraphQL engine.
HASURA_GRAPHQL_ACCESS_KEYaccess_keyAccess key for Hasura GraphQL engine. Note: Deprecated. Use admin secret instead.
HASURA_GRAPHQL_INSECURE_SKIP_TLS_VERIFYinsecure_skip_tls_verifySkip verifying SSL certificate for the Hasura endpoint. Useful if you have a self-singed certificate and don't have access to the CA cert.
HASURA_GRAPHQL_CERTIFICATE_AUTHORITYcertificate_authorityPath to the CA certificate for validating the self-signed certificate for the Hasura endpoint.
HASURA_GRAPHQL_API_PATHS_QUERYapi_paths.querySchema/ metadata API endpoint. More details at Schema / metadata API (Deprecated).
HASURA_GRAPHQL_API_PATHS_GRAPHQLapi_paths.graphqlGraphQL API endpoint. More details at GraphQL API.
HASURA_GRAPHQL_API_PATHS_CONFIGapi_paths.configConfig API endpoint. More details at Config API`.
HASURA_GRAPHQL_API_PATHS_PG_DUMPapi_paths.pg_dumpPG Dump API endpoint. More details at pg_dump API.
HASURA_GRAPHQL_API_PATHS_VERSIONapi_paths.versionVersion API endpoint. More details at RESTified GraphQL API.
HASURA_GRAPHQL_METADATA_DIRECTORYmetadata_directoryDefines the directory where the metadata files were stored.
HASURA_GRAPHQL_MIGRATIONS_DIRECTORYmigrations_directoryDefines the directory where the migration files were stored.
HASURA_GRAPHQL_SEEDS_DIRECTORYseeds_directoryDefines the directory where the seed files were stored.
HASURA_GRAPHQL_ACTIONS_KINDactions.kindKind to be used for actions.
HASURA_GRAPHQL_ACTIONS_HANDLER_WEBHOOK_BASEURLactions.handler_webhook_baseurlWebhook baseurl to be used for actions.
HASURA_GRAPHQL_ACTIONS_CODEGEN_FRAMEWORKactions.codegen.frameworkFramework to codegen for actions.
HASURA_GRAPHQL_ACTION_CODEGEN_OUTPUT_DIRactions.codegen.output_dirDefines the directory to create the codegen files.
HASURA_GRAPHQL_ACTION_CODEGEN_URIactions.codegen.uriURI to codegen for actions.

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.

Supported from

.env file is supported in versions v1.2.0 and above.

Note

Precedence order is flag > ENV vars > .env file values > configuration file values > default.