@adaptiveworx/flow v0.1.0

Flow

Flow is the control center for the AdaptiveWorX Value Accelerator Framework. This tool focuses on breaking out planning objects created during agentic conversations and prioritizing them on a backlog in a Jira project, then updating them as work progresses.

Purpose

This tool serves as the initial prototype for what will eventually become the "flow control center" for the AdaptiveWorX Value Accelerator Framework. The primary objectives are:

• Create parent/child (epics/stories/sub-tasks) work items based on agentic plans
• Automatically update Jira tickets based on commits/PRs
• Sync work status between Cline/Git and Jira

Getting Started

Prerequisites

• Node.js (v14 or later)
• A Jira account with API token
• GitHub repository
• Cline (Claude Anthropic) integration

Installation

1. Clone the repository:

git clone https://github.com/your-username/flow.git
cd flow

2. Install dependencies:

npm install

3. Configure your environment:

cp config/config.template.json config/config.json

Edit config.json with your Jira and GitHub credentials.

4. Build the project:

npm run build

Usage

The basic workflow is as follows:

1. Parse Cline conversations to extract actionable items
2. Create Jira issues based on the extracted items
3. Link GitHub activities to Jira issues
4. Keep everything in sync as work progresses

Example command:

flow parse-conversation --file=/path/to/conversation.json

Configuration

See CONFIG.md for detailed configuration instructions.

Architecture

For information about the system architecture, see ARCHITECTURE.md.

Development

Building

npm run build

Testing

npm test

Linting

npm run lint

License

Flow uses a specialized licensing structure:

Core Components

The core project is licensed under the Business Source License (BSL) 1.1, which:

• Allows use, modification, and redistribution
• Restricts using the software to create competing commercial Flow Control Services
• Converts automatically to Apache License 2.0 after four years

Future SDK/API Components

Eventually, select components like SDKs and APIs will be available under a dual MIT/Apache 2.0 license.

Contributing

Please read our Contributing Guidelines before submitting changes. All contributors are required to sign an Apache Individual Contributor License Agreement (CLA).

For questions about licensing, please contact licensing@adaptiveworx.com.