Skip to content

rindexer CLI

rindexer is a CLI first tool allowing you to do everything you need to do with rindexer.

Usage: rindexer <COMMAND>
 
Commands:
  new           Creates a new rindexer no-code project or rust project
  start         Start various services like indexers, GraphQL APIs or both together
  add           Add elements such as contracts to the rindexer.yaml file
  codegen       Generates rust code based on rindexer.yaml or graphql queries
  delete        Delete data from the postgres database or csv files
  phantom       Use phantom events to add your own events to contracts
  help          Print this message or the help of the given subcommand(s)
 
Options:
  -h, --help     Print help
  -V, --version  Print version

new

Creates a new rindexer no-code project or rust project. This will walk you through setting up your project by asking you a series of questions in the terminal.

Usage: rindexer new [OPTIONS] <COMMAND>
 
Commands:
  no-code  Creates a new no-code project
  rust     Creates a new rust project
  help     Print this message or the help of the given subcommand(s)
 
Options:
  -p, --path <PATH>
          optional - The path to create the project in, default will be where the command is run
 
  -h, --help
          Print help (see a summary with '-h')

start

Start various services like indexers, GraphQL APIs or both together. This will start the services based on the rindexer.yaml file.

`rindexer start indexer` or `rindexer start graphql` or `rindexer start all`
 
Usage: rindexer start [OPTIONS] <COMMAND>
 
Commands:
  indexer  Starts the indexing service based on the rindexer.yaml file
  graphql  Starts the GraphQL server based on the rindexer.yaml file
  all      Starts the indexers and the GraphQL together based on the rindexer.yaml file
  help     Print this message or the help of the given subcommand(s)
 
Options:
  -p, --path <PATH>
          optional - The path to run the command in, default will be where the command is run
 
  -h, --help
          Print help (see a summary with '-h')
`rindexer start indexer` or `rindexer start graphql` or `rindexer start all`

add

These commands allow you to through the CLI add elements to your YAML file.

Usage: rindexer_cli add [OPTIONS] <COMMAND>
 
Commands:
  contract  Add a contract from a network to the rindexer.yaml file. It will download the ABI and add it to the abis folder and map it in the yaml file.
  help      Print this message or the help of the given subcommand(s)
 
Options:
  -p, --path <PATH>
          optional - The path to run the command in, default will be where the command is run
 
  -h, --help
          Print help (see a summary with '-h')

codegen

Generates rust code based on rindexer.yaml or graphql queries. This will generate the code based on the command you run.

Example: `rindexer codegen typings` or `rindexer codegen handlers` or `rindexer codegen graphql --endpoint=graphql_api` or `rindexer codegen rust-all`
 
Usage: rindexer codegen [OPTIONS] <COMMAND>
 
Commands:
  typings  Generates the rindexer rust typings based on the rindexer.yaml file
  indexer  Generates the rindexer rust indexers handlers based on the rindexer.yaml file
  graphql  Generates the GraphQL queries from a GraphQL schema
  all      Generates both typings and indexers handlers based on the rindexer.yaml file
  help     Print this message or the help of the given subcommand(s)
 
Options:
  -p, --path <PATH>
          optional - The path to run the command in, default will be where the command is run
 
  -h, --help
          Print help (see a summary with '-h')

delete

This can be used to delete data from the postgres database or csv files. It will ask you questions in the terminal to determine what you want to delete.

Usage: rindexer delete

phantom

Example: `rindexer phantom init` or `rindexer phantom clone --contract-name <CONTRACT_NAME> --network <NETWORK>` or `rindexer phantom compile --contract-name <CONTRACT_NAME> --network <NETWORK>` or `rindexer phantom deploy --contract-name <CONTRACT_NAME> --network <NETWORK>`
 
Usage: rindexer phantom [OPTIONS] <COMMAND>
 
Commands:
  init     Sets up phantom events on rindexer
  clone    Clone the contract with the network you wish to add phantom events to
  compile  Compiles the phantom contract
  deploy   Deploy the modified phantom contract
  help     Print this message or the help of the given subcommand(s)
 
Options:
  -p, --path <PATH>
          optional - The path to create the project in, default will be where the command is run
 
  -h, --help
          Print help (see a summary with '-h')