@flowapt/flowiq-cli 0.2.4 → 0.2.5

package/README.md

@@ -416,6 +416,13 @@ Media headers: pass `media_header.file_url` (a public URL) — the edge function
 uploads it to Meta server-side. Approval is async; re-`pull` for the
 authoritative Meta status.
 
+`template_data` is FlowIQ's own send-time mapping (slot labels, default header
+image) stored alongside the template. Omit it and a default is synthesized
+server-side (`auto_synthesized: true`; the response says
+`template_data_synthesized: true`) so the row always exists for `status` and
+broadcast mapping suggestions — pass your own only when you want real slot
+labels (e.g. `"body_params": {"1": "first_name", "2": "order_number"}`).
+
 ### Org — `flowiq org create` / `flowiq org info <organization_id>`
 
 Create a brand-new organization, or look one up (read-only; raw store/Meta
@@ -545,6 +552,19 @@ flowiq test cleanup <organization_id> --confirm      # delete the stress contact
 `--agent <id>` targets a specific (non-active) agent. `test stress cleanup` is
 destructive and requires `--confirm`.
 
+### Guide — `flowiq guide`
+
+Read the bundled docs in the terminal — no digging through node_modules.
+
+```bash
+flowiq guide               # the team guide (TEAM-GUIDE.md), paged; q to quit
+flowiq guide --reference   # this full command reference (README.md)
+flowiq guide --no-pager    # plain print (also automatic when piped)
+```
+
+Both files ship inside the npm package, so what you read always matches the
+version you have installed.
+
 ## Environment variable overrides
 
 | Var | Default | Use |

package/TEAM-GUIDE.md

@@ -34,6 +34,10 @@ Confirm with:
 flowiq auth whoami
 ```
 
+This guide travels with the CLI — read it any time with `flowiq guide`
+(`--reference` for the full command reference). It always matches the version
+you have installed.
+
 > **Approving someone else's login:** when a teammate runs `auth login`, they
 > read you their code (or you open the link they send). On `/cli-auth`, check
 > the code AND the device name match what they told you, then Approve.
@@ -84,6 +88,7 @@ flowiq auth whoami
 | Close a client's change request (after verifying the fix!) | `flowiq au resolve <update_id> --note "what changed"` — the client reads the note |
 | Check an org's platform + active agent | `flowiq org info <org_id>` |
 | Work a Pin Board task | `flowiq pin list-remote open` → `pull` → edit → `push` |
+| Re-read this guide / the full command reference | `flowiq guide` / `flowiq guide --reference` |
 
 The flow is the same everywhere: **pull → edit the JSON → push**. Slugs are the
 filename the pull printed (e.g. `phytoceutics`), or pass a file path.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowapt/flowiq-cli",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "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.",
   "type": "module",
   "bin": {

package/src/commands/guide.js

@@ -0,0 +1,32 @@
+// flowiq guide — read the bundled team guide (TEAM-GUIDE.md) or the full
+// command reference (README.md) right in the terminal. Both files ship inside
+// the npm tarball, so what this prints always matches the installed CLI
+// version — no drift between the tool and its docs.
+import { readFileSync, existsSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import { spawnSync } from "node:child_process";
+
+const PKG_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..", "..");
+
+export function show(opts = {}) {
+  const file = opts.reference ? "README.md" : "TEAM-GUIDE.md";
+  const fullPath = path.join(PKG_ROOT, file);
+
+  if (!existsSync(fullPath)) {
+    console.error(`Could not find ${file} in the installed package (${PKG_ROOT}).`);
+    console.error("Reinstall the CLI:  npm i -g @flowapt/flowiq-cli");
+    process.exit(1);
+  }
+
+  // Interactive terminal → page it (quit with q); piped/redirected or
+  // --no-pager → plain print.
+  if (process.stdout.isTTY && opts.pager !== false) {
+    const pager = process.env.PAGER || "less";
+    const args = pager === "less" ? ["-R", fullPath] : [fullPath];
+    const res = spawnSync(pager, args, { stdio: "inherit" });
+    if (!res.error) return;
+    // pager missing → fall through to plain print
+  }
+  process.stdout.write(readFileSync(fullPath, "utf8"));
+}

package/src/index.js

@@ -27,6 +27,7 @@ import * as customToolsCmd from "./commands/custom-tools.js";
 import * as broadcastCmd from "./commands/broadcast.js";
 import * as segmentsCmd from "./commands/segments.js";
 import * as keywordsCmd from "./commands/keywords.js";
+import * as guideCmd from "./commands/guide.js";
 
 // Read version from package.json so it stays in sync with the published npm
 // version automatically (single source of truth — bumping package.json on each
@@ -448,5 +449,12 @@ export function run(argv) {
     .description("List local keyword snapshots")
     .action(() => keywordsCmd.list());
 
+  // guide (bundled docs — always match the installed version)
+  program.command("guide")
+    .description("Read the team guide (how we use this CLI); --reference for the full command reference")
+    .option("--reference", "show the full command reference (README) instead of the team guide")
+    .option("--no-pager", "print straight to stdout instead of paging")
+    .action((opts) => guideCmd.show(opts));
+
   program.parseAsync(argv);
 }