@electric-sql/cli/README.md

ElectricSQL command line interface (CLI).

<a href="https://electric-sql.com">
  <picture>
    <source media="(prefers-color-scheme: dark)"
        srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-light-trans.svg"
    />
    <source media="(prefers-color-scheme: light)"
        srcset="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
    />
    <img alt="ElectricSQL logo"
        src="https://raw.githubusercontent.com/electric-sql/meta/main/identity/ElectricSQL-logo-black.svg"
    />
  </picture>
</a>

![License](https://img.shields.io/github/license/electric-sql/electric) [![Tests](https://github.com/electric-sql/electric/actions/workflows/cli_tests.yml/badge.svg?event=push)](https://github.com/electric-sql/electric/actions/workflows/cli_tests.yml)

# ElectricSQL CLI

[ElectricSQL](https://electric-sql.com) is a local-first sync layer for modern apps. Use it to build reactive, realtime, local-first apps using standard open source Postgres and SQLite.

The ElectricSQL CLI provides a set of commands to setup the Electric sync service and generate an Electric TypeScript client.

See the:

- [Documentation](https://electric-sql.com/docs/api/cli)

## Install

Using yarn:

```sh
yarn add @electric-sql/cli --dev
```

Or using npm:

```sh
npm install --save-dev @electric-sql/cli
```

## Issues

Please raise any bugs, issues and feature requests on [GitHub Issues](https://github.com/electric-sql/electric/issues).

## Contributing

See the [Community Guidelines](https://github.com/electric-sql/meta) including the [Guide to Contributing](https://github.com/electric-sql/meta/blob/main/CONTRIBUTING.md) and [Contributor License Agreement](https://github.com/electric-sql/meta/blob/main/CLA.md).

## Support

We have an [open community Discord](https://discord.electric-sql.com). If you’re interested in the project, please come and say hello and let us know if you have any questions or need any help or support getting things running.