[Function Metadata] Finalize the function-spec CLI command (#28819)

Cleans up the instructions for the command, includes the instance url (so we can pipe this into a convex-helpers CLI command), and unhides this command so it will show up in the next `npm` release.

GitOrigin-RevId: 6d40f6f109ad22a4d1446cbb7bba1cde51f49752

Author: jordanhunt22

npm-packages/convex/src/cli/functionSpec.ts

@@ -14,7 +14,7 @@ export const functionSpec = new Command("function-spec")
     "List argument and return values to your Convex functions.\n\n" +
       "By default, this inspects your dev deployment.",
   )
-  .addOption(new Option("--path", "Output as JSON to this file path."))
+  .addOption(new Option("--file", "Output as JSON to a file."))
   .addDeploymentSelectionOptions(
     actionDescription("Read function metadata from"),
   )
@@ -37,9 +37,13 @@ export const functionSpec = new Command("function-spec")
       {},
     )) as any[];
 
-    const output = JSON.stringify(functions, null, 2);
+    const output = JSON.stringify(
+      { url: deploymentUrl, functions: functions },
+      null,
+      2,
+    );
 
-    if (options.path) {
+    if (options.file) {
       const fileName = `function_spec_${Date.now().valueOf()}.json`;
       ctx.fs.writeUtf8File(fileName, output);
       logOutput(ctx, chalk.green(`Wrote function spec to ${fileName}`));

npm-packages/convex/src/cli/index.ts

@@ -121,7 +121,7 @@ async function main() {
     .addCommand(update)
     .addCommand(logout)
     .addCommand(networkTest, { hidden: true })
-    .addCommand(functionSpec, { hidden: true })
+    .addCommand(functionSpec)
     .addHelpCommand("help <command>", "Show help for given <command>")
     .version(version)
     // Hide version and help so they don't clutter