Skip to main content

Bundled mode

In Bundled mode, you configure walkerOS with JSON files and build standalone bundles using the CLI. The output is a separate file that can be deployed independently of your application.

Quickstart

1. Install the CLI

Loading...

2. Create a flow configuration

Create flow.json:

Loading...

3. Build the bundle

Loading...

This writes the bundle to stdout. Use -o to write to a file:

  • Web: -o ./dist/walker.js (IIFE format, loadable via script tag)
  • Server: -o ./dist/bundle.mjs (ESM format, runnable with Node.js)

4. Deploy

Add to your HTML:

<script src="/walker.js"></script>

Adding destinations

Add destinations to your flow.json:

Loading...

Rebuild: walkeros bundle flow.json


Add consent requirements in the destination config:

Loading...

Set consent at runtime:

// After loading walker.js
elb('walker consent', { functional: true, analytics: true });

Key concepts

The package: property

In Bundled mode, you reference packages by name:

"sources": {
"browser": {
"package": "@walkeros/web-source-browser"
}
}

The CLI downloads and bundles the package. This differs from Integrated mode where you use code: with a direct import.

Variables and environment

Use variables for environment-specific values:

Loading...

Environment variables ($env.NAME:default) are resolved at build time. Config variables ($var.name) reference values from the variables section.

Multiple flows

Define different flows for different environments:

Loading...

Build specific flow: walkeros bundle flow.json --flow production


CLI commands

CommandPurpose
walkeros bundleBuild production bundle
walkeros push --simulateTest with mocked events
walkeros pushTest with real API calls
walkeros runStart HTTP collection server

See CLI documentation for full details.


Docker deployment

For production server deployments:

Loading...

See Docker documentation for complete deployment guides.


Next steps


See also

💡 Not sure which mode fits your stack?
We are happy to talk through your architecture and recommend the right approach. Start with a free scoping call.