Mark things as beta

README.md

@@ -816,9 +816,6 @@ Shows help for the Fauna CLI.
 ```sh
 faunadb shell
 
-VERSION
-  fauna-shell/1.1.0 darwin-x64 node-v20.6.0
-
 USAGE
   $ fauna [COMMAND]
 
@@ -1058,6 +1055,9 @@ ARGUMENTS
 DESCRIPTION
   Initialize a project directory by generating a .fauna-project file.
 
+  NOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject
+  to change.
+
 EXAMPLES
   $ fauna project init
 
@@ -1250,6 +1250,9 @@ FLAGS
 DESCRIPTION
   Add a new stack to `.fauna-project`.
 
+  NOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject
+  to change.
+
 EXAMPLES
   $ fauna stack add
 
@@ -1271,6 +1274,9 @@ USAGE
 DESCRIPTION
   List stacks available in `.fauna-project`.
 
+  NOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject
+  to change.
+
 EXAMPLES
   $ fauna stack list
 ```
@@ -1291,6 +1297,9 @@ ARGUMENTS
 DESCRIPTION
   Update the default stack in `.fauna-project`.
 
+  NOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject
+  to change.
+
 EXAMPLES
   $ fauna stack select my-stack
 ```

package.json

@@ -95,10 +95,10 @@
         "description": "Manage endpoints in ~/.fauna-shell."
       },
       "project": {
-        "description": "Manage project settings in .fauna-project."
+        "description": "Manage project settings in .fauna-project.\nNOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject to change."
       },
       "stack": {
-        "description": "Manage stacks in the current project."
+        "description": "Manage stacks in the current project.\nNOTE: `fauna project` and `fauna stack` are still in beta. Behavior is subject to change."
       }
     }
   },

readme.py

@@ -42,7 +42,14 @@ def run(command: list[str]) -> str:
 
     if end != None:
       print(f"updated command {command}")
-      result = run(["./bin/run", *command[1:], "--help"]).strip().split("\n")
+      result = run(["./bin/run", *command[1:], "--help"]).strip()
+
+      # remove the VERSION section
+      if command == ["fauna", "help"]:
+        m = re.search("VERSION.*\n.*\n\n", result)
+        result = result[:m.start()] + result[m.end():]
+
+      result = result.split("\n")
       lines[start:end] = result
       i += len(result) - (end - start)
 

src/commands/project/init.ts

@@ -22,8 +22,9 @@ export class ProjectInitCommand extends Command {
     }),
   };
 
-  static description =
-    "Initialize a project directory by generating a .fauna-project file.";
+  static description = `Initialize a project directory by generating a .fauna-project file.
+
+NOTE: \`fauna project\` and \`fauna stack\` are still in beta. Behavior is subject to change.`;
 
   static examples = [
     "$ fauna project init",

src/commands/stack/add.ts

@@ -22,7 +22,9 @@ export default class AddStackCommand extends Command {
     }),
   };
 
-  static description = "Add a new stack to `.fauna-project`.";
+  static description = `Add a new stack to \`.fauna-project\`.
+
+NOTE: \`fauna project\` and \`fauna stack\` are still in beta. Behavior is subject to change.`;
 
   static examples = [
     "$ fauna stack add",

src/commands/stack/list.ts

@@ -5,7 +5,9 @@ import chalk from "chalk";
 export default class ListStackCommand extends Command {
   static flags = {};
 
-  static description = "List stacks available in `.fauna-project`.";
+  static description = `List stacks available in \`.fauna-project\`.
+
+NOTE: \`fauna project\` and \`fauna stack\` are still in beta. Behavior is subject to change.`;
 
   static examples = ["$ fauna stack list"];
 

src/commands/stack/select.ts

@@ -9,7 +9,9 @@ export default class SelectStackCommand extends Command {
     }),
   };
 
-  static description = "Update the default stack in `.fauna-project`.";
+  static description = `Update the default stack in \`.fauna-project\`.
+
+NOTE: \`fauna project\` and \`fauna stack\` are still in beta. Behavior is subject to change.`;
 
   static examples = ["$ fauna stack select my-stack"];