# Flo.w CLI

The Flo.w CLI (`flow-engine-cli`) is a command line interface for working with Flo.w Engine via its REST API. It provides developers
with tools to work with datasets, pipelines and other Flo.w resources.

## Setup and build

After cloning the repository, follow the instructions below to set up your development environment:

```bash
# Install dependencies
npm install

# Build project
npm run build
```

## Running and debugging

The built CLI tool will be located in the `dist/` folder. To run the CLI, use the following command:

```bash
node dist/index.js <commands> [options]
```

Note that this is equivalent to using `flow <commands> [options]` when the package is installed globally on an end-developers machine.

To debug the CLI during development, open a JavaScript debug terminal in VSCode (CMD-SHIFT-P and search for 'debug: ja')and run the CLI as above in the terminal. The debugger will attach to the running process and breakpoints can be set directly in the source code.

## Deployment

See the [README.md](../../README.md) file in the root of this monorepo for details on how to deploy packages.

## Support

Please contact robin.summerhill@emu-analytics.com for support with installing, building or deploying packages in this monorepo.
