1
0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-21 14:31:55 +03:00
graphql-engine/docs/graphql/core/hasura-cli/hasura_init.rst
Kali Vara Purushotham Santhati c3e60aba28 cli: update cli help texts and docs generation
Co-authored-by: Rikin Kachhia <54616969+rikinsk@users.noreply.github.com>
Co-authored-by: Aravind K P <8335904+scriptonist@users.noreply.github.com>
GitOrigin-RevId: b6909583093baac4a69296721feae149ca6a0605
2021-03-15 15:41:54 +00:00

68 lines
1.9 KiB
ReStructuredText

.. meta::
:description: Initialize a directory for Hasura GraphQL engine migrations using the Hasura CLI
:keywords: hasura, docs, CLI, hasura init
.. _hasura_init:
Hasura CLI: hasura init
-----------------------
Initialize a directory for Hasura GraphQL engine migrations.
Synopsis
~~~~~~~~
Create directories and files required for enabling migrations on the Hasura GraphQL engine.
::
hasura init [directory-name] [flags]
Examples
~~~~~~~~
::
# Create a directory to store migrations
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:
hasura init <my-project> --endpoint https://my-graphql-engine.com --admin-secret adminsecretkey
# Create a hasura project in the current working directory
hasura init .
# See https://hasura.io/docs/latest/graphql/core/migrations/index.html for more details
Options
~~~~~~~
::
--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 3)
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--envfile string .env filename to load ENV vars from (default ".env")
--log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
--no-color do not colorize output (default: false)
--project string directory where commands are executed (default: current dir)
--skip-update-check skip automatic update check on command execution
SEE ALSO
~~~~~~~~
* :ref:`hasura <hasura>` - Hasura GraphQL engine command line tool
*Auto generated by spf13/cobra*