mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-16 18:42:30 +03:00
f83a8e591f
Rename the admin secret key header used to access GraphQL engine from X-Hasura-Access-Key to X-Hasura-Admin-Secret. Server CLI and console all support the older flag but marks it as deprecated.
43 lines
868 B
Markdown
43 lines
868 B
Markdown
# Hasura GraphQL Engine CLI
|
|
|
|
[![GoDoc](https://godoc.org/github.com/hasura/graphql-engine/cli?status.svg)](https://godoc.org/github.com/hasura/graphql-engine/cli)
|
|
|
|
## Installation
|
|
|
|
### Download GraphQL Engine CLI bundled with Hasura CLI
|
|
|
|
- Linux/macOS
|
|
```bash
|
|
curl -L https://cli.hasura.io/install.sh | bash
|
|
```
|
|
- Windows: [installer](https://cli.hasura.io/install/windows-amd64)
|
|
|
|
|
|
### Download using go get
|
|
|
|
```bash
|
|
go get github.com/hasura/graphql-engine/cli/cmd/hasura
|
|
```
|
|
|
|
### 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
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
hasura init --directory <my-project> --endpoint <graphql-endpoint> --admin-secret <admin-secret>
|
|
cd <my-project>
|
|
hasura console
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Checkout the [contributing guide](CONTRIBUTING.md).
|