cli

@subql/cli

CLI for SubQuery

• @subql/cli
• Usage
• Commands

Usage

$ npm install -g @subql/cli
$ subql COMMAND
running command...
$ subql (--version)
@subql/cli/3.6.2-6 linux-x64 node-v18.17.1
$ subql --help [COMMAND]
USAGE
  $ subql COMMAND
...

Commands

• subql build
• subql codegen
• subql codegen:generate
• subql deployment
• subql deployment:delete
• subql deployment:deploy
• subql deployment:promote
• subql help [COMMAND]
• subql init [PROJECTNAME]
• subql migrate
• subql multi-chain:add
• subql project
• subql project:create-project
• subql project:delete-project
• subql publish
• subql validate

subql build

Build this SubQuery project code

USAGE
  $ subql build [-f <value>] [-o <value>] [--mode production|prod|development|dev] [-s]

FLAGS
  -f, --location=<value>  local folder
  -o, --output=<value>    output folder of build e.g. dist
  -s, --slient            silent mode
  --mode=<option>         [default: production]
                          <options: production|prod|development|dev>

DESCRIPTION
  Build this SubQuery project code

See code: lib/commands/build.js

subql codegen

Generate schemas for graph node

USAGE
  $ subql codegen [-l <value>] [-f <value>]

FLAGS
  -f, --file=<value>      specify manifest file path (will overwrite -l if both used)
  -l, --location=<value>  [deprecated] local folder to run codegen in. please use file flag instead

DESCRIPTION
  Generate schemas for graph node

See code: lib/commands/codegen/index.js

subql codegen:generate

Generate Project.yaml and mapping functions based on provided ABI

USAGE
  $ subql codegen:generate --abiPath <value> --startBlock <value> [-f <value>] [--events <value>] [--functions
    <value>] [--address <value>]

FLAGS
  -f, --file=<value>    specify manifest file path
  --abiPath=<value>     (required) path to abi from root
  --address=<value>     contract address
  --events=<value>      abi events, --events="approval, transfer"
  --functions=<value>   abi functions,  --functions="approval, transfer"
  --startBlock=<value>  (required) startBlock

DESCRIPTION
  Generate Project.yaml and mapping functions based on provided ABI

See code: lib/commands/codegen/generate.js

subql deployment

Deploy to hosted service

USAGE
  $ subql deployment [--options deploy|promote|delete] [--org <value>] [--projectName <value>] [--ipfsCID
    <value>] [--type stage|primary] [--indexerVersion <value>] [--queryVersion <value>] [--dict <value>] [--endpoint
    <value>] [--indexerUnsafe] [--indexerBatchSize <value>] [--indexerSubscription] [--disableHistorical]
    [--indexerWorkers <value>] [--queryUnsafe] [--querySubscription] [--queryTimeout <value>] [--queryMaxConnection
    <value>] [--queryAggregate] [-d] [--project_name <value>] [--deploymentID <value>]

FLAGS
  -d, --useDefaults             Use default values for indexerVersion, queryVersion, dictionary, endpoint
  --deploymentID=<value>        Enter deployment ID
  --dict=<value>                Enter dictionary
  --disableHistorical           Disable Historical Data
  --endpoint=<value>            Enter endpoint
  --indexerBatchSize=<value>    Enter batchSize from 1 to 30
  --indexerSubscription         Enable Indexer subscription
  --indexerUnsafe               Enable indexer unsafe
  --indexerVersion=<value>      Enter indexer-version
  --indexerWorkers=<value>      Enter worker threads from 1 to 30
  --ipfsCID=<value>             Enter IPFS CID
  --options=<option>            <options: deploy|promote|delete>
  --org=<value>                 Enter organization name
  --projectName=<value>         Enter project name
  --project_name=<value>        Enter project name
  --queryAggregate              Enable Aggregate
  --queryMaxConnection=<value>  Enter MaxConnection from 1 to 10
  --querySubscription           Enable Query subscription
  --queryTimeout=<value>        Enter timeout from 1000ms to 60000ms
  --queryUnsafe                 Enable indexer unsafe
  --queryVersion=<value>        Enter query-version
  --type=<option>               [default: primary]
                                <options: stage|primary>

DESCRIPTION
  Deploy to hosted service

See code: lib/commands/deployment/index.js

subql deployment:delete

Delete Deployment

USAGE
  $ subql deployment:delete [--org <value>] [--project_name <value>] [--deploymentID <value>]

FLAGS
  --deploymentID=<value>  Enter deployment ID
  --org=<value>           Enter organization name
  --project_name=<value>  Enter project name

DESCRIPTION
  Delete Deployment

See code: lib/commands/deployment/delete.js

subql deployment:deploy

Deployment to hosted service

USAGE
  $ subql deployment:deploy [--org <value>] [--projectName <value>] [--ipfsCID <value>] [--type stage|primary]
    [--indexerVersion <value>] [--queryVersion <value>] [--dict <value>] [--endpoint <value>] [--indexerUnsafe]
    [--indexerBatchSize <value>] [--indexerSubscription] [--disableHistorical] [--indexerWorkers <value>]
    [--queryUnsafe] [--querySubscription] [--queryTimeout <value>] [--queryMaxConnection <value>] [--queryAggregate]
    [-d]

FLAGS
  -d, --useDefaults             Use default values for indexerVersion, queryVersion, dictionary, endpoint
  --dict=<value>                Enter dictionary
  --disableHistorical           Disable Historical Data
  --endpoint=<value>            Enter endpoint
  --indexerBatchSize=<value>    Enter batchSize from 1 to 30
  --indexerSubscription         Enable Indexer subscription
  --indexerUnsafe               Enable indexer unsafe
  --indexerVersion=<value>      Enter indexer-version
  --indexerWorkers=<value>      Enter worker threads from 1 to 30
  --ipfsCID=<value>             Enter IPFS CID
  --org=<value>                 Enter organization name
  --projectName=<value>         Enter project name
  --queryAggregate              Enable Aggregate
  --queryMaxConnection=<value>  Enter MaxConnection from 1 to 10
  --querySubscription           Enable Query subscription
  --queryTimeout=<value>        Enter timeout from 1000ms to 60000ms
  --queryUnsafe                 Enable indexer unsafe
  --queryVersion=<value>        Enter query-version
  --type=<option>               [default: primary]
                                <options: stage|primary>

DESCRIPTION
  Deployment to hosted service

See code: lib/commands/deployment/deploy.js

subql deployment:promote

Promote Deployment

USAGE
  $ subql deployment:promote [--org <value>] [--project_name <value>] [--deploymentID <value>]

FLAGS
  --deploymentID=<value>  Enter deployment ID
  --org=<value>           Enter organization name
  --project_name=<value>  Enter project name

DESCRIPTION
  Promote Deployment

See code: lib/commands/deployment/promote.js

subql help [COMMAND]

display help for subql

USAGE
  $ subql help [COMMAND] [--all]

ARGUMENTS
  COMMAND  command to show help for

FLAGS
  --all  see all commands in CLI

DESCRIPTION
  display help for subql

See code: @oclif/plugin-help

subql init [PROJECTNAME]

Initialize a scaffold subquery project

USAGE
  $ subql init [PROJECTNAME] [-f] [-l <value>] [--install-dependencies] [--npm] [--abiPath <value>]

ARGUMENTS
  PROJECTNAME  Give the starter project name

FLAGS
  -f, --force
  -l, --location=<value>  local folder to create the project in
  --abiPath=<value>       path to abi file
  --install-dependencies  Install dependencies as well
  --npm                   Force using NPM instead of yarn, only works with `install-dependencies` flag

DESCRIPTION
  Initialize a scaffold subquery project

See code: lib/commands/init.js

subql migrate

Migrate Subquery project manifest to v1.0.0

USAGE
  $ subql migrate [-f] [--file <value>] [-l <value>]

FLAGS
  -f, --force
  -l, --location=<value>  local folder to run migrate in
  --file=<value>

DESCRIPTION
  Migrate Subquery project manifest to v1.0.0

See code: lib/commands/migrate.js

subql multi-chain:add

Add new chain manifest to multi-chain configuration

USAGE
  $ subql multi-chain:add [-f <value>] [-c <value>]

FLAGS
  -c, --chainManifestPath=<value>  path to the new chain manifest
  -f, --multichain=<value>         [default: /home/runner/work/subql/subql/packages/cli] specify multichain manifest
                                   file path

DESCRIPTION
  Add new chain manifest to multi-chain configuration

See code: lib/commands/multi-chain/add.js

subql project

Create/Delete project

USAGE
  $ subql project [--options create|delete] [--org <value>] [--projectName <value>] [--gitRepo <value>]
    [--logoURL <value>] [--subtitle <value>] [--description <value>] [--apiVersion <value>] [--dedicatedDB <value>]

FLAGS
  --apiVersion=<value>   [default: 2] Enter api version
  --dedicatedDB=<value>  Enter dedicated DataBase
  --description=<value>  Enter description
  --gitRepo=<value>      Enter git repository
  --logoURL=<value>      Enter logo URL
  --options=<option>     <options: create|delete>
  --org=<value>          Enter organization name
  --projectName=<value>  Enter project name
  --subtitle=<value>     Enter subtitle

DESCRIPTION
  Create/Delete project

See code: lib/commands/project/index.js

subql project:create-project

Create Project on Hosted Service

USAGE
  $ subql project:create-project [--org <value>] [--projectName <value>] [--gitRepo <value>] [--logoURL <value>] [--subtitle
    <value>] [--description <value>] [--apiVersion <value>] [--dedicatedDB <value>]

FLAGS
  --apiVersion=<value>   [default: 2] Enter api version
  --dedicatedDB=<value>  Enter dedicated DataBase
  --description=<value>  Enter description
  --gitRepo=<value>      Enter git repository
  --logoURL=<value>      Enter logo URL
  --org=<value>          Enter organization name
  --projectName=<value>  Enter project name
  --subtitle=<value>     Enter subtitle

DESCRIPTION
  Create Project on Hosted Service

See code: lib/commands/project/create-project.js

subql project:delete-project

Delete Project on Hosted Service

USAGE
  $ subql project:delete-project [--org <value>] [--projectName <value>]

FLAGS
  --org=<value>          Enter organization name
  --projectName=<value>  Enter project name

DESCRIPTION
  Delete Project on Hosted Service

See code: lib/commands/project/delete-project.js

subql publish

Upload this SubQuery project to IPFS

USAGE
  $ subql publish [-f <value>] [--ipfs <value>] [-o]

FLAGS
  -f, --location=<value>  from project or manifest path
  -o, --output            Output IPFS CID
  --ipfs=<value>          IPFS gateway endpoint

DESCRIPTION
  Upload this SubQuery project to IPFS

See code: lib/commands/publish.js

subql validate

Check a folder or github repo is a validate subquery project

USAGE
  $ subql validate [-l <value>] [--ipfs <value>] [--silent] [--network-family
    Substrate|Cosmos|Algorand|Ethereum|Flare|Near|Stellar]

FLAGS
  -l, --location=<value>     local folder, github repo url or IPFS cid
  --ipfs=<value>             [default: https://unauthipfs.subquery.network/ipfs/api/v0] IPFS gateway endpoint, used for
                             validating projects on IPFS
  --network-family=<option>  <options: Substrate|Cosmos|Algorand|Ethereum|Flare|Near|Stellar>
  --silent

DESCRIPTION
  Check a folder or github repo is a validate subquery project

See code: lib/commands/validate.js