.. .. meta::
   :description: User's manual for using Hasura's command line tooling, hasuractl
   :keywords: hasura, docs, CLI, HasuraCTL, hasuractl

.. _hasuracli-manual:

.. highlight:: bash

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

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

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

.. _hasuractl-installation:

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

Refer to :doc:`install-hasura-cli`.


Commands
--------

- :doc:`hasura <hasura>`
- :doc:`hasura completion <hasura_completion>`
- :doc:`hasura console <hasura_console>`
- :doc:`hasura init <hasura_init>`
- :doc:`hasura metadata <hasura_metadata>`
- :doc:`hasura metadata apply <hasura_metadata_apply>`
- :doc:`hasura metadata export <hasura_metadata_export>`
- :doc:`hasura metadata reload <hasura_metadata_reload>`
- :doc:`hasura metadata reset <hasura_metadata_reset>`
- :doc:`hasura migrate <hasura_migrate>`
- :doc:`hasura migrate apply <hasura_migrate_apply>`
- :doc:`hasura migrate create <hasura_migrate_create>`
- :doc:`hasura migrate status <hasura_migrate_status>`
- :doc:`hasura update-cli <hasura_update-cli>`
- :doc:`hasura version <hasura_version>`

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

Refer to :doc:`uninstall-hasura-cli`.

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

   install-hasura-cli
   hasura <hasura>
   hasura completion <hasura_completion>
   hasura console <hasura_console>
   hasura init <hasura_init>
   hasura metadata <hasura_metadata>
   hasura metadata apply <hasura_metadata_apply>
   hasura metadata export <hasura_metadata_export>
   hasura metadata reload <hasura_metadata_reload>
   hasura metadata reset <hasura_metadata_reset>
   hasura migrate <hasura_migrate>
   hasura migrate apply <hasura_migrate_apply>
   hasura migrate create <hasura_migrate_create>
   hasura migrate status <hasura_migrate_status>
   hasura update-cli <hasura_update-cli>
   hasura version <hasura_version>
   uninstall-hasura-cli