graphql-engine/docs/graphql/manual/hasura-cli/hasura_console.rst

63 lines
1.8 KiB
ReStructuredText
Raw Normal View History

.. meta::
:description: Use hasura console to open the Hasura console from the Hasura CLI
:keywords: hasura, docs, CLI, hasura console
.. _hasura_console:
Hasura CLI: hasura console
--------------------------
2019-09-11 10:17:14 +03:00
Open the console to manage the database and try out APIs.
Synopsis
~~~~~~~~
2019-09-11 10:17:14 +03:00
Run a web server to serve the Hasura console for the GraphQL engine to manage the database and build queries.
::
hasura console [flags]
Examples
~~~~~~~~
::
# Start console:
hasura console
# Start console on a different address and ports:
hasura console --address 0.0.0.0 --console-port 8080 --api-port 8081
Options
~~~~~~~
::
--address string address to serve console and migration API from (default "localhost")
2019-09-11 10:17:14 +03:00
--admin-secret string admin secret for Hasura GraphQL engine
--api-port string port for serving migrate api (default "9693")
--console-port string port for serving console (default "9695")
2019-09-11 10:17:14 +03:00
--endpoint string http(s) endpoint for Hasura GraphQL engine
-h, --help help for console
2018-12-07 15:08:39 +03:00
--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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
--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)
--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*