@flowapt/flowiq-cli 0.2.7 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/TEAM-GUIDE.md +37 -0
  2. package/package.json +1 -1
package/TEAM-GUIDE.md CHANGED
@@ -122,6 +122,43 @@ Custom tools define real HTTP calls the agent can execute, so the server
122
122
  validates hard (names, URLs, methods, parameter shapes) and warns about typo'd
123
123
  keys or `{{placeholders}}` it doesn't recognise. Take the warnings seriously.
124
124
 
125
+ ### Example: tag a segment of contacts (Advanced Tagging)
126
+
127
+ `flowiq tag` is the Contacts → **Advanced Tagging** dialog in your terminal.
128
+ It applies **one named tag** to a matched set. It is **always dry-run first** —
129
+ you see the count and a sample, and *nothing writes* until you add `--commit`.
130
+
131
+ ```bash
132
+ # 1. See who matches (nothing is written)
133
+ flowiq tag segment <org_id> --min-orders 2 --min-spent 1000 --region ZA-GP
134
+ # → "Custom segment: 4502 contact(s) match." + a 10-row sample
135
+
136
+ # 2. Happy with the count? Apply the tag:
137
+ flowiq tag segment <org_id> --min-orders 2 --min-spent 1000 --region ZA-GP \
138
+ --tag gp-repeat-spenders --commit
139
+ # → "matched 4502 · newly tagged 4502 · already had ... 0"
140
+
141
+ # 3. Verify, then (if needed) undo:
142
+ flowiq tag list <org_id> --prefix gp-repeat # tag → count
143
+ flowiq tag remove <org_id> gp-repeat-spenders --confirm # removes it from everyone
144
+ ```
145
+
146
+ The five match modes (swap `segment` for any of these):
147
+
148
+ | Mode | Tags contacts who… |
149
+ |---|---|
150
+ | `field --field order_history --any "Whey,Protein"` | have a keyword in a field (order history, summary, shopify tags, name, email…) |
151
+ | `cohort --type top_spenders --limit 500` | rank in the **top N** by spend / orders / recency (top-N, not a threshold) |
152
+ | `segment --min-orders 2 --min-spent 1000 --region ZA-GP` | match order-count / spend / last-order-date / region filters |
153
+ | `attributes --filter allow_broadcast_true` | match a broadcast-permission state |
154
+ | `messages --min-count 3 --sender user-whatsapp` | have ≥ N messages of a channel type |
155
+
156
+ Two things to know: for **"who bought product X"** use
157
+ `flowiq seg plan --bought "X" --window 90d` instead of `tag field` — it reads the
158
+ real order line-items (accurate + windowable) rather than the order-history text.
159
+ And a commit over 2000 contacts asks you to type the tag name to confirm
160
+ (add `--yes` to skip). Everything is appends-only and reversible with `tag remove`.
161
+
125
162
  ## Keys, rotation, logging out
126
163
 
127
164
  - **`flowiq auth refresh`** — rotates this device's key in place (a fresh key
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowapt/flowiq-cli",
3
- "version": "0.2.7",
3
+ "version": "0.2.8",
4
4
  "description": "Command-line tool for FlowIQ staff: round-trip agent prompts, questionnaires, fine-tuning, pin-board tasks, webhooks, templates, agent-updates, chat exports, and live agent testing without ever touching service-role credentials.",
5
5
  "type": "module",
6
6
  "bin": {