# AgentQL CLI

## Getting Started

### Prerequisites

- Node.js (v20.12.0 or later)
- npm (v10.1.0 or later)

### Install Necessary Modules

At the root of the agentql-cli directory, run the following command to install the necessary modules:

```bash
npm install
```

### Run the CLI

`--` allows you to pass arguments to the underlying Node.js process.

```bash
npm run start --agentql <command>
```

## Running Tests

To run unit tests, use the following command:

```bash
npm run test
```

## Formatting

To run `prettier` on files, use the following command:

```bash
npm run format
```

## Build

At the root of the agentql-cli directory, run the following command to build the CLI:

```bash
npm run build
```

## Register CLI Globally

After building the CLI, run the following command to register the CLI globally:

```bash
npm link
```

You can now use `agentql` to run the CLI globally!