graphql-engine/docs/graphql/core/hasura-cli/hasura_init.rst

68 lines
1.9 KiB
ReStructuredText
Raw Normal View History

.. meta::
:description: Use hasura init to initialise a directory for Hasura migrations on the Hasura CLI
:keywords: hasura, docs, CLI, hasura init
.. _hasura_init:
Hasura CLI: hasura init
-----------------------
2019-09-11 10:17:14 +03:00
Initialize a directory for Hasura GraphQL engine migrations.
Synopsis
~~~~~~~~
2019-09-11 10:17:14 +03:00
Create directories and files required for enabling migrations on the Hasura GraphQL engine.
::
2020-02-24 19:19:14 +03:00
hasura init [directory-name] [flags]
Examples
~~~~~~~~
::
2018-12-07 15:08:39 +03:00
# Create a directory to store migrations
2020-02-24 19:19:14 +03:00
hasura init [directory-name]
# Now, edit <my-directory>/config.yaml to add endpoint and admin secret
# Create a directory with endpoint and admin secret configured:
2020-02-24 19:19:14 +03:00
hasura init <my-project> --endpoint https://my-graphql-engine.com --admin-secret adminsecretkey
2018-12-07 15:08:39 +03:00
# Create a hasura project in the current working directory
hasura init .
# See https://hasura.io/docs/1.0/graphql/manual/migrations/index.html for more details
Options
~~~~~~~
::
2020-05-11 15:14:48 +03:00
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for init
--install-manifest string install manifest to be cloned
--version int config version to be used (default 2)
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
2020-05-11 15:14:48 +03:00
--envfile string .env filename to load ENV vars from (default ".env")
--log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
2019-12-02 13:57:17 +03:00
--no-color do not colorize output (default: false)
--project string directory where commands are executed (default: current dir)
2020-02-24 19:19:14 +03:00
--skip-update-check skip automatic update check on command execution
SEE ALSO
~~~~~~~~
2019-09-11 10:17:14 +03:00
* :ref:`hasura <hasura>` - Hasura GraphQL engine command line tool
*Auto generated by spf13/cobra*