cli

@subql/cli

cli for polkagraph

• @subql/cli
• Usage
• Commands

Usage

$ npm install -g @subql/cli
$ subql COMMAND
running command...
$ subql (-v|--version|version)
@subql/cli/0.16.3-0 linux-x64 node-v16.13.1
$ subql --help [COMMAND]
USAGE
  $ subql COMMAND
...

Commands

• subql build
• subql codegen
• subql help [COMMAND]
• subql init [PROJECTNAME]
• subql migrate
• subql publish
• subql validate

subql build

Build this SubQuery project code

USAGE
  $ subql build

OPTIONS
  -l, --location=location                   local folder
  --mode=(production|prod|development|dev)  [default: production]

See code: lib/commands/build.js

subql codegen

Generate schemas for graph node

USAGE
  $ subql codegen

OPTIONS
  -f, --force
  -l, --location=location  local folder to run codegen in
  --file=file

See code: lib/commands/codegen.js

subql help [COMMAND]

display help for subql

USAGE
  $ subql help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

subql init [PROJECTNAME]

Initialize a scaffold subquery project

USAGE
  $ subql init [PROJECTNAME]

ARGUMENTS
  PROJECTNAME  Give the starter project name

OPTIONS
  -f, --force
  -l, --location=location    local folder to create the project in
  --install-dependencies     Install dependencies as well
  --npm                      Force using NPM instead of yarn, only works with `install-dependencies` flag
  --specVersion=0.0.1|0.2.0  [default: 0.2.0] The spec version to be used by the project
  --starter

See code: lib/commands/init.js

subql migrate

Migrate Subquery project manifest v0.0.1 to v0.2.0

USAGE
  $ subql migrate

OPTIONS
  -f, --force
  -l, --location=location  local folder to run migrate in
  --file=file

See code: lib/commands/migrate.js

subql publish

Upload this SubQuery project to IPFS

USAGE
  $ subql publish

OPTIONS
  -l, --location=location  local folder
  --ipfs=ipfs              [default: http://localhost:5001/api/v0] IPFS gateway endpoint

See code: lib/commands/publish.js

subql validate

Check a folder or github repo is a validate subquery project

USAGE
  $ subql validate

OPTIONS
  -l, --location=location  local folder, github repo url or IPFS cid

  --ipfs=ipfs              [default: https://ipfs.thechainhub.com/api/v0] IPFS gateway endpoint, used for validating
                           projects on IPFS

  --silent

See code: lib/commands/validate.js