Installation & Basic Usage

Installing the CLI with NPM

To install the RapidQL CLI with npm, use the following command:

npm install -g rapidql

Running a CLI query

To run a basic query, type 'rql' followed by the message:

rql queryFile.rql

// or

rql "{ a }"

To run the query in queryFile.rql. RapidQL will also look for 2 optional hidden files:

  • .rqlconfig - json file containing your configurations (DB / RpaidAPI connection details).
  • .rqlcontext - base context for RQL (define variables used in the query).