Chore: Update CLI docs (#770)

Co-authored-by: hasura-bot <[email protected]>
hasura · Nov 18, 2024 · 235dc1a · 235dc1a
1 parent d05b959
commit 235dc1a
Show file tree

Hide file tree

Showing 82 changed files with 202 additions and 82 deletions.
diff --git a/docs/cli/commands/ddn_codemod.mdx b/docs/cli/commands/ddn_codemod.mdx
@@ -24,6 +24,7 @@ Perform transformations on your Hasura project directory
 - [ddn codemod rename-graphql-prefixes](/cli/commands/ddn_codemod_rename-graphql-prefixes) - Rename GraphQL root field and type name prefixes in metadata
 - [ddn codemod upgrade-context-v2-to-v3](/cli/commands/ddn_codemod_upgrade-context-v2-to-v3) - Upgrade project's context config from v2 to v3
 - [ddn codemod upgrade-graphqlconfig-aggregate](/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate) - Upgrade GraphqlConfig to support aggregates
+- [ddn codemod upgrade-graphqlconfig-subscriptions](/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions) - Upgrade GraphqlConfig to support subscriptions
 - [ddn codemod upgrade-object-boolean-expression-types](/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types) - Upgrade object boolean expression types metadata
 - [ddn codemod upgrade-project-config-v2-to-v3](/cli/commands/ddn_codemod_upgrade-project-config-v2-to-v3) - Upgrade project directory from version v2 to v3
 - [ddn codemod upgrade-supergraph-config-v1-to-v2](/cli/commands/ddn_codemod_upgrade-supergraph-config-v1-to-v2) - Upgrade all Supergraph config files at the root of the project directory from v1 to v2

diff --git a/docs/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions.mdx b/docs/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions.mdx
@@ -0,0 +1,59 @@
+---
+sidebar_label: ddn codemod upgrade-graphqlconfig-subscriptions
+sidebar_position: 12
+description: Upgrade GraphqlConfig to support subscriptions using the DDN CLI
+keywords:
+  - hasura
+  - DDN
+  - docs
+  - CLI
+  - ddn codemod upgrade-graphqlconfig-subscriptions
+---
+
+# DDN CLI: ddn codemod upgrade-graphqlconfig-subscriptions
+
+Upgrade GraphqlConfig to support subscriptions.
+
+## Synopsis
+
+Upgrade GraphqlConfig to support subscriptions
+
+```bash
+ddn codemod upgrade-graphqlconfig-subscriptions [flags]
+```
+
+## Examples
+
+```bash
+# Run on the supergraph defined in the context
+ ddn codemod upgrade-graphqlconfig-subscriptions
+
+# Run on a specific supergraph
+ ddn codemod upgrade-graphqlconfig-subscriptions --supergraph ./supergraph.cloud.yaml
+
+# Run on a specific subgraph
+ ddn codemod upgrade-graphqlconfig-subscriptions --subgraph app/subgraph.yaml
+```
+
+## Options
+
+```sass
+    --ci                  Disables the use of context
+-c, --context string      Name of the context to use. (default <current_context>)
+-h, --help                help for upgrade-graphqlconfig-subscriptions
+    --subgraph string     Path to Subgraph config file
+    --supergraph string   Path to Supergraph config file
+```
+
+## Options inherited from parent operations
+
+```sass
+--log-level string   Log level. Can be DEBUG, WARN, INFO, ERROR, or FATAL. (default "INFO")
+--no-prompt          Do not prompt for required but missing flags
+--out string         Output format. Can be table, json or yaml. (default "table")
+--timeout int        Request timeout in seconds [env: HASURA_DDN_TIMEOUT] (default 100)
+```
+
+## Parent operation
+
+- [ddn codemod](/cli/commands/ddn_codemod) - Perform transformations on your Hasura project directory
diff --git a/docs/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types.mdx b/docs/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn codemod upgrade-object-boolean-expression-types
-sidebar_position: 12
+sidebar_position: 13
 description: Upgrade object boolean expression types metadata using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_codemod_upgrade-project-config-v2-to-v3.mdx b/docs/cli/commands/ddn_codemod_upgrade-project-config-v2-to-v3.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn codemod upgrade-project-config-v2-to-v3
-sidebar_position: 13
+sidebar_position: 14
 description: Upgrade project directory from version v2 to v3 using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_codemod_upgrade-supergraph-config-v1-to-v2.mdx b/docs/cli/commands/ddn_codemod_upgrade-supergraph-config-v1-to-v2.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn codemod upgrade-supergraph-config-v1-to-v2
-sidebar_position: 14
+sidebar_position: 15
 description: Upgrade all Supergraph config files at the root of the project directory from v1 to v2 using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command.mdx b/docs/cli/commands/ddn_command.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command
-sidebar_position: 15
+sidebar_position: 16
 description: Perform Command related operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command_add.mdx b/docs/cli/commands/ddn_command_add.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command add
-sidebar_position: 16
+sidebar_position: 17
 description: Add new Commands to the local metadata using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command_list.mdx b/docs/cli/commands/ddn_command_list.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command list
-sidebar_position: 17
+sidebar_position: 18
 description: Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command_remove.mdx b/docs/cli/commands/ddn_command_remove.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command remove
-sidebar_position: 18
+sidebar_position: 19
 description: Removes Commands (and related metadata) in the local metadata using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command_show.mdx b/docs/cli/commands/ddn_command_show.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command show
-sidebar_position: 19
+sidebar_position: 20
 description: Show diff between the command and its corresponding ndc function/procedure using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_command_update.mdx b/docs/cli/commands/ddn_command_update.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn command update
-sidebar_position: 20
+sidebar_position: 21
 description: Update Commands in the local metadata using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link.mdx b/docs/cli/commands/ddn_connector-link.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link
-sidebar_position: 32
+sidebar_position: 33
 description: Perform DataConnectorLink related operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link_add-resources.mdx b/docs/cli/commands/ddn_connector-link_add-resources.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link add-resources
-sidebar_position: 34
+sidebar_position: 35
 description: Add all models, commands and relationships from a DataConnectorLink's schema using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link_add.mdx b/docs/cli/commands/ddn_connector-link_add.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link add
-sidebar_position: 33
+sidebar_position: 34
 description: Add a new DataConnectorLink to a Subgraph using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link_remove.mdx b/docs/cli/commands/ddn_connector-link_remove.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link remove
-sidebar_position: 35
+sidebar_position: 36
 description: Remove a DataConnectorLink from a Subgraph using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link_show.mdx b/docs/cli/commands/ddn_connector-link_show.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link show
-sidebar_position: 36
+sidebar_position: 37
 description: Show DataConnectorLink details using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector-link_update.mdx b/docs/cli/commands/ddn_connector-link_update.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector-link update
-sidebar_position: 37
+sidebar_position: 38
 description: Fetch NDC details from the Connector and update the DataConnectorLink using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector.mdx b/docs/cli/commands/ddn_connector.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector
-sidebar_position: 21
+sidebar_position: 22
 description: Perform Connector related operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_build.mdx b/docs/cli/commands/ddn_connector_build.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector build
-sidebar_position: 22
+sidebar_position: 23
 description: Perform ConnectorBuild related operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_build_create.mdx b/docs/cli/commands/ddn_connector_build_create.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector build create
-sidebar_position: 23
+sidebar_position: 24
 description: Create a ConnectorBuild on Hasura DDN using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_build_delete.mdx b/docs/cli/commands/ddn_connector_build_delete.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector build delete
-sidebar_position: 24
+sidebar_position: 25
 description: Delete a ConnectorBuild from a Project using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_build_get.mdx b/docs/cli/commands/ddn_connector_build_get.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector build get
-sidebar_position: 25
+sidebar_position: 26
 description: List ConnectorBuilds or get details of a specific one from Hasura DDN using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_build_logs.mdx b/docs/cli/commands/ddn_connector_build_logs.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector build logs
-sidebar_position: 26
+sidebar_position: 27
 description: Get logs of a ConnectorBuild from Hasura DDN using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_init.mdx b/docs/cli/commands/ddn_connector_init.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector init
-sidebar_position: 27
+sidebar_position: 28
 description: Add a new Connector using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_introspect.mdx b/docs/cli/commands/ddn_connector_introspect.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector introspect
-sidebar_position: 28
+sidebar_position: 29
 description: Introspect the Connector data source to update the Connector configuration using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_plugin.mdx b/docs/cli/commands/ddn_connector_plugin.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector plugin
-sidebar_position: 29
+sidebar_position: 30
 description: Run a subcommand from a Connector plugin using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_remove.mdx b/docs/cli/commands/ddn_connector_remove.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector remove
-sidebar_position: 30
+sidebar_position: 31
 description: Remove a Connector, its corresponding DataConnectorLink and all its associated metadata objects using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_connector_setenv.mdx b/docs/cli/commands/ddn_connector_setenv.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn connector setenv
-sidebar_position: 31
+sidebar_position: 32
 description: Run specified command with environment variables set using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_console.mdx b/docs/cli/commands/ddn_console.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn console
-sidebar_position: 38
+sidebar_position: 39
 description: Open the DDN console using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context.mdx b/docs/cli/commands/ddn_context.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context
-sidebar_position: 39
+sidebar_position: 40
 description: Perform context operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context_create-context.mdx b/docs/cli/commands/ddn_context_create-context.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context create-context
-sidebar_position: 40
+sidebar_position: 41
 description: Create a new context using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context_get-context.mdx b/docs/cli/commands/ddn_context_get-context.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context get-context
-sidebar_position: 42
+sidebar_position: 43
 description: List contexts or get details of a specific context using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context_get-current-context.mdx b/docs/cli/commands/ddn_context_get-current-context.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context get-current-context
-sidebar_position: 43
+sidebar_position: 44
 description: Get name and contents of current context using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context_get.mdx b/docs/cli/commands/ddn_context_get.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context get
-sidebar_position: 41
+sidebar_position: 42
 description: Get the value of a key in the context using the DDN CLI
 keywords:
   - hasura
@@ -19,7 +19,7 @@ Get the value of a key in the context.
 Get the value of a key in the context
 
 ```bash
-ddn context get <key> (Allowed keys: project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags]
+ddn context get <key> (Allowed keys: cloudEnvFile, selfHostedDataPlane, project, supergraph, subgraph, localEnvFile) [flags]
 ```
 
 ## Examples

diff --git a/docs/cli/commands/ddn_context_set-current-context.mdx b/docs/cli/commands/ddn_context_set-current-context.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context set-current-context
-sidebar_position: 45
+sidebar_position: 46
 description: Set the current context using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_context_set.mdx b/docs/cli/commands/ddn_context_set.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context set
-sidebar_position: 44
+sidebar_position: 45
 description: Set the value of a key in the context using the DDN CLI
 keywords:
   - hasura
@@ -19,7 +19,7 @@ Set the value of a key in the context.
 Set default value of keys to be used in DDN CLI commands
 
 ```bash
-ddn context set <key> <value> (Allowed keys: localEnvFile, cloudEnvFile, selfHostedDataPlane, project, supergraph, subgraph) [flags]
+ddn context set <key> <value> (Allowed keys: project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags]
 ```
 
 ## Examples

diff --git a/docs/cli/commands/ddn_context_unset.mdx b/docs/cli/commands/ddn_context_unset.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn context unset
-sidebar_position: 46
+sidebar_position: 47
 description: Unset the value of a key in the context using the DDN CLI
 keywords:
   - hasura
@@ -19,7 +19,7 @@ Unset the value of a key in the context.
 Unset the value of a key in the context
 
 ```bash
-ddn context unset <key> (Allowed keys: selfHostedDataPlane, project, supergraph, subgraph, localEnvFile, cloudEnvFile) [flags]
+ddn context unset <key> (Allowed keys: cloudEnvFile, selfHostedDataPlane, project, supergraph, subgraph, localEnvFile) [flags]
 ```
 
 ## Examples

diff --git a/docs/cli/commands/ddn_doctor.mdx b/docs/cli/commands/ddn_doctor.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn doctor
-sidebar_position: 48
+sidebar_position: 49
 description: Check if the dependencies of DDN CLI are present using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_model.mdx b/docs/cli/commands/ddn_model.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn model
-sidebar_position: 51
+sidebar_position: 52
 description: Perform Model related operations using the DDN CLI
 keywords:
   - hasura

diff --git a/docs/cli/commands/ddn_model_add.mdx b/docs/cli/commands/ddn_model_add.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_label: ddn model add
-sidebar_position: 52
+sidebar_position: 53
 description: Add new Models to the local metadata using the DDN CLI
 keywords:
   - hasura