2018-06-28 08:40:18 +03:00
# Hasura GraphQL Engine CLI
2018-07-20 22:07:40 +03:00
[![GoDoc ](https://godoc.org/github.com/hasura/graphql-engine/cli?status.svg )](https://godoc.org/github.com/hasura/graphql-engine/cli)
2018-07-20 22:05:51 +03:00
2018-06-28 08:40:18 +03:00
## Installation
2018-07-17 16:02:33 +03:00
### Download GraphQL Engine CLI bundled with Hasura CLI
2018-06-28 08:40:18 +03:00
- Linux/macOS
2021-07-29 12:21:02 +03:00
```bash
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 you’ d prefer to install to a different location other than `/usr/local/bin` , set the `INSTALL_PATH` variable accordingly:
```bash
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:
```bash
2023-12-12 13:29:39 +03:00
curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | VERSION=v2.36.0 bash
2021-07-29 12:21:02 +03:00
```
2020-02-13 10:24:36 +03:00
- Windows
2018-06-28 08:40:18 +03:00
2021-07-29 12:21:02 +03:00
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
2018-06-28 08:40:18 +03:00
2018-07-17 16:02:33 +03:00
### Download using go get
2018-06-28 08:40:18 +03:00
```bash
go get github.com/hasura/graphql-engine/cli/cmd/hasura
```
2018-07-17 16:02:33 +03:00
### Build from source
```bash
git clone https://github.com/hasura/graphql-engine
cd graphql-engine/cli
make deps
2022-01-10 09:20:06 +03:00
make build-cli-ext copy-cli-ext
2018-07-17 16:02:33 +03:00
make build
# binaries will be in _output directory
```
2018-06-28 08:40:18 +03:00
## Usage
```bash
2019-02-14 12:37:47 +03:00
hasura init --directory < my-project > --endpoint < graphql-endpoint > --admin-secret < admin-secret >
2018-06-28 08:40:18 +03:00
cd < my-project >
hasura console
```
## Contributing
2018-06-28 09:05:34 +03:00
Checkout the [contributing guide ](CONTRIBUTING.md ).