New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@subql/cli

Package Overview
Dependencies
Maintainers
2
Versions
397
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@subql/cli

cli for subquery

  • 5.5.1
  • latest
  • npm
  • Socket score
Version published
Maintainers
2
Created
Source

@subql/cli

CLI for SubQuery

oclif Version Downloads/week License

Usage

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

Commands

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 or manifest file to run build
  -o, --output=<value>    output folder of build e.g. dist
  -s, --silent            silent mode
  --mode=<option>         [default: production]
                          <options: production|prod|development|dev>

DESCRIPTION
  Build this SubQuery project code

See code: lib/commands/build/index.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 --endpoint <value> [--options deploy|promote|delete] [--org <value>] [--projectName
    <value>] [--type stage|primary] [--indexerVersion <value>] [--queryVersion <value>] [--dict <value>]
    [--indexerUnsafe] [--indexerBatchSize <value>] [--indexerSubscription] [--disableHistorical] [--indexerUnfinalized]
    [--indexerStoreCacheThreshold <value>] [--disableIndexerStoreCacheAsync] [--indexerWorkers <value>] [--queryUnsafe]
    [--querySubscription] [--queryTimeout <value>] [--queryMaxConnection <value>] [--queryAggregate] [--queryLimit
    <value>] [-d] [--ipfsCID <value>] [--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
  --disableIndexerStoreCacheAsync       If enabled the store cache will flush data asynchronously relative to indexing
                                        data.
  --endpoint=<value>                    (required) Enter endpoint
  --indexerBatchSize=<value>            Enter batchSize from 1 to 30
  --indexerStoreCacheThreshold=<value>  The number of items kept in the cache before flushing
  --indexerSubscription                 Enable Indexer subscription
  --indexerUnfinalized                  Index unfinalized blocks (requires Historical to be enabled)
  --indexerUnsafe                       Enable indexer unsafe
  --indexerVersion=<value>              Enter indexer-version
  --indexerWorkers=<value>              Enter worker threads from 1 to 5
  --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
  --queryLimit=<value>                  Set the max number of results the query service returns
  --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 --endpoint <value> [--org <value>] [--projectName <value>] [--type stage|primary]
    [--indexerVersion <value>] [--queryVersion <value>] [--dict <value>] [--indexerUnsafe] [--indexerBatchSize <value>]
    [--indexerSubscription] [--disableHistorical] [--indexerUnfinalized] [--indexerStoreCacheThreshold <value>]
    [--disableIndexerStoreCacheAsync] [--indexerWorkers <value>] [--queryUnsafe] [--querySubscription] [--queryTimeout
    <value>] [--queryMaxConnection <value>] [--queryAggregate] [--queryLimit <value>] [-d] [--ipfsCID <value>]

FLAGS
  -d, --useDefaults                     Use default values for indexerVersion, queryVersion, dictionary, endpoint
  --dict=<value>                        Enter dictionary
  --disableHistorical                   Disable Historical Data
  --disableIndexerStoreCacheAsync       If enabled the store cache will flush data asynchronously relative to indexing
                                        data.
  --endpoint=<value>                    (required) Enter endpoint
  --indexerBatchSize=<value>            Enter batchSize from 1 to 30
  --indexerStoreCacheThreshold=<value>  The number of items kept in the cache before flushing
  --indexerSubscription                 Enable Indexer subscription
  --indexerUnfinalized                  Index unfinalized blocks (requires Historical to be enabled)
  --indexerUnsafe                       Enable indexer unsafe
  --indexerVersion=<value>              Enter indexer-version
  --indexerWorkers=<value>              Enter worker threads from 1 to 5
  --ipfsCID=<value>                     Enter IPFS CID
  --org=<value>                         Enter organization name
  --projectName=<value>                 Enter project name
  --queryAggregate                      Enable Aggregate
  --queryLimit=<value>                  Set the max number of results the query service returns
  --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 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

Schema subgraph project to subquery project

USAGE
  $ subql migrate [-d <value>] [-f <value>] [-o <value>]

FLAGS
  -d, --gitSubDirectory=<value>  specify git subdirectory path
  -f, --file=<value>             specify subgraph git/directory path
  -o, --output=<value>           Output subquery project path

DESCRIPTION
  Schema subgraph project to subquery project

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 multi-chain:deploy

Multi-chain deployment to hosted service

USAGE
  $ subql multi-chain:deploy -f <value> [--org <value>] [--projectName <value>] [--type stage|primary] [--indexerVersion
    <value>] [--queryVersion <value>] [--dict <value>] [--endpoint <value>] [--indexerUnsafe] [--indexerBatchSize
    <value>] [--indexerSubscription] [--disableHistorical] [--indexerUnfinalized] [--indexerStoreCacheThreshold <value>]
    [--disableIndexerStoreCacheAsync] [--indexerWorkers <value>] [--queryUnsafe] [--querySubscription] [--queryTimeout
    <value>] [--queryMaxConnection <value>] [--queryAggregate] [--queryLimit <value>] [-d] [--ipfs <value>]

FLAGS
  -d, --useDefaults                     Use default values for indexerVersion, queryVersion, dictionary, endpoint
  -f, --location=<value>                (required) from project folder or specify manifest file
  --dict=<value>                        Enter dictionary
  --disableHistorical                   Disable Historical Data
  --disableIndexerStoreCacheAsync       If enabled the store cache will flush data asynchronously relative to indexing
                                        data.
  --endpoint=<value>                    Enter endpoint
  --indexerBatchSize=<value>            Enter batchSize from 1 to 30
  --indexerStoreCacheThreshold=<value>  The number of items kept in the cache before flushing
  --indexerSubscription                 Enable Indexer subscription
  --indexerUnfinalized                  Index unfinalized blocks (requires Historical to be enabled)
  --indexerUnsafe                       Enable indexer unsafe
  --indexerVersion=<value>              Enter indexer-version
  --indexerWorkers=<value>              Enter worker threads from 1 to 5
  --ipfs=<value>                        IPFS gateway endpoint
  --org=<value>                         Enter organization name
  --projectName=<value>                 Enter project name
  --queryAggregate                      Enable Aggregate
  --queryLimit=<value>                  Set the max number of results the query service returns
  --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
  Multi-chain deployment to hosted service

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

subql project

Create/Delete project

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

FLAGS
  --dedicatedDB=<value>  Enter dedicated DataBase
  --description=<value>  Enter description
  --logoURL=<value>      Enter logo URL
  --options=<option>     <options: create|delete>
  --org=<value>          Enter organization name
  --projectName=<value>  Enter project name
  --projectType=<value>  [default: subquery] Enter project type [subquery|subgraph]
  --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>] [--logoURL <value>] [--subtitle <value>]
    [--description <value>] [--dedicatedDB <value>] [--projectType <value>]

FLAGS
  --dedicatedDB=<value>  Enter dedicated DataBase
  --description=<value>  Enter description
  --logoURL=<value>      Enter logo URL
  --org=<value>          Enter organization name
  --projectName=<value>  Enter project name
  --projectType=<value>  [default: subquery] Enter project type [subquery|subgraph]
  --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 folder or specify manifest file
  -o, --output            Output IPFS CID
  --ipfs=<value>          IPFS gateway endpoint

DESCRIPTION
  Upload this SubQuery project to IPFS

See code: lib/commands/publish.js

Keywords

FAQs

Package last updated on 04 Feb 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Security News

Oracle Drags Its Feet in the JavaScript Trademark Dispute

Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.

By Sarah Gooding  -  Feb 07, 2025
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc