<p align="left">
  <a href="https://www.walkeros.io">
    <img alt="walkerOS" title="walkerOS" src="https://www.walkeros.io/img/walkerOS_logo.svg" width="256px"/>
  </a>
</p>

# @walkeros/cli

Command-line tool for building, testing, and running walkerOS event collection
flows, from configuration to deployment.

[Documentation](https://www.walkeros.io/docs/apps/cli) &bull;
[NPM Package](https://www.npmjs.com/package/@walkeros/cli) &bull;
[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/cli)

## Installation

```bash
npm install -g @walkeros/cli
```

## Quick start

```bash
# Bundle a flow configuration
walkeros bundle flow.json

# Test with simulated events (no real API calls)
walkeros push flow.json --event '{"name":"product view"}' --simulate destination.demo

# Run a collection server locally
walkeros run dist/flow.mjs --port 3000
```

## Documentation

Full configuration, mapping, and examples live in the docs:
**https://www.walkeros.io/docs/apps/cli**

## Contribute

Feel free to contribute by submitting an
[issue](https://github.com/elbwalker/walkerOS/issues), starting a
[discussion](https://github.com/elbwalker/walkerOS/discussions), or getting in
[contact](https://calendly.com/elb-alexander/30min).

## License

MIT
