@caphub/cli 0.1.5 → 0.1.6

package/bin/caphub.js

@@ -256,21 +256,99 @@ function printCapabilities(payload) {
 }
 
 function printCapabilityHelp(payload) {
+  const title = payload.capability === "search"
+    ? "caphub web search"
+    : payload.capability === "search-ideas"
+      ? "caphub search ideas"
+      : `caphub ${payload.capability}`;
+  const requestExample = payload.capability === "search"
+    ? `caphub search '{"queries":["site:github.com awesome ai agents","awesome lists agents","codex awesome lists"]}'`
+    : `caphub ${payload.capability} '${JSON.stringify(payload.input_contract)}'`;
+  const configuredRequestExample = payload.capability === "search"
+    ? `caphub search '{"queries":[{"q":"EV discounts Thailand","country":"th","language":"en","from_time":"week"}]}'`
+    : null;
+  const responseShape = payload.capability === "search"
+    ? {
+        queries: [
+          {
+            q: "string",
+            country: "optional string",
+            language: "optional string",
+            from_time: "optional string",
+            num: "number",
+          },
+        ],
+        results: [
+          {
+            query: "string",
+            items: [
+              {
+                title: "string",
+                link: "string",
+                snippet: "string",
+                date: "optional string",
+              },
+            ],
+          },
+        ],
+        total_usage: {
+          total_credits_used: "number",
+          credits_remaining: "number",
+        },
+        billing: {
+          credits_used: "number",
+        },
+      }
+    : payload.output_contract;
+  const parameters = payload.parameters || {};
+  const searchParameterOrder = [
+    "queries",
+    "queries[] as string",
+    "queries[] as object",
+    "queries[].q",
+    "queries[].country",
+    "queries[].language",
+    "queries[].from_time",
+    "queries[].num",
+    "max_queries",
+    "include_meta",
+    "include_result_meta",
+  ];
+  const orderedParameterEntries = payload.capability === "search"
+    ? [
+        ...searchParameterOrder
+          .filter((name) => Object.prototype.hasOwnProperty.call(parameters, name))
+          .map((name) => [name, parameters[name]]),
+        ...Object.entries(parameters).filter(([name]) => !searchParameterOrder.includes(name)),
+      ]
+    : Object.entries(parameters);
+  const parameterLines = orderedParameterEntries.map(([name, description]) => `- ${name}: ${description}`);
   const lines = [
-    payload.capability,
+    title,
+    "-".repeat(title.length),
+    "",
+    `description: ${payload.purpose}`,
     "",
-    `purpose: ${payload.purpose}`,
     `endpoint: ${payload.endpoint}`,
     `method: ${payload.method}`,
     payload.credits ? `credits: ${payload.credits}` : null,
     payload.limits?.max_queries_per_request ? `limits: max ${payload.limits.max_queries_per_request} queries per request` : null,
-    `auth: ${payload.auth?.env || "CAPHUB_API_KEY"} or ${CONFIG_PATH}`,
     "",
-    "input:",
-    JSON.stringify(payload.input_contract, null, 2),
+    "request:",
+    "format:",
+    `caphub ${payload.capability} '<request>'`,
+    "",
+    "default request form:",
+    requestExample,
+    configuredRequestExample ? "" : null,
+    configuredRequestExample ? "configured request form:" : null,
+    configuredRequestExample,
+    parameterLines.length ? "" : null,
+    parameterLines.length ? "configuration:" : null,
+    ...parameterLines,
     "",
-    "output:",
-    JSON.stringify(payload.output_contract, null, 2),
+    "response:",
+    JSON.stringify(responseShape, null, 2),
     payload.notes_for_agents?.length ? "" : null,
     payload.notes_for_agents?.length ? "notes:" : null,
     ...(payload.notes_for_agents || []).map((note) => `- ${note}`),
@@ -280,7 +358,7 @@ function printCapabilityHelp(payload) {
     "- auth invalid: generate a new key in https://caphub.io/dashboard/",
     "- low credits: top up in https://caphub.io/dashboard/",
     `- bad payload: caphub help ${payload.capability}`,
-  ].filter(Boolean);
+  ].filter((line) => line !== null && line !== undefined);
   process.stdout.write(`${lines.join("\n")}\n`);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@caphub/cli",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Root CLI for Caphub agent capabilities",
   "type": "module",
   "bin": {