zinkee 0.1.31 → 0.1.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zinkee",
-  "version": "0.1.31",
+  "version": "0.1.32",
   "description": "CLI for Zinkee API v2",
   "type": "module",
   "bin": {

package/src/commands/schemas.ts

@@ -64,6 +64,16 @@ interface SetUniqueFieldsCommandOptions {
   clear?: boolean;
 }
 
+const HIGHLIGHTED_FIELD_HELP = `
+Highlighted field:
+  The schema's "main" field. The frontend uses its value as each record's
+  display name, in two places:
+    - Activity panel: the record's title in the activity side panel
+      (the panel with the record's logs and comments).
+    - Detail view: the record's name in the left-hand record list you
+      browse to open each record's form.
+`;
+
 interface FieldCreateCommandOptions {
   type?: string;
   slug?: string;
@@ -583,7 +593,7 @@ export function registerSchemasCommands(
     .option("--commentable <bool>", "commentable flag", parseBooleanFlag)
     .option(
       "--highlighted-field <field>",
-      "highlighted (main) field uuid or slug",
+      "its value is used as each record's display name in the UI (field uuid or slug)",
       parseUuidOrSlugSelector,
     )
     .action(async function action(
@@ -621,7 +631,8 @@ export function registerSchemasCommands(
       }
 
       writeLine(stdout, `Updated schema "${data.slug ?? schema.value}".`);
-    });
+    })
+    .addHelpText("after", HIGHLIGHTED_FIELD_HELP);
 
   schemas
     .command("set-unique-fields")

package/src/utils/examples.ts

@@ -264,7 +264,8 @@ const specificExamples: Record<string, readonly CommandExample[]> = {
 }`,
     },
     {
-      description: "Set the highlighted (main) field of a schema.",
+      description:
+        "Set the schema's highlighted (main) field — the field whose value names each record in the UI (activity-panel title and detail-view record list).",
       command:
         'zinkee --json schemas update contacts --highlighted-field contact-name',
       raw: `{