AgentQL CLI

The AgentQL CLI (Command Line Interface) is a command-line tool designed to assist you in using the AgentQL SDK for both Python and JavaScript. It can help you set up your development environment.

Installation

Prerequisites

Node.js 18 or higher

Install AgentQL CLI

From your terminal, run the following command to install the AgentQL CLI:

terminal
npm install -g agentql-cli

Available Commands

agentql

Show a list of available commands along with their description.

agentql init

Set up the AgentQL development environment by installing the required dependencies for AgentQL. When using Python, make sure you have activated your virtual environment for the necessary dependencies to be installed in the correct directory.

It also provides an option to download an example script into the current directory.

agentql new-script

Creates a template script in the current directory. Users can choose between asynchronous and synchronous scripts to download.

Options

OptionDescription
-h, --helpShow all available options.
-t, --typeSpecify whether to download synchronous or asynchronous templates. Available options are sync or async