update cli docs (#665)

Co-authored-by: Rob Dominguez <[email protected]>
hasura · Oct 1, 2024 · 969b0c2 · 969b0c2
1 parent 9448aa2
commit 969b0c2
Show file tree

Hide file tree

Showing 70 changed files with 207 additions and 79 deletions.
diff --git a/docs/cli/commands/ddn_codemod.mdx b/docs/cli/commands/ddn_codemod.mdx
@@ -21,6 +21,8 @@ Perform transformations on your Hasura project directory
 ## Available operations
 
 - [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-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-aggregate.mdx b/docs/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate.mdx
@@ -0,0 +1,59 @@
+---
+sidebar_label: ddn codemod upgrade-graphqlconfig-aggregate
+sidebar_position: 8
+description: Upgrade GraphqlConfig to support aggregates using the DDN CLI
+keywords:
+  - hasura
+  - DDN
+  - docs
+  - CLI
+  - ddn codemod upgrade-graphqlconfig-aggregate
+---
+
+# DDN CLI: ddn codemod upgrade-graphqlconfig-aggregate
+
+Upgrade GraphqlConfig to support aggregates.
+
+## Synopsis
+
+Upgrade GraphqlConfig to support aggregates
+
+```bash
+ddn codemod upgrade-graphqlconfig-aggregate [flags]
+```
+
+## Examples
+
+```bash
+# Run on the supergraph defined in the context
+ ddn codemod upgrade-graphqlconfig-aggregate
+
+# Run on a specific supergraph
+ ddn codemod upgrade-graphqlconfig-aggregate --supergraph ./supergraph.cloud.yaml
+
+# Run on a specific subgraph
+ ddn codemod upgrade-graphqlconfig-aggregate --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-aggregate
+    --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
@@ -0,0 +1,59 @@
+---
+sidebar_label: ddn codemod upgrade-object-boolean-expression-types
+sidebar_position: 9
+description: Upgrade object boolean expression types metadata using the DDN CLI
+keywords:
+  - hasura
+  - DDN
+  - docs
+  - CLI
+  - ddn codemod upgrade-object-boolean-expression-types
+---
+
+# DDN CLI: ddn codemod upgrade-object-boolean-expression-types
+
+Upgrade object boolean expression types metadata.
+
+## Synopsis
+
+Upgrade object boolean expression types metadata
+
+```bash
+ddn codemod upgrade-object-boolean-expression-types [flags]
+```
+
+## Examples
+
+```bash
+# Run on the supergraph defined in the context
+ ddn codemod upgrade-object-boolean-expression-types
+
+# Run on a specific supergraph
+ ddn codemod upgrade-object-boolean-expression-types --supergraph ./supergraph.cloud.yaml
+
+# Run on a specific subgraph
+ ddn codemod upgrade-object-boolean-expression-types --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-object-boolean-expression-types
+    --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-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: 8
+sidebar_position: 10
 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: 9
+sidebar_position: 11
 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: 10
+sidebar_position: 12
 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: 11
+sidebar_position: 13
 description: Add new Commands to the local metadata 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: 12
+sidebar_position: 14
 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: 23
+sidebar_position: 25
 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: 25
+sidebar_position: 27
 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: 24
+sidebar_position: 26
 description: Add a new DataConnectorLink to 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: 26
+sidebar_position: 28
 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: 27
+sidebar_position: 29
 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: 13
+sidebar_position: 15
 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: 14
+sidebar_position: 16
 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: 15
+sidebar_position: 17
 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: 16
+sidebar_position: 18
 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: 17
+sidebar_position: 19
 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: 18
+sidebar_position: 20
 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: 19
+sidebar_position: 21
 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: 20
+sidebar_position: 22
 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: 21
+sidebar_position: 23
 description: Run a subcommand from a Connector plugin 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: 22
+sidebar_position: 24
 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: 28
+sidebar_position: 30
 description: Open the DDN console using the DDN CLI
 keywords:
   - hasura
@@ -25,22 +25,30 @@ ddn console [flags]
 ## Examples
 
 ```bash
+# Open the console for the DDN project set in the context
+ ddn console
+
 # Open the local dev console
  ddn console --local
 
+# Open the local dev console with a specific engine url
+ ddn console --url http://localhost:8080
+
 # Open the console for a specific DDN project
  ddn console --project my-project-123
 
-# Open the console for the DDN project set in the context
- ddn console
+# Open the console for a specific SupergraphBuild
+ ddn console --project my-project-123 --build-version build-version-123
 ```
 
 ## Options
 
 ```sass
--h, --help             help for console
-    --local            Open the local dev console
--p, --project string   DDN Project name
+    --build-version string   SupergraphBuild version
+-h, --help                   help for console
+    --local                  Open the local dev console
+-p, --project string         DDN Project name
+    --url string             Local engine url
 ```
 
 ## Options inherited from parent operations

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: 29
+sidebar_position: 31
 description: Perform context operations using the DDN CLI
 keywords:
   - hasura
@@ -23,7 +23,7 @@ Manage default value of keys to be used in DDN CLI commands
 - [ddn context create-context](/cli/commands/ddn_context_create-context) - Create a new context
 - [ddn context get](/cli/commands/ddn_context_get) - Get the value of a key in the context
 - [ddn context get-context](/cli/commands/ddn_context_get-context) - List contexts or get details of a specific context
-- [ddn context get-current-context](/cli/commands/ddn_context_get-current-context) - Get the current context
+- [ddn context get-current-context](/cli/commands/ddn_context_get-current-context) - Get name and contents of current context
 - [ddn context set](/cli/commands/ddn_context_set) - Set the value of a key in the context
 - [ddn context set-current-context](/cli/commands/ddn_context_set-current-context) - Set the current context
 - [ddn context unset](/cli/commands/ddn_context_unset) - Unset the value of a key in the context

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: 30
+sidebar_position: 32
 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: 32
+sidebar_position: 34
 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,7 +1,7 @@
 ---
 sidebar_label: ddn context get-current-context
-sidebar_position: 33
-description: Get the current context using the DDN CLI
+sidebar_position: 35
+description: Get name and contents of current context using the DDN CLI
 keywords:
   - hasura
   - DDN
@@ -12,11 +12,11 @@ keywords:
 
 # DDN CLI: ddn context get-current-context
 
-Get the current context.
+Get name and contents of current context.
 
 ## Synopsis
 
-Get the current context
+Get name and contents of current context
 
 ```bash
 ddn context get-current-context [flags]
@@ -25,7 +25,7 @@ ddn context get-current-context [flags]
 ## Examples
 
 ```bash
-# Get current context
+# Get name and contents of current context
  ddn context get-current-context
 ```