Add note for SURREAL_CAPS_ALLOW_EXPERIMENTAL

surrealdb · Jan 21, 2025 · 6876e4f · 6876e4f
1 parent 2dea9dd
commit 6876e4f
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/content/doc-surrealdb/cli/start.mdx b/src/content/doc-surrealdb/cli/start.mdx
@@ -417,6 +417,11 @@ Multiple experimental capabilities can be enabled by separating them with a comm
 ```bash
 SURREAL_CAPS_ALLOW_EXPERIMENTAL="record_references, graphql" surreal start
 surreal start --allow-experimental record_references,graphql
+```
+
+> [!NOTE]
+> The experimental capability is completely hidden in the CLI help command, and `--allow-all` will not enable the experimental capabilities by default.
+
 ## Further examples
 
 As `surreal start` is the command with by far the largest number of options, a few more examples will help give an idea of what sort of configurations are available.