hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-09-21 07:28:26 +03:00
Code Issues Projects Releases Wiki Activity

docs: update cli reference (#4728)

Browse Source
This commit is contained in:
Shraddha Agrawal 2020-05-11 17:44:48 +05:30 committed by GitHub
parent 619553ef4e
commit fa509aad3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
34 changed files with 300 additions and 194 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/graphql/manual/hasura-cli/hasura.rst
View File

@ -32,6 +32,7 @@ Options
::
--envfile string .env filename to load ENV vars from (default ".env")
-h, --help help for hasura
--log-level string log level (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
--no-color do not colorize output (default: false)

9
docs/graphql/manual/hasura-cli/hasura_actions.rst
View File

@ -33,15 +33,18 @@ Options
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for actions
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for actions
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
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)

15
docs/graphql/manual/hasura-cli/hasura_actions_codegen.rst
View File

@ -49,12 +49,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_actions_create.rst
View File

@ -52,12 +52,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_actions_use-codegen.rst
View File

@ -51,12 +51,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

1
docs/graphql/manual/hasura-cli/hasura_completion.rst
View File

@ -67,6 +67,7 @@ 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)

21
docs/graphql/manual/hasura-cli/hasura_console.rst
View File

@ -44,21 +44,24 @@ Options
::
--address string address to serve console and migration API from (default "localhost")
--admin-secret string admin secret for Hasura GraphQL engine
--api-port string port for serving migrate api (default "9693")
--browser string open console in a specific browser
--console-port string port for serving console (default "9695")
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for console
--no-browser do not automatically open console in browser
--static-dir string directory where static assets mentioned in the console html template can be served from
--address string address to serve console and migration API from (default "localhost")
--admin-secret string admin secret for Hasura GraphQL Engine
--api-port string port for serving migrate api (default "9693")
--browser string open console in a specific browser
--certificate-authority string path to a cert file for the certificate authority
--console-port string port for serving console (default "9695")
--endpoint string http(s) endpoint for Hasura GraphQL Engine
-h, --help help for console
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--no-browser do not automatically open console in browser
--static-dir string directory where static assets mentioned in the console html template can be served from
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)

11
docs/graphql/manual/hasura-cli/hasura_init.rst
View File

@ -42,17 +42,18 @@ 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 string config version to be used (default "2")
--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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--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)

9
docs/graphql/manual/hasura-cli/hasura_metadata.rst
View File

@ -22,15 +22,18 @@ Options
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for metadata
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL Engine
-h, --help help for metadata
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
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)

15
docs/graphql/manual/hasura-cli/hasura_metadata_apply.rst
View File

@ -47,12 +47,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_clear.rst
View File

@ -47,12 +47,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

19
docs/graphql/manual/hasura-cli/hasura_metadata_diff.rst
View File

@ -33,8 +33,8 @@ Examples
# Show changes between server metadata and that in local_metadata.yaml:
hasura metadata diff local_metadata.yaml
# Show changes between metadata from metadata.yaml and metadata_v1.yaml:
hasura metadata diff metadata.yaml metadata_v1.yaml
# Show changes between metadata from metadata.yaml and metadata_old.yaml:
hasura metadata diff metadata.yaml metadata_old.yaml
# Apply admin secret for Hasura GraphQL engine:
hasura metadata diff --admin-secret "<admin-secret>"
@ -54,12 +54,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_export.rst
View File

@ -49,12 +49,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL Engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_inconsistency.rst
View File

@ -29,12 +29,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_inconsistency_drop.rst
View File

@ -31,12 +31,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_inconsistency_list.rst
View File

@ -33,12 +33,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_inconsistency_status.rst
View File

@ -31,12 +31,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_metadata_reload.rst
View File

@ -45,12 +45,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

9
docs/graphql/manual/hasura-cli/hasura_migrate.rst
View File

@ -20,15 +20,18 @@ Options
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for migrate
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for migrate
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
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)

15
docs/graphql/manual/hasura-cli/hasura_migrate_apply.rst
View File

@ -78,12 +78,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

23
docs/graphql/manual/hasura-cli/hasura_migrate_create.rst
View File

@ -33,6 +33,12 @@ Examples
# Setup migration files from an instance mentioned by the flag:
hasura migrate create init --from-server --endpoint "<endpoint>"
# Take pg_dump of schema and hasura metadata from server while specifying the schemas to include
hasura migrate create init --from-server --schema myschema1,myschema2
# Take pg_dump from server and save it as a migration and specify the schemas to include
hasura migrate create init --sql-from-server --schema myschema1,myschema2
Options
~~~~~~~
@ -42,7 +48,7 @@ Options
-h, --help help for create
--metadata-from-file string path to a hasura metadata file to be used for up actions
--metadata-from-server take metadata from the server and write it as an up migration file
--schema stringArray name of Postgres schema to export as a migration (default [public])
--schema strings name of Postgres schema to export as a migration. provide multiple schemas with a comma separated list e.g. --schema public,user (default [public])
--sql-from-file string path to an SQL file which contains the SQL statements
--sql-from-server take pg_dump from the server and save it as a migration
@ -51,12 +57,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_migrate_squash.rst
View File

@ -47,12 +47,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

15
docs/graphql/manual/hasura-cli/hasura_migrate_status.rst
View File

@ -42,12 +42,15 @@ Options inherited from parent commands
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
--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
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
--envfile string .env filename to load ENV vars from (default ".env")
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--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
~~~~~~~~

8
docs/graphql/manual/hasura-cli/hasura_plugins.rst
View File

@ -15,6 +15,13 @@ Synopsis
Manage Hasura plugins.
Plugins can be installed to extend the functionality of Hasura CLI
An index for all available plugins can be found at
https://github.com/hasura/cli-plugins-index
Please open pull requests against this repo to add new plugins
Alias: plugin
Examples
~~~~~~~~
@ -44,6 +51,7 @@ 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)

4
docs/graphql/manual/hasura-cli/hasura_plugins_install.rst
View File

@ -32,13 +32,15 @@ Options
::
-h, --help help for install
-h, --help help for install
--version string version to be installed
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)

10
docs/graphql/manual/hasura-cli/hasura_plugins_list.rst
View File

@ -29,22 +29,24 @@ Examples
# List all hasura plugins
hasura plugins list
# List all hasura plugins without updating index
hasura plugins list --update-index false
# The command also updates the plugin index that is cached locally
# To avoid updating the index, use the following flag:
hasura plugins list --dont-update-index
Options
~~~~~~~
::
-h, --help help for list
--update-index update plugin index (default true)
--dont-update-index don't update the plugin index local cache, only show the list
-h, --help help for list
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)

1
docs/graphql/manual/hasura-cli/hasura_plugins_uninstall.rst
View File

@ -39,6 +39,7 @@ 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)

4
docs/graphql/manual/hasura-cli/hasura_plugins_upgrade.rst
View File

@ -32,13 +32,15 @@ Options
::
-h, --help help for upgrade
-h, --help help for upgrade
--version string version to be upgraded
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)

7
docs/graphql/manual/hasura-cli/hasura_scripts.rst
View File

@ -7,13 +7,13 @@
Hasura CLI: hasura scripts
--------------------------
Execute helper scripts to manage Hasura Projects
Synopsis
~~~~~~~~
Execute helper scripts to manage Hasura Projects
Options
~~~~~~~
@ -27,6 +27,7 @@ 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)
@ -36,6 +37,6 @@ SEE ALSO
~~~~~~~~
* :ref:`hasura <hasura>` - Hasura GraphQL engine command line tool
* :ref:`hasura scripts update-config-v2 <hasura_scripts_update-config-v2>` - Upgrade config from v1 to v2
* :ref:`hasura scripts update-project-v2 <hasura_scripts_update-project-v2>` - Upgrade config from v1 to v2
*Auto generated by spf13/cobra*

58
docs/graphql/manual/hasura-cli/hasura_scripts_update-config-v2.rst
View File

@ -1,58 +0,0 @@
.. meta::
:description: Use hasura scripts for the update-config-v2 script on the Hasura CLI
:keywords: hasura, docs, CLI, hasura scripts update-config-v2
.. _hasura_scripts_update-config-v2:
Hasura CLI: hasura scripts update-config-v2
-------------------------------------------
Upgrade config from v1 to v2
Synopsis
~~~~~~~~
Upgrade config from v1 to v2
::
hasura scripts update-config-v2 [flags]
Examples
~~~~~~~~
::
# Upgrade config from v1 to v2
hasura scripts update-config-v2
# Upgrade to v2 config with metadata directory set
hasura scripts update-config-v2 --metadata-dir metadata
Options
~~~~~~~
::
--admin-secret string admin secret for Hasura GraphQL engine
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for update-config-v2
--metadata-dir string (default "metadata")
Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--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 scripts <hasura_scripts>` -
*Auto generated by spf13/cobra*

73
docs/graphql/manual/hasura-cli/hasura_scripts_update-project-v2.rst Normal file
View File

@ -0,0 +1,73 @@
.. meta::
:description: Use hasura scripts to list scripts on the Hasura CLI
:keywords: hasura, docs, CLI, hasura scripts
.. _hasura_scripts_update-project-v2:
Hasura CLI: hasura scripts update-project-v2
--------------------------------------------
Update the Hasura Project from v1 to v2.
Synopsis
~~~~~~~~
Update the Hasura Project from v1 to v2 by executing the following actions:
1. Installs a plugin system for CLI
2. Installs CLI Extensions plugins (primarily for actions)
3. Takes a back up of migrations directory
4. Removes all metadata yaml migrations and converts everything to SQL
5. Exports the metadata from server in the new format (multiple files in a directory)
6. Re-write the config.yaml file to new format
::
hasura scripts update-project-v2 [flags]
Alias: update-config-v2
Examples
~~~~~~~~
::
# Read more about v2 configuration for CLI at https://docs.hasura.io
# Update the Hasura Project from v1 to v2
hasura scripts update-project-v2
# Update the Hasura Project from v1 to v2 with a different metadata directory:
hasura scripts update-project-v2 --metadata-dir "metadata"
Options
~~~~~~~
::
--admin-secret string admin secret for Hasura GraphQL engine
--certificate-authority string path to a cert file for the certificate authority
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for update-project-v2
--insecure-skip-tls-verify skip TLS verification and disable cert checking (default: false)
--metadata-dir string (default "metadata")
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 scripts <hasura_scripts>` - Execute helper scripts to manage Hasura Projects
*Auto generated by spf13/cobra*

11
docs/graphql/manual/hasura-cli/hasura_update-cli.rst
View File

@ -7,13 +7,13 @@
Hasura CLI: hasura update-cli
-----------------------------
Update the CLI to the latest version.
Update the CLI to latest or a specific version.
Synopsis
~~~~~~~~
Update the CLI to the latest version.
Update the CLI to latest or a specific version.
::
@ -31,19 +31,24 @@ Examples
# "show_update_notification": false
# in ~/.hasura/config.json
# Update CLI to a specific version (say v1.2.0-beta.1):
hasura update-cli --version v1.2.0-beta.1
Options
~~~~~~~
::
-h, --help help for update-cli
-h, --help help for update-cli
--version string a specific version to install
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)

1
docs/graphql/manual/hasura-cli/hasura_version.rst
View File

@ -31,6 +31,7 @@ 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)

4
docs/graphql/manual/hasura-cli/index.rst
View File

@ -60,7 +60,7 @@ Commands
- :ref:`hasura plugins uninstall <hasura_plugins_uninstall>`
- :ref:`hasura plugins upgrade <hasura_plugins_upgrade>`
- :ref:`hasura scripts <hasura_scripts>`
- :ref:`hasura scripts update-config-v2 <hasura_scripts_update-config-v2>`
- :ref:`hasura scripts update-project-v2 <hasura_scripts_update-project-v2>`
- :ref:`hasura update-cli <hasura_update-cli>`
- :ref:`hasura version <hasura_version>`
@ -105,7 +105,7 @@ Refer to :ref:`uninstall_hasura_cli`.
hasura plugins uninstall <hasura_plugins_uninstall>
hasura plugins upgrade <hasura_plugins_upgrade>
hasura scripts <hasura_scripts>
hasura scripts update-config-v2 <hasura_scripts_update-config-v2>
hasura scripts update-project-v2 <hasura_scripts_update-project-v2>
hasura update-cli <hasura_update-cli>
hasura version <hasura_version>
uninstall-hasura-cli