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

.. meta::
   :description: Use Hasura's command line tooling
   :keywords: hasura, docs, CLI

.. _hasuracli_manual:

Hasura CLI
==========

.. highlight:: bash

.. contents:: Table of contents
  :backlinks: none
  :depth: 1
  :local:

Introduction
------------

The ``Hasura CLI`` is a command line tool which is the primary mode of managing Hasura projects and migrations.

Installation
------------

Refer to :ref:`install_hasura_cli`.

Configuration
-------------

Refer to :ref:`cli_config_reference`.

Commands
--------

- :ref:`hasura actions <hasura_actions>`
- :ref:`hasura <hasura>`
- :ref:`hasura actions codegen <hasura_actions_codegen>`
- :ref:`hasura actions create <hasura_actions_create>`
- :ref:`hasura actions use-codegen <hasura_actions_use-codegen>`
- :ref:`hasura completion <hasura_completion>`
- :ref:`hasura console <hasura_console>`
- :ref:`hasura init <hasura_init>`
- :ref:`hasura metadata <hasura_metadata>`
- :ref:`hasura metadata apply <hasura_metadata_apply>`
- :ref:`hasura metadata clear <hasura_metadata_clear>`
- :ref:`hasura metadata diff <hasura_metadata_diff>`
- :ref:`hasura metadata export <hasura_metadata_export>`
- :ref:`hasura metadata inconsistency <hasura_metadata_inconsistency>`
- :ref:`hasura metadata inconsistency drop <hasura_metadata_inconsistency_drop>`
- :ref:`hasura metadata inconsistency list <hasura_metadata_inconsistency_list>`
- :ref:`hasura metadata inconsistency status <hasura_metadata_inconsistency_status>`
- :ref:`hasura metadata reload <hasura_metadata_reload>`
- :ref:`hasura migrate <hasura_migrate>`
- :ref:`hasura migrate apply <hasura_migrate_apply>`
- :ref:`hasura migrate create <hasura_migrate_create>`
- :ref:`hasura migrate delete <hasura_migrate_delete>`
- :ref:`hasura migrate squash <hasura_migrate_squash>`
- :ref:`hasura migrate status <hasura_migrate_status>`
- :ref:`hasura plugins <hasura_plugins>`
- :ref:`hasura plugins install <hasura_plugins_install>`
- :ref:`hasura plugins list <hasura_plugins_list>`
- :ref:`hasura plugins uninstall <hasura_plugins_uninstall>`
- :ref:`hasura plugins upgrade <hasura_plugins_upgrade>`
- :ref:`hasura scripts <hasura_scripts>`
- :ref:`hasura scripts update-project-v2 <hasura_scripts_update-project-v2>`
- :ref:`hasura scripts update-project-v3 <hasura_scripts_update-project-v3>`
- :ref:`hasura seed <hasura_seed>`
- :ref:`hasura seed apply <hasura_seed_apply>`
- :ref:`hasura seed create <hasura_seed_create>`
- :ref:`hasura update-cli <hasura_update-cli>`
- :ref:`hasura version <hasura_version>`

Uninstalling
------------

Refer to :ref:`uninstall_hasura_cli`.

.. toctree::
   :maxdepth: 1
   :titlesonly:
   :hidden:

   install-hasura-cli
   Configuration reference <config-reference>
   hasura <hasura>
   hasura actions <hasura_actions>
   hasura actions codegen <hasura_actions_codegen>
   hasura actions create <hasura_actions_create>
   hasura actions use-codegen <hasura_actions_use-codegen>
   hasura completion <hasura_completion>
   hasura console <hasura_console>
   hasura init <hasura_init>
   hasura metadata <hasura_metadata>
   hasura metadata apply <hasura_metadata_apply>
   hasura metadata clear <hasura_metadata_clear>
   hasura metadata diff <hasura_metadata_diff>
   hasura metadata export <hasura_metadata_export>
   hasura metadata inconsistency <hasura_metadata_inconsistency>
   hasura metadata inconsistency drop <hasura_metadata_inconsistency_drop>
   hasura metadata inconsistency list <hasura_metadata_inconsistency_list>
   hasura metadata inconsistency status <hasura_metadata_inconsistency_status>
   hasura metadata reload <hasura_metadata_reload>
   hasura migrate <hasura_migrate>
   hasura migrate apply <hasura_migrate_apply>
   hasura migrate create <hasura_migrate_create>
   hasura migrate delete <hasura_migrate_delete>
   hasura migrate squash <hasura_migrate_squash>
   hasura migrate status <hasura_migrate_status>
   hasura plugins <hasura_plugins>
   hasura plugins install <hasura_plugins_install>
   hasura plugins list <hasura_plugins_list>
   hasura plugins uninstall <hasura_plugins_uninstall>
   hasura plugins upgrade <hasura_plugins_upgrade>
   hasura scripts <hasura_scripts>
   hasura scripts update-project-v2 <hasura_scripts_update-project-v2>
   hasura scripts update-project-v3 <hasura_scripts_update-project-v3>
   hasura seed <hasura_seed>
   hasura seed apply <hasura_seed_apply>
   hasura seed create <hasura_seed_create>
   hasura update-cli <hasura_update-cli>
   hasura version <hasura_version>
   uninstall-hasura-cli