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
|
|
|
|
```bash
|
|
|
|
curl -L https://cli.hasura.io/install.sh | bash
|
|
|
|
```
|
|
|
|
- Windows: [installer](https://cli.hasura.io/install/windows-amd64)
|
|
|
|
|
|
|
|
|
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
|
|
|
|
make build
|
|
|
|
# binaries will be in _output directory
|
|
|
|
```
|
|
|
|
|
2018-06-28 08:40:18 +03:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
```bash
|
|
|
|
hasura init --directory <my-project> --endpoint <graphql-endpoint> --access-key <access-key>
|
|
|
|
cd <my-project>
|
|
|
|
hasura console
|
|
|
|
```
|
|
|
|
|
|
|
|
## Docs
|
|
|
|
|
|
|
|
Read complete docs [here](docs/hasura.md).
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
2018-06-28 09:05:34 +03:00
|
|
|
Checkout the [contributing guide](CONTRIBUTING.md).
|