# BAQ CLI · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/baqhub/baq/blob/main/packages/lib-cli/LICENSE) [![npm version](https://img.shields.io/npm/v/@baqhub/cli.svg?color=)](https://www.npmjs.com/package/@baqhub/cli)

This is the official command line interface for the [BAQ](https://baq.dev) federated app platform. It helps manage record types in your application, whether you choose to create them yourself or use existing ones.

## Installation

The BAQ CLI is distributed as an NPM package. It can be installed globally:

```bash
npm install -g @baqhub/cli
baq help
```

Or locally within a project:

```bash
npm install -D @baqhub/cli
npx baq help
```

## Documentation

- **[Getting started guide](https://baq.dev/docs/learn/guides/using-the-cli)** : Overview of the CLI.
- **[Full reference](https://baq.dev/docs/reference/cli/commands)** : All the commands.

## License

The BAQ CLI is [MIT licensed](https://github.com/baqhub/baq/blob/main/packages/lib-cli/LICENSE).