Skip to content

openclix/openclix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Event Flyer - dark Event Flyer - light

OpenClix
Open-source, local-first foundation for config-driven mobile engagement logic.

Introduction

OpenClix helps teams run onboarding, habit, re-engagement, and feature-discovery messaging with local-first execution.

It is designed to be:

  • Open source and auditable
  • Source-first (vendored client code, not runtime SDK lock-in)
  • Agent-friendly (explicit interfaces and clear edit points)

Installation

OpenClix is delivered as skills + source templates.

For Humans

Option A: Let an agent do it

Paste this prompt into your coding agent:

Install OpenClix skills from https://github.com/openclix/openclix and integrate OpenClix into this project.
Use openclix-init to detect platform, copy templates into the dedicated OpenClix namespace,
wire initialization/event/lifecycle touchpoints, and run build verification.
If this project already has local notifications outside OpenClix, detect whether they are migration-capable,
ask whether to migrate supported flows into OpenClix or keep them as-is, and default to keeping them unchanged.
Then use openclix-design-campaigns to create .openclix/campaigns/app-profile.json
and generate .openclix/campaigns/openclix-config.json.
Do not add dependencies without approval.

Option B: Manual setup

Follow the full guide: Install and integrate OpenClix

Option C: Claude Code plugin marketplace

Follow the guide here: Add Claude Code Plugin

Advanced setup

If you wnat to integrate with your PA tools

Use openclix-analytics to detect installed Firebase/PostHog/Mixpanel/Amplitude,
forward OpenClix events with openclix tags, and produce a pre/post impact report
for D7 retention and engagement metrics.

To update campaigns

Use openclix-update-campaigns to propose pause/resume/add/delete/update
actions from campaign metrics and produce openclix-config.next.json before
applying any change to the active config.

To sync OpenClix source code

Use openclix-update to re-sync existing OpenClix source integration files
with the latest openclix-init template baseline.
This keeps custom campaign logic updates (openclix-update-campaigns) and
template maintenance (openclix-update) clearly separated.
For Agents
  1. Install skills:
npx skills add openclix/openclix
  1. Run openclix-init to integrate templates and touchpoints. If the app already has local notifications, openclix-init will detect them, classify whether supported flows can migrate into OpenClix, and default to keeping the existing implementation unless migration is explicitly requested.
  2. Run openclix-design-campaigns to generate .openclix/campaigns/openclix-config.json.
  3. Run openclix-analytics to detect provider wiring and generate impact artifacts.
  4. Run openclix-update-campaigns to produce conservative recommendation drafts.
  5. Run openclix-update when the plugin template baseline changes and source files need re-synchronization.

Documentation

Topic Link
Installation Install and integrate OpenClix
Workflow Run the OpenClix workflow
Verification Verify your integration
Retention automation Agent retention automation guide
Config delivery Config delivery guide
Campaign design Campaign design guide
Analytics impact Analytics impact guide
Runtime model Runtime model reference
Use cases Use cases reference
FAQ FAQ
Project status Project status

What OpenClix Is Not

  • Not a hosted full engagement platform
  • Not a required runtime package dependency
  • Not dependent on a Clix-hosted control plane for local-first flows

Contributing

Use issues and pull requests to propose improvements to the project and documentation.

License

MIT License. See LICENSE.