Non Productive Monday

    @subql/cli
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.0 • Public • Published

    @subql/cli

    cli for polkagraph

    oclif Version Downloads/week License

    Usage

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

    Commands

    subql build

    Build this SubQuery project code

    USAGE
      $ subql build
    
    OPTIONS
      -f, --location=location                   local folder
      -o, --output=output                       output folder of build e.g. dist
      -s, --slient                              silent mode
      --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 deployment

    Deploy to hosted service

    USAGE
      $ subql deployment
    
    OPTIONS
      -d, --useDefaults                Use default values for indexerVersion, queryVersion, dictionary, endpoint
      --deploymentID=deploymentID      Enter deployment ID
      --dict=dict                      Enter dictionary
      --endpoint=endpoint              Enter endpoint
      --indexerVersion=indexerVersion  Enter indexer-version
      --ipfsCID=ipfsCID                Enter IPFS CID
      --options=deploy|promote|delete
      --org=org                        Enter organization name
      --projectName=projectName        Enter project name
      --project_name=project_name      Enter project name
      --queryVersion=queryVersion      Enter query-version
      --type=(stage|primary)           [default: primary]
    

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

    subql deployment:delete

    Delete Deployment

    USAGE
      $ subql deployment:delete
    
    OPTIONS
      --deploymentID=deploymentID  Enter deployment ID
      --org=org                    Enter organization name
      --project_name=project_name  Enter project name
    

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

    subql deployment:deploy

    Deployment to hosted service

    USAGE
      $ subql deployment:deploy
    
    OPTIONS
      -d, --useDefaults                Use default values for indexerVersion, queryVersion, dictionary, endpoint
      --dict=dict                      Enter dictionary
      --endpoint=endpoint              Enter endpoint
      --indexerVersion=indexerVersion  Enter indexer-version
      --ipfsCID=ipfsCID                Enter IPFS CID
      --org=org                        Enter organization name
      --projectName=projectName        Enter project name
      --queryVersion=queryVersion      Enter query-version
      --type=(stage|primary)           [default: primary]
    

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

    subql deployment:promote

    Promote Deployment

    USAGE
      $ subql deployment:promote
    
    OPTIONS
      --deploymentID=deploymentID  Enter deployment ID
      --org=org                    Enter organization name
      --project_name=project_name  Enter project name
    

    See code: lib/commands/deployment/promote.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.2.0|1.0.0  [default: 1.0.0] The spec version to be used by the project
    

    See code: lib/commands/init.js

    subql migrate

    Migrate Subquery project manifest to v1.0.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 project

    Create/Delete project

    USAGE
      $ subql project
    
    OPTIONS
      --apiVersion=apiVersion    [default: 2] Enter api version
      --description=description  Enter description
      --gitRepo=gitRepo          Enter git repository
      --logoURL=logoURL          Enter logo URL
      --options=create|delete
      --org=org                  Enter organization name
      --projectName=projectName  Enter project name
      --subtitle=subtitle        Enter subtitle
    

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

    subql project:create-project

    Create Project on Hosted Service

    USAGE
      $ subql project:create-project
    
    OPTIONS
      --apiVersion=apiVersion    [default: 2] Enter api version
      --description=description  Enter description
      --gitRepo=gitRepo          Enter git repository
      --logoURL=logoURL          Enter logo URL
      --org=org                  Enter organization name
      --projectName=projectName  Enter project name
      --subtitle=subtitle        Enter subtitle
    

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

    subql project:delete-project

    Delete Project on Hosted Service

    USAGE
      $ subql project:delete-project
    
    OPTIONS
      --org=org                  Enter organization name
      --projectName=projectName  Enter project name
    

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

    subql publish

    Upload this SubQuery project to IPFS

    USAGE
      $ subql publish
    
    OPTIONS
      -f, --location=location  from project or manifest path
      -o, --output             Output IPFS CID
      --ipfs=ipfs              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.subquery.network/ipfs/api/v0]
                                                                    IPFS gateway endpoint, used for validating projects on
                                                                    IPFS
    
      --network-family=(Substrate|Avalanche|Terra|Cosmos|Algorand)
    
      --silent
    

    See code: lib/commands/validate.js

    Keywords

    Install

    npm i @subql/cli

    DownloadsWeekly Downloads

    912

    Version

    1.5.0

    License

    Apache-2.0

    Unpacked Size

    715 kB

    Total Files

    129

    Last publish

    Collaborators

    • onfinality-admin
    • jay_ji