ibm-segment

A command-line interface (CLI) tool designed for seamless integration with Segment, enabling the tracking of events directly from your terminal. This tool simplifies the process of sending event data to Segment by allowing users to load events from a JSON file or input them manually.

Features:

• API Key Configuration: Configure your Segment Write Key directly through the CLI.
• Event File Loading: Load and track events in bulk from a JSON file.Update the events variable in index.js with your events.
• Manual Event Tracking: Track additional events manually through interactive prompts.
• User-Friendly Prompts: Easy-to-use prompts powered by Inquirer.js for manual event entry.

Installation

npm install -g ibm-segment

Usage

Configuration Options

The CLI supports the following options:

• --apikey: Your Segment Write Key (optional if provided during runtime).
• --file: Path to the JSON file containing events (optional if provided during runtime).

If you've installed the CLI globally, you can run it from anywhere: ibm-segment --apikey YOUR_SEGMENT_WRITE_KEY --file PATH_TO_YOUR_EVENTS_FILE.json

From here you can select which events to fire from the JSON file. If no events are selected, all will be added.

After processing the events from the file, you will be asked if you want to track more events manually:

> Would you like to track another event? (Y/n)

Manual Event Tracking

To manually track an event, provide the event name, properties (as a JSON string), and user ID when prompted.