graphql-engine/cli
hasura-bot bc10d9eb1c cli: fix changelog hyperlink in the log message
GITHUB_PR_NUMBER: 6936
GITHUB_PR_URL: https://github.com/hasura/graphql-engine/pull/6936

closes https://github.com/hasura/graphql-engine/issues/6682

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/1365
Co-authored-by: pow-devops2020 <69558219+pow-devops2020@users.noreply.github.com>
Co-authored-by: Aravind K P <8335904+scriptonist@users.noreply.github.com>
GitOrigin-RevId: fbf66ea7e4abe0be8684b8e6cc7361f14a6faea0
2021-11-11 10:56:16 +00:00
..
build ci: add tests for cli-migrations image (#4396) 2020-04-15 07:26:00 +05:30
cmd/hasura cli: update go.mod 2021-06-16 11:45:07 +00:00
commands cli: fix changelog hyperlink in the log message 2021-11-11 10:56:16 +00:00
integration_test cli: split remote schema permissions metadata into seperate files 2021-10-14 06:52:57 +00:00
internal cli: support request_transforms in actions metadata 2021-11-03 06:38:48 +00:00
migrate cli: fix cli-console failing to add migrations if there are tabs in SQL body 2021-11-10 12:36:35 +00:00
pkg cli: split remote schema permissions metadata into seperate files 2021-10-14 06:52:57 +00:00
plugins cli: fix lint errors 2021-10-13 14:39:15 +00:00
seed cli: fix lint errors 2021-10-13 14:39:15 +00:00
telemetry cli: send error to telemetry 2021-09-08 08:56:54 +00:00
update cli: fix lint errors 2021-10-13 14:39:15 +00:00
util cli: defer validating plugins index and actions codegen repo 2021-11-10 09:22:06 +00:00
version cli: throw user friendly errors when server is unreachable 2021-09-27 14:53:44 +00:00
.gitignore cli: show only differences in metadata on metadata diff 2021-06-17 10:16:17 +00:00
.realize.yaml cli: update go-binddata, fix realize (close #3588) (#3687) 2020-01-13 15:24:41 +05:30
cli.go cli: defer validating plugins index and actions codegen repo 2021-11-10 09:22:06 +00:00
CONTRIBUTING.md cli: fix inconsistent metadata object list rendering 2021-07-16 05:26:47 +00:00
directory.go cli: use absolute path of project directory 2021-07-16 12:59:04 +00:00
get.sh cli: install v2.0.9 by default instead of v2.0.6 2021-09-20 05:56:17 +00:00
global_config.go cli: fix lint errors 2021-10-13 14:39:15 +00:00
go.mod cli: init --endpoint intializes the project with metadata and migrations from HGE 2021-10-07 14:24:52 +00:00
go.sum cli: init --endpoint intializes the project with metadata and migrations from HGE 2021-10-07 14:24:52 +00:00
logger_hook.go cli: add migrate and metadata packages 2021-06-18 06:25:14 +00:00
Makefile cli: fix lint errors 2021-10-13 14:39:15 +00:00
README.md tag release v2.1.0-beta.2 2021-11-08 09:26:08 +00:00

Hasura GraphQL Engine CLI

GoDoc

Installation

Download GraphQL Engine CLI bundled with Hasura CLI

  • Linux/macOS

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash
    

    This will install the Hasura CLI in /usr/local/bin. You might have to provide your sudo password depending on the permissions of your /usr/local/bin location.

    If youd prefer to install to a different location other than /usr/local/bin, set the INSTALL_PATH variable accordingly:

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | INSTALL_PATH=$HOME/bin bash
    

    You can also install a specific version of the CLI by providing the VERSION variable:

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | VERSION=v2.1.0-beta.2 bash
    
  • Windows

    Download the binary cli-hasura-windows-amd64.exe available under Assets of the latest release from the GitHub release page: https://github.com/hasura/graphql-engine/releases

Download using go get

go get github.com/hasura/graphql-engine/cli/cmd/hasura

Build from source

git clone https://github.com/hasura/graphql-engine
cd graphql-engine/cli
make deps
make build
# binaries will be in _output directory

Usage

hasura init --directory <my-project> --endpoint <graphql-endpoint> --admin-secret <admin-secret>
cd <my-project>
hasura console

Contributing

Checkout the contributing guide.