> For the complete documentation index, see [llms.txt](https://dzhelezov.gitbook.io/hydra/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dzhelezov.gitbook.io/hydra/master/packages/hydra-cli.md).

# Hydra CLI

A cli tool for running a [Hydra](https://joystream.org/hydra) query node

## Install

Using `npx`:

```bash
$ alias hydra-cli='npx @subsquid/hydra-cli'
```

or install via npm:

```bash
npm install -g @subsquid/hydra-cli
```

and then

```bash
$ hydra-cli [COMMAND]
```

## Quickstart

Run

```
$ hydra-cli scaffold
```

and answer the prompts. This will generate a sample project and README with setup instructions.

## Commands

* [`hydra-cli codegen`](/hydra/master/packages/hydra-cli.md#hydra-cli-codegen)
* [`hydra-cli db:create`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbcreate)
* [`hydra-cli db:create-migration [NAME]`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbcreate-migration-name)
* [`hydra-cli db:drop`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbdrop)
* [`hydra-cli db:migrate`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbmigrate)
* [`hydra-cli db:new-migration [NAME]`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbnew-migration-name)
* [`hydra-cli db:revert`](/hydra/master/packages/hydra-cli.md#hydra-cli-dbrevert)
* [`hydra-cli help [COMMAND]`](/hydra/master/packages/hydra-cli.md#hydra-cli-help-command)
* [`hydra-cli scaffold`](/hydra/master/packages/hydra-cli.md#hydra-cli-scaffold)

## `hydra-cli codegen`

Analyze graphql schema and generate model/server files

```
Analyze graphql schema and generate model/server files

USAGE
  $ hydra-cli codegen

OPTIONS
  -s, --schema=schema  [default: ./schema.graphql] Schema path, can be file or directory
```

## `hydra-cli db:create`

Create target database

```
Create target database

USAGE
  $ hydra-cli db:create
```

## `hydra-cli db:create-migration [NAME]`

Analyze database state and generate migration to match the current schema

```
Analyze database state and generate migration to match the current schema

USAGE
  $ hydra-cli db:create-migration [NAME]
```

## `hydra-cli db:drop`

Drop target database

```
Drop target database

USAGE
  $ hydra-cli db:drop
```

## `hydra-cli db:migrate`

Apply database migrations

```
Apply database migrations

USAGE
  $ hydra-cli db:migrate
```

## `hydra-cli db:new-migration [NAME]`

Create a file for a new migration

```
Create a file for a new migration

USAGE
  $ hydra-cli db:new-migration [NAME]
```

## `hydra-cli db:revert`

Revert the last performed migration

```
Revert the last performed migration

USAGE
  $ hydra-cli db:revert
```

## `hydra-cli help [COMMAND]`

display help for hydra-cli

```
display help for <%= config.bin %>

USAGE
  $ hydra-cli help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

## `hydra-cli scaffold`

Starter kit: generates a directory layout and a sample schema file

```
Starter kit: generates a directory layout and a sample schema file

USAGE
  $ hydra-cli scaffold

OPTIONS
  -a, --appPort=appPort          [default: 4000] GraphQL server port
  -b, --blockHeight=blockHeight  [default: 0] Start block height
  -d, --dir=dir                  [default: CWD] Project folder
  -h, --dbHost=dbHost            [default: localhost] Database host
  -i, --indexerUrl=indexerUrl    Hydra Indexer endpoint
  -n, --name=name                [default: hydra-scaffold] Project name
  -p, --dbPort=dbPort            [default: 5432] Database port
  -u, --dbUser=dbUser            [default: postgres] Database user
  -x, --dbPassword=dbPassword    [default: postgres] Database user password
  --rewrite                      Clear the folder before scaffolding
  --silent                       If present, the scaffolder is non-interactive and uses only provided CLI flags
```