Update CLI docs (#640)

hasura · Sep 19, 2024 · e12c919 · e12c919
1 parent bd3498c
commit e12c919
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 13 deletions.
diff --git a/docs/cli/commands/ddn.mdx b/docs/cli/commands/ddn.mdx
@@ -49,7 +49,7 @@ ddn [flags]
 - [ddn plugins](/cli/commands/ddn_plugins) - Manage plugins for the CLI
 - [ddn project](/cli/commands/ddn_project) - Manage Hasura DDN Project
 - [ddn relationship](/cli/commands/ddn_relationship) - Perform Relationship related operations
-- [ddn run](/cli/commands/ddn_run) - Run specific script from project's context
+- [ddn run](/cli/commands/ddn_run) - Run specific script from project's context config
 - [ddn subgraph](/cli/commands/ddn_subgraph) - Perform Subgraph related operations
 - [ddn supergraph](/cli/commands/ddn_supergraph) - Perform Supergraph related operations
 - [ddn update-cli](/cli/commands/ddn_update-cli) - Update this CLI to the latest version or to a specific version

diff --git a/docs/cli/commands/ddn_codemod_upgrade-context-v2-to-v3.mdx b/docs/cli/commands/ddn_codemod_upgrade-context-v2-to-v3.mdx
@@ -19,7 +19,7 @@ Upgrade project's context config from v2 to v3.
 Upgrade project's context config from v2 to v3
 
 ```bash
-ddn codemod upgrade-context-v2-to-v3 [flags]
+ddn codemod upgrade-context-v2-to-v3 --dir <project-dir> [flags]
 ```
 
 ## Examples

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
@@ -19,7 +19,7 @@ Upgrade project directory from version v2 to v3.
 Upgrade project directory from version v2 to v3
 
 ```bash
-ddn codemod upgrade-project-config-v2-to-v3 [flags]
+ddn codemod upgrade-project-config-v2-to-v3 --dir <project-dir> [flags]
 ```
 
 ## Examples

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
@@ -19,7 +19,7 @@ Upgrade all Supergraph config files at the root of the project directory from v1
 Upgrade all Supergraph config files at the root of the project directory from v1 to v2
 
 ```bash
-ddn codemod upgrade-supergraph-config-v1-to-v2 [flags]
+ddn codemod upgrade-supergraph-config-v1-to-v2 --dir <project-dir> [flags]
 ```
 
 ## Examples

diff --git a/docs/cli/commands/ddn_connector-link.mdx b/docs/cli/commands/ddn_connector-link.mdx
@@ -23,7 +23,7 @@ Perform DataConnectorLink related operations
 - [ddn connector-link add](/cli/commands/ddn_connector-link_add) - Add a new DataConnectorLink to a Subgraph
 - [ddn connector-link add-resources](/cli/commands/ddn_connector-link_add-resources) - Add all models, commands and relationships from a DataConnectorLink's schema
 - [ddn connector-link show](/cli/commands/ddn_connector-link_show) - Show DataConnectorLink details
-- [ddn connector-link update](/cli/commands/ddn_connector-link_update) - Introspect the Connector and update the schema of a DataConnectorLink
+- [ddn connector-link update](/cli/commands/ddn_connector-link_update) - Fetch NDC details from the Connector and update the DataConnectorLink
 
 ## Options
 

diff --git a/docs/cli/commands/ddn_connector-link_update.mdx b/docs/cli/commands/ddn_connector-link_update.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: ddn connector-link update
 sidebar_position: 27
-description: Introspect the Connector and update the schema of a DataConnectorLink using the DDN CLI
+description: Fetch NDC details from the Connector and update the DataConnectorLink using the DDN CLI
 keywords:
   - hasura
   - DDN
@@ -12,11 +12,11 @@ keywords:
 
 # DDN CLI: ddn connector-link update
 
-Introspect the Connector and update the schema of a DataConnectorLink.
+Fetch NDC details from the Connector and update the DataConnectorLink.
 
 ## Synopsis
 
-Introspect the Connector and update the schema of a DataConnectorLink
+Fetch NDC details from the Connector and update the DataConnectorLink
 
 ```bash
 ddn connector-link update <connector-link-name> [flags]

diff --git a/docs/cli/commands/ddn_context_set.mdx b/docs/cli/commands/ddn_context_set.mdx
@@ -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, project, supergraph, subgraph) [flags]
+ddn context set <key> <value> (Allowed keys: supergraph, subgraph, localEnvFile, cloudEnvFile, project) [flags]
 ```
 
 ## Examples

diff --git a/docs/cli/commands/ddn_run.mdx b/docs/cli/commands/ddn_run.mdx
@@ -1,7 +1,7 @@
 ---
 sidebar_label: ddn run
 sidebar_position: 56
-description: Run specific script from project's context using the DDN CLI
+description: Run specific script from project's context config using the DDN CLI
 keywords:
   - hasura
   - DDN
@@ -12,11 +12,11 @@ keywords:
 
 # DDN CLI: ddn run
 
-Run specific script from project's context.
+Run specific script from project's context config.
 
 ## Synopsis
 
-Run specific script from project's context
+Run custom scripts defined in project's context config (typically at .hasura/context.yaml)
 
 ```bash
 ddn run <script-name> [flags]
@@ -25,7 +25,7 @@ ddn run <script-name> [flags]
 ## Examples
 
 ```bash
-# Run script `docker-start` defined in project's context
+# Run script `docker-start` defined in project's context config
  ddn run docker-start
 ```
 

diff --git a/docs/cli/commands/index.mdx b/docs/cli/commands/index.mdx
@@ -71,6 +71,7 @@ Other operations
   context        Perform context operations
   help           Help about any command
   plugins        Manage plugins for the CLI
+  run            Run specific script from project's context config
   update-cli     Update this CLI to the latest version or to a specific version
   version        Prints the CLI version