hydra
v3
v3
  • Hydra
  • Hydra CLI
  • Hydra Indexer
  • Hydra Indexer Gateway
  • Hydra Processor
  • Hydra Typegen
  • Overview
    • Query Node Manifest
    • Graphql Queries
    • Pagination
    • Sorting
    • Mappings
      • Context interfaces
      • Mapping Filters
      • Mapping Types
    • Schema
      • The Goodies
      • Entities
      • Enums
      • Interfaces
      • Algebraic types
      • Full-text queries
      • Entity Relationships
      • Cross filtering
      • Variant relations
    • Architecture
  • Install Hydra
  • Migration to Hydra v2
  • What's new in Hydra v3
  • FAQ
  • Quickstart
Powered by GitBook
On this page
  • Prerequisites
  • Installation

Was this helpful?

Install Hydra

PreviousArchitectureNextMigration to Hydra v2

Last updated 4 years ago

Was this helpful?

Prerequisites

  • Unix-based operating system (Mac or Linux), you may experience issues on Windows.

  • Node 14.x (to be compatible with the latest )

  • Both Hydra-CLI and the generated project files have dependencies that require Node v10.16 or higher

  • npm and (optional, but recommended)

  • Hydra stores the substrate data in an external PostgresSQL 12 instance. The scaffolding tool provides a convenient shortcut for running the database instance from a Docker image. In this case the standard docker environment (docker and docker-compose) should be available.

  • (Optional) . The scaffolding tool provides targets for building Docker images for external deployment.

Installation

Use @dzlzv/hydra-cli@next for the most recent development version

Global installation:

npm install -g @dzlzv/hydra-cli

The path to hydra-cli binaries will be added to the system-wide $PATH.

Local installation:

npm install @dzlzv/hydra-cli

The binaries will be installed to the local .bin folder. You can execute hydra-cli commands by adding the.binfolder within your local node_modules to $PATH.

Isolated set-up:

Execute hydra-cli commands directly by typing

npx @dzlzv/hydra-cli <command>

This provides an isolated way to execute hydra-cli commands.

Run hydra-cli --version to check your installation

It may be convenient to create an alias for quick access to hydra-cli e.g.

alias hydra-cli='npx @dzlzv/hydra-cli'

Or on Windows you can use:

doskey hydra-cli=npx @dzlzv/hydra-cli
polkadot-api
npx
Docker engine