diff --git a/docs/reference/cli/commands/ddn.mdx b/docs/reference/cli/commands/ddn.mdx index 5146b347c..f3259a917 100644 --- a/docs/reference/cli/commands/ddn.mdx +++ b/docs/reference/cli/commands/ddn.mdx @@ -17,9 +17,9 @@ DDN Command Line Interface. ``` + - -DDDDDDD\ DDDDDDD\ NN\ NN\ +DDDDDDD\ DDDDDDD\ NN\ NN\ DD __DD\ DD __DD\ NNN\ NN | DD | DD | DD | DD | NNNN\ NN | DD | DD | DD | DD | NN NN\NN | @@ -63,3 +63,4 @@ ddn [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) ``` + diff --git a/docs/reference/cli/commands/ddn_auth.mdx b/docs/reference/cli/commands/ddn_auth.mdx index d099666f1..1e4ac5a92 100644 --- a/docs/reference/cli/commands/ddn_auth.mdx +++ b/docs/reference/cli/commands/ddn_auth.mdx @@ -20,13 +20,11 @@ Manage Hasura DDN CLI Auth ## Available operations -- [ddn auth generate-promptql-secret-key](/reference/cli/commands/ddn_auth_generate-promptql-secret-key) - Generates the - project's PromptQL secret key and saves to global config +- [ddn auth generate-promptql-secret-key](/reference/cli/commands/ddn_auth_generate-promptql-secret-key) - Generates the project's PromptQL secret key and saves to global config - [ddn auth login](/reference/cli/commands/ddn_auth_login) - Login to DDN - [ddn auth logout](/reference/cli/commands/ddn_auth_logout) - Logout from DDN -- [ddn auth print-pat](/reference/cli/commands/ddn_auth_print-pat) - Prints the PAT to STDOUT -- [ddn auth print-promptql-secret-key](/reference/cli/commands/ddn_auth_print-promptql-secret-key) - Prints the - project's PromptQL secret key to STDOUT +- [ddn auth print-access-token](/reference/cli/commands/ddn_auth_print-access-token) - Prints the access token to STDOUT +- [ddn auth print-promptql-secret-key](/reference/cli/commands/ddn_auth_print-promptql-secret-key) - Prints the project's PromptQL secret key to STDOUT ## Options diff --git a/docs/reference/cli/commands/ddn_auth_login.mdx b/docs/reference/cli/commands/ddn_auth_login.mdx index 2468fbbd9..03bee538f 100644 --- a/docs/reference/cli/commands/ddn_auth_login.mdx +++ b/docs/reference/cli/commands/ddn_auth_login.mdx @@ -29,14 +29,15 @@ ddn auth login [flags] ddn auth login # Login with Personal Access Token - ddn auth login --pat + ddn auth login --access-token ``` ## Options ```sass --h, --help help for login - --pat string Personal Access token [env: HASURA_DDN_PAT] + --access-token string The Personal Access Token or Service Account Token [env: HASURA_DDN_ACCESS_TOKEN] +-h, --help help for login + --pat string Personal Access token [env: HASURA_DDN_PAT] (DEPRECATED: use --access-token instead) ``` ## Options inherited from parent operations diff --git a/docs/reference/cli/commands/ddn_auth_print-pat.mdx b/docs/reference/cli/commands/ddn_auth_print-access-token.mdx similarity index 55% rename from docs/reference/cli/commands/ddn_auth_print-pat.mdx rename to docs/reference/cli/commands/ddn_auth_print-access-token.mdx index 1dc1d1bf1..1bb695fa2 100644 --- a/docs/reference/cli/commands/ddn_auth_print-pat.mdx +++ b/docs/reference/cli/commands/ddn_auth_print-access-token.mdx @@ -1,43 +1,43 @@ --- -sidebar_label: ddn auth print-pat +sidebar_label: ddn auth print-access-token sidebar_position: 6 -description: Prints the PAT to STDOUT using the DDN CLI +description: Prints the access token to STDOUT using the DDN CLI keywords: - hasura - DDN - docs - CLI - - ddn auth print-pat + - ddn auth print-access-token --- -# DDN CLI: ddn auth print-pat +# DDN CLI: ddn auth print-access-token -Prints the PAT to STDOUT. +Prints the access token to STDOUT. ## Synopsis -Prints the PAT to STDOUT +Prints the access token to STDOUT ```bash -ddn auth print-pat [flags] +ddn auth print-access-token [flags] ``` -**Alias:** pp +**Alias:** pp, print-pat ## Examples ```bash -# Print the PAT as a string to STDOUT - ddn auth print-pat +# Print the access token as a string to STDOUT + ddn auth print-access-token -# Print PAT as a JSON to STDOUT - ddn auth print-pat --out json +# Print access token as a JSON to STDOUT + ddn auth print-access-token --out json ``` ## Options ```sass --h, --help help for print-pat +-h, --help help for print-access-token ``` ## Options inherited from parent operations diff --git a/docs/reference/cli/commands/ddn_codemod.mdx b/docs/reference/cli/commands/ddn_codemod.mdx index 5fe1f00e7..e352cbc94 100644 --- a/docs/reference/cli/commands/ddn_codemod.mdx +++ b/docs/reference/cli/commands/ddn_codemod.mdx @@ -20,26 +20,16 @@ Perform transformations on your Hasura project directory ## Available operations -- [ddn codemod configure-header-forwarding](/reference/cli/commands/ddn_codemod_configure-header-forwarding) - Configure - headers to be forwarded to your connector -- [ddn codemod fix-traces-env-var](/reference/cli/commands/ddn_codemod_fix-traces-env-var) - Fix env var used for - configuring traces for connectors -- [ddn codemod rename-graphql-prefixes](/reference/cli/commands/ddn_codemod_rename-graphql-prefixes) - Rename GraphQL - root field and type name prefixes in metadata -- [ddn codemod upgrade-context-v2-to-v3](/reference/cli/commands/ddn_codemod_upgrade-context-v2-to-v3) - Upgrade - project's context config from v2 to v3 -- [ddn codemod upgrade-graphqlconfig-aggregate](/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate) - - Upgrade GraphqlConfig to support aggregates -- [ddn codemod upgrade-graphqlconfig-subscriptions](/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions) - - Upgrade GraphqlConfig to support subscriptions -- [ddn codemod upgrade-model-v1-to-v2](/reference/cli/commands/ddn_codemod_upgrade-model-v1-to-v2) - Upgrade model from - "version" "v1" to "v2" in metadata -- [ddn codemod upgrade-object-boolean-expression-types](/reference/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types) - - Upgrade object boolean expression types metadata -- [ddn codemod upgrade-project-config-v2-to-v3](/reference/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](/reference/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 +- [ddn codemod configure-header-forwarding](/reference/cli/commands/ddn_codemod_configure-header-forwarding) - Configure headers to be forwarded to your connector +- [ddn codemod fix-traces-env-var](/reference/cli/commands/ddn_codemod_fix-traces-env-var) - Fix env var used for configuring traces for connectors +- [ddn codemod rename-graphql-prefixes](/reference/cli/commands/ddn_codemod_rename-graphql-prefixes) - Rename GraphQL root field and type name prefixes in metadata +- [ddn codemod upgrade-context-v2-to-v3](/reference/cli/commands/ddn_codemod_upgrade-context-v2-to-v3) - Upgrade project's context config from v2 to v3 +- [ddn codemod upgrade-graphqlconfig-aggregate](/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate) - Upgrade GraphqlConfig to support aggregates +- [ddn codemod upgrade-graphqlconfig-subscriptions](/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions) - Upgrade GraphqlConfig to support subscriptions +- [ddn codemod upgrade-model-v1-to-v2](/reference/cli/commands/ddn_codemod_upgrade-model-v1-to-v2) - Upgrade model from "version" "v1" to "v2" in metadata +- [ddn codemod upgrade-object-boolean-expression-types](/reference/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types) - Upgrade object boolean expression types metadata +- [ddn codemod upgrade-project-config-v2-to-v3](/reference/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](/reference/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 ## Options diff --git a/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes.mdx b/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes.mdx index ff9e446bd..2068c3930 100644 --- a/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes.mdx +++ b/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes.mdx @@ -16,8 +16,7 @@ Rename GraphQL root field and type name prefixes in metadata. ## Synopsis -Rename GraphQL root field and type name prefixes in metadata. The from prefix will be stripped if provided, and the new -prefix will be added. If the new prefix is already present, it will not be reapplied. +Rename GraphQL root field and type name prefixes in metadata. The from prefix will be stripped if provided, and the new prefix will be added. If the new prefix is already present, it will not be reapplied. By default, subgraph.yaml is updated with the new prefixes. diff --git a/docs/reference/cli/commands/ddn_command.mdx b/docs/reference/cli/commands/ddn_command.mdx index 351a73565..7fac32812 100644 --- a/docs/reference/cli/commands/ddn_command.mdx +++ b/docs/reference/cli/commands/ddn_command.mdx @@ -23,12 +23,9 @@ Perform Command related operations ## Available operations - [ddn command add](/reference/cli/commands/ddn_command_add) - Add new Commands to the local metadata -- [ddn command list](/reference/cli/commands/ddn_command_list) - Lists details about the functions/procedures of - DataConnectorLink, and their corresponding Commands -- [ddn command remove](/reference/cli/commands/ddn_command_remove) - Removes Commands (and related metadata) in the - local metadata -- [ddn command show](/reference/cli/commands/ddn_command_show) - Show diff between the command and its corresponding ndc - function/procedure +- [ddn command list](/reference/cli/commands/ddn_command_list) - Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands +- [ddn command remove](/reference/cli/commands/ddn_command_remove) - Removes Commands (and related metadata) in the local metadata +- [ddn command show](/reference/cli/commands/ddn_command_show) - Show diff between the command and its corresponding ndc function/procedure - [ddn command update](/reference/cli/commands/ddn_command_update) - Update Commands in the local metadata ## Options diff --git a/docs/reference/cli/commands/ddn_command_list.mdx b/docs/reference/cli/commands/ddn_command_list.mdx index c412f6a2a..b0e3a2f2e 100644 --- a/docs/reference/cli/commands/ddn_command_list.mdx +++ b/docs/reference/cli/commands/ddn_command_list.mdx @@ -1,8 +1,7 @@ --- sidebar_label: ddn command list sidebar_position: 22 -description: - Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands using the DDN CLI +description: Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands using the DDN CLI keywords: - hasura - DDN diff --git a/docs/reference/cli/commands/ddn_connector-link.mdx b/docs/reference/cli/commands/ddn_connector-link.mdx index 9402d612b..0c861c9bf 100644 --- a/docs/reference/cli/commands/ddn_connector-link.mdx +++ b/docs/reference/cli/commands/ddn_connector-link.mdx @@ -23,13 +23,10 @@ Perform DataConnectorLink related operations ## Available operations - [ddn connector-link add](/reference/cli/commands/ddn_connector-link_add) - Add a new DataConnectorLink to a Subgraph -- [ddn connector-link add-resources](/reference/cli/commands/ddn_connector-link_add-resources) - Add all models, - commands and relationships from a DataConnectorLink's schema -- [ddn connector-link remove](/reference/cli/commands/ddn_connector-link_remove) - Remove a DataConnectorLink from a - Subgraph +- [ddn connector-link add-resources](/reference/cli/commands/ddn_connector-link_add-resources) - Add all models, commands and relationships from a DataConnectorLink's schema +- [ddn connector-link remove](/reference/cli/commands/ddn_connector-link_remove) - Remove a DataConnectorLink from a Subgraph - [ddn connector-link show](/reference/cli/commands/ddn_connector-link_show) - Show DataConnectorLink details -- [ddn connector-link update](/reference/cli/commands/ddn_connector-link_update) - Fetch NDC details from the Connector - and update the DataConnectorLink +- [ddn connector-link update](/reference/cli/commands/ddn_connector-link_update) - Fetch NDC details from the Connector and update the DataConnectorLink ## Options diff --git a/docs/reference/cli/commands/ddn_connector.mdx b/docs/reference/cli/commands/ddn_connector.mdx index d8116dd54..2cacd1430 100644 --- a/docs/reference/cli/commands/ddn_connector.mdx +++ b/docs/reference/cli/commands/ddn_connector.mdx @@ -25,13 +25,10 @@ Perform Connector related operations - [ddn connector build](/reference/cli/commands/ddn_connector_build) - Perform ConnectorBuild related operations - [ddn connector env](/reference/cli/commands/ddn_connector_env) - Manage environment variables for Connectors - [ddn connector init](/reference/cli/commands/ddn_connector_init) - Add a new Connector -- [ddn connector introspect](/reference/cli/commands/ddn_connector_introspect) - Introspect the Connector data source to - update the Connector configuration +- [ddn connector introspect](/reference/cli/commands/ddn_connector_introspect) - Introspect the Connector data source to update the Connector configuration - [ddn connector plugin](/reference/cli/commands/ddn_connector_plugin) - Run a subcommand from a Connector plugin -- [ddn connector remove](/reference/cli/commands/ddn_connector_remove) - Remove a Connector, its corresponding - DataConnectorLink and all its associated metadata objects -- [ddn connector setenv](/reference/cli/commands/ddn_connector_setenv) - Run specified command with environment - variables set +- [ddn connector remove](/reference/cli/commands/ddn_connector_remove) - Remove a Connector, its corresponding DataConnectorLink and all its associated metadata objects +- [ddn connector setenv](/reference/cli/commands/ddn_connector_setenv) - Run specified command with environment variables set - [ddn connector show-resources](/reference/cli/commands/ddn_connector_show-resources) - Show resources of a Connector ## Options diff --git a/docs/reference/cli/commands/ddn_connector_build.mdx b/docs/reference/cli/commands/ddn_connector_build.mdx index 037b4c890..f08b133ce 100644 --- a/docs/reference/cli/commands/ddn_connector_build.mdx +++ b/docs/reference/cli/commands/ddn_connector_build.mdx @@ -20,14 +20,10 @@ Perform ConnectorBuild related operations ## Available operations -- [ddn connector build create](/reference/cli/commands/ddn_connector_build_create) - Create a ConnectorBuild on Hasura - DDN -- [ddn connector build delete](/reference/cli/commands/ddn_connector_build_delete) - Delete a ConnectorBuild from a - Project -- [ddn connector build get](/reference/cli/commands/ddn_connector_build_get) - List ConnectorBuilds or get details of a - specific one from Hasura DDN -- [ddn connector build logs](/reference/cli/commands/ddn_connector_build_logs) - Get logs of a ConnectorBuild from - Hasura DDN +- [ddn connector build create](/reference/cli/commands/ddn_connector_build_create) - Create a ConnectorBuild on Hasura DDN +- [ddn connector build delete](/reference/cli/commands/ddn_connector_build_delete) - Delete a ConnectorBuild from a Project +- [ddn connector build get](/reference/cli/commands/ddn_connector_build_get) - List ConnectorBuilds or get details of a specific one from Hasura DDN +- [ddn connector build logs](/reference/cli/commands/ddn_connector_build_logs) - Get logs of a ConnectorBuild from Hasura DDN ## Options diff --git a/docs/reference/cli/commands/ddn_connector_env.mdx b/docs/reference/cli/commands/ddn_connector_env.mdx index 596a8a45d..14d37b92c 100644 --- a/docs/reference/cli/commands/ddn_connector_env.mdx +++ b/docs/reference/cli/commands/ddn_connector_env.mdx @@ -20,8 +20,7 @@ Manage environment variables for Connectors ## Available operations -- [ddn connector env add](/reference/cli/commands/ddn_connector_env_add) - Add environment variables and its - corresponding mapping to a Connector +- [ddn connector env add](/reference/cli/commands/ddn_connector_env_add) - Add environment variables and its corresponding mapping to a Connector ## Options diff --git a/docs/reference/cli/commands/ddn_connector_init.mdx b/docs/reference/cli/commands/ddn_connector_init.mdx index 88a4db4e3..2eab1fd67 100644 --- a/docs/reference/cli/commands/ddn_connector_init.mdx +++ b/docs/reference/cli/commands/ddn_connector_init.mdx @@ -35,7 +35,7 @@ ddn connector init [connector-name] --hub-connector [flags] ddn connector init mydb --dir ./connector --hub-connector hasura/postgres # Initialize a NodeJS Connector "mylambda" in the Subgraph "app" on port 8765 - ddn connector init mylambda --subgraph ./app/subgraph.yaml --hub-connector hasura/nodejs --configure-port 8765 + ddn connector init mylambda --subgraph ./app/subgraph.yaml --hub-connector hasura/nodejs --configure-port 8765 ``` ## Options diff --git a/docs/reference/cli/commands/ddn_connector_remove.mdx b/docs/reference/cli/commands/ddn_connector_remove.mdx index 1c1e99588..72920778a 100644 --- a/docs/reference/cli/commands/ddn_connector_remove.mdx +++ b/docs/reference/cli/commands/ddn_connector_remove.mdx @@ -1,8 +1,7 @@ --- sidebar_label: ddn connector remove sidebar_position: 37 -description: - Remove a Connector, its corresponding DataConnectorLink and all its associated metadata objects using the DDN CLI +description: Remove a Connector, its corresponding DataConnectorLink and all its associated metadata objects using the DDN CLI keywords: - hasura - DDN diff --git a/docs/reference/cli/commands/ddn_context.mdx b/docs/reference/cli/commands/ddn_context.mdx index c633253b8..81282e642 100644 --- a/docs/reference/cli/commands/ddn_context.mdx +++ b/docs/reference/cli/commands/ddn_context.mdx @@ -22,10 +22,8 @@ Manage default value of keys to be used in DDN CLI commands - [ddn context create-context](/reference/cli/commands/ddn_context_create-context) - Create a new context - [ddn context get](/reference/cli/commands/ddn_context_get) - Get the value of a key in the context -- [ddn context get-context](/reference/cli/commands/ddn_context_get-context) - List contexts or get details of a - specific context -- [ddn context get-current-context](/reference/cli/commands/ddn_context_get-current-context) - Get name and contents of - current context +- [ddn context get-context](/reference/cli/commands/ddn_context_get-context) - List contexts or get details of a specific context +- [ddn context get-current-context](/reference/cli/commands/ddn_context_get-current-context) - Get name and contents of current context - [ddn context set](/reference/cli/commands/ddn_context_set) - Set the value of a key in the context - [ddn context set-current-context](/reference/cli/commands/ddn_context_set-current-context) - Set the current context - [ddn context unset](/reference/cli/commands/ddn_context_unset) - Unset the value of a key in the context diff --git a/docs/reference/cli/commands/ddn_context_unset.mdx b/docs/reference/cli/commands/ddn_context_unset.mdx index d3d3b204a..8a6b28dc8 100644 --- a/docs/reference/cli/commands/ddn_context_unset.mdx +++ b/docs/reference/cli/commands/ddn_context_unset.mdx @@ -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 (Allowed keys: selfHostedDataPlane, project, supergraph, subgraph, localEnvFile, cloudEnvFile) [flags] +ddn context unset (Allowed keys: localEnvFile, cloudEnvFile, selfHostedDataPlane, project, supergraph, subgraph) [flags] ``` ## Examples diff --git a/docs/reference/cli/commands/ddn_doctor.mdx b/docs/reference/cli/commands/ddn_doctor.mdx index b86d6c131..1fa0ac267 100644 --- a/docs/reference/cli/commands/ddn_doctor.mdx +++ b/docs/reference/cli/commands/ddn_doctor.mdx @@ -16,8 +16,7 @@ Check if the dependencies of DDN CLI are present. ## Synopsis -Check if the dependencies (Docker and Docker Compose) of DDN CLI are installed, are of the required version and if they -are running. +Check if the dependencies (Docker and Docker Compose) of DDN CLI are installed, are of the required version and if they are running. ```bash ddn doctor [flags] diff --git a/docs/reference/cli/commands/ddn_model.mdx b/docs/reference/cli/commands/ddn_model.mdx index 389e50947..6f20276ba 100644 --- a/docs/reference/cli/commands/ddn_model.mdx +++ b/docs/reference/cli/commands/ddn_model.mdx @@ -23,12 +23,9 @@ Perform Model related operations ## Available operations - [ddn model add](/reference/cli/commands/ddn_model_add) - Add new Models to the local metadata -- [ddn model list](/reference/cli/commands/ddn_model_list) - Lists details about the collections of DataConnectorLink, - and their corresponding Models -- [ddn model remove](/reference/cli/commands/ddn_model_remove) - Removes Models (and related metadata) in the local - metadata -- [ddn model show](/reference/cli/commands/ddn_model_show) - Show diff between the model and its corresponding ndc - collection +- [ddn model list](/reference/cli/commands/ddn_model_list) - Lists details about the collections of DataConnectorLink, and their corresponding Models +- [ddn model remove](/reference/cli/commands/ddn_model_remove) - Removes Models (and related metadata) in the local metadata +- [ddn model show](/reference/cli/commands/ddn_model_show) - Show diff between the model and its corresponding ndc collection - [ddn model update](/reference/cli/commands/ddn_model_update) - Update Models in the local metadata ## Options diff --git a/docs/reference/cli/commands/ddn_plugins.mdx b/docs/reference/cli/commands/ddn_plugins.mdx index 4ce837697..62cd38311 100644 --- a/docs/reference/cli/commands/ddn_plugins.mdx +++ b/docs/reference/cli/commands/ddn_plugins.mdx @@ -16,8 +16,7 @@ Manage plugins for the CLI. ## Synopsis -The functionality of the CLI can be extended by using plugins. For a list of all available plugins, run -`ddn plugins list`, or visit this repository: https://github.com/hasura/cli-plugins-index. +The functionality of the CLI can be extended by using plugins. For a list of all available plugins, run ``ddn plugins list``, or visit this repository: https://github.com/hasura/cli-plugins-index. If you're interested in contributing, please open a PR against this repo. @@ -26,8 +25,7 @@ If you're interested in contributing, please open a PR against this repo. ## Available operations - [ddn plugins install](/reference/cli/commands/ddn_plugins_install) - Install a plugin from the index -- [ddn plugins list](/reference/cli/commands/ddn_plugins_list) - List all available plugins with index, versions and - installation status +- [ddn plugins list](/reference/cli/commands/ddn_plugins_list) - List all available plugins with index, versions and installation status - [ddn plugins uninstall](/reference/cli/commands/ddn_plugins_uninstall) - Uninstall a plugin - [ddn plugins upgrade](/reference/cli/commands/ddn_plugins_upgrade) - Upgrade a plugin to a newer version diff --git a/docs/reference/cli/commands/ddn_plugins_install.mdx b/docs/reference/cli/commands/ddn_plugins_install.mdx index 3d4336fc3..260f143ec 100644 --- a/docs/reference/cli/commands/ddn_plugins_install.mdx +++ b/docs/reference/cli/commands/ddn_plugins_install.mdx @@ -16,8 +16,7 @@ Install a plugin from the index. ## Synopsis -To install plugins that extend the functionality of the DDN CLI, you can use the install command. This command will -install the plugin from the index and add it to your configuration file. +To install plugins that extend the functionality of the DDN CLI, you can use the install command. This command will install the plugin from the index and add it to your configuration file. ```bash ddn plugins install [flags] diff --git a/docs/reference/cli/commands/ddn_plugins_list.mdx b/docs/reference/cli/commands/ddn_plugins_list.mdx index 57a083da4..d9e384cf1 100644 --- a/docs/reference/cli/commands/ddn_plugins_list.mdx +++ b/docs/reference/cli/commands/ddn_plugins_list.mdx @@ -16,8 +16,7 @@ List all available plugins with index, versions and installation status. ## Synopsis -Run the plugins list command to see a list of all the available plugins which extend the functionality of the CLI, their -versions and installation status. +Run the plugins list command to see a list of all the available plugins which extend the functionality of the CLI, their versions and installation status. ```bash ddn plugins list [flags] diff --git a/docs/reference/cli/commands/ddn_plugins_uninstall.mdx b/docs/reference/cli/commands/ddn_plugins_uninstall.mdx index 31deca15d..8043d94b8 100644 --- a/docs/reference/cli/commands/ddn_plugins_uninstall.mdx +++ b/docs/reference/cli/commands/ddn_plugins_uninstall.mdx @@ -16,8 +16,7 @@ Uninstall a plugin. ## Synopsis -To uninstall a plugin, run the uninstall command with the name of the plugin as an argument. If unsure of the plugin's -name, you can run the `ddn plugins list` command to see a list of all the available plugins. +To uninstall a plugin, run the uninstall command with the name of the plugin as an argument. If unsure of the plugin's name, you can run the `ddn plugins list` command to see a list of all the available plugins. ```bash ddn plugins uninstall [flags] diff --git a/docs/reference/cli/commands/ddn_plugins_upgrade.mdx b/docs/reference/cli/commands/ddn_plugins_upgrade.mdx index 39585e6ba..936f1144e 100644 --- a/docs/reference/cli/commands/ddn_plugins_upgrade.mdx +++ b/docs/reference/cli/commands/ddn_plugins_upgrade.mdx @@ -16,8 +16,7 @@ Upgrade a plugin to a newer version. ## Synopsis -To upgrade a plugin, run the upgrade command with the name of the plugin as an argument. If unsure of the plugin's name, -you can run the `ddn plugins list` command to see a list of all the available plugins. +To upgrade a plugin, run the upgrade command with the name of the plugin as an argument. If unsure of the plugin's name, you can run the `ddn plugins list` command to see a list of all the available plugins. ```bash ddn plugins upgrade [flags] diff --git a/docs/reference/cli/commands/ddn_project.mdx b/docs/reference/cli/commands/ddn_project.mdx index 816d650fa..8d9c33fba 100644 --- a/docs/reference/cli/commands/ddn_project.mdx +++ b/docs/reference/cli/commands/ddn_project.mdx @@ -23,12 +23,9 @@ Manage Hasura DDN Project - [ddn project create](/reference/cli/commands/ddn_project_create) - Create a new Project on Hasura DDN - [ddn project delete](/reference/cli/commands/ddn_project_delete) - Delete a Project on Hasura DDN - [ddn project get](/reference/cli/commands/ddn_project_get) - List Hasura DDN Projects or get details of a specific one -- [ddn project init](/reference/cli/commands/ddn_project_init) - Configure the local directory to use a Hasura DDN - project, creating a DDN project and subgraphs as necessary -- [ddn project set-api-access-mode](/reference/cli/commands/ddn_project_set-api-access-mode) - Set the API access mode - for a Project on Hasura DDN -- [ddn project set-self-hosted-engine-url](/reference/cli/commands/ddn_project_set-self-hosted-engine-url) - Set the - engine's URL for a project in a self hosted data plane. +- [ddn project init](/reference/cli/commands/ddn_project_init) - Configure the local directory to use a Hasura DDN project, creating a DDN project and subgraphs as necessary +- [ddn project set-api-access-mode](/reference/cli/commands/ddn_project_set-api-access-mode) - Set the API access mode for a Project on Hasura DDN +- [ddn project set-self-hosted-engine-url](/reference/cli/commands/ddn_project_set-self-hosted-engine-url) - Set the engine's URL for a project in a self hosted data plane. - [ddn project subgraph](/reference/cli/commands/ddn_project_subgraph) - Manage Subgraphs in a Hasura DDN Project ## Options diff --git a/docs/reference/cli/commands/ddn_project_init.mdx b/docs/reference/cli/commands/ddn_project_init.mdx index f9344f143..459da518c 100644 --- a/docs/reference/cli/commands/ddn_project_init.mdx +++ b/docs/reference/cli/commands/ddn_project_init.mdx @@ -1,9 +1,7 @@ --- sidebar_label: ddn project init sidebar_position: 76 -description: - Configure the local directory to use a Hasura DDN project, creating a DDN project and subgraphs as necessary using the - DDN CLI +description: Configure the local directory to use a Hasura DDN project, creating a DDN project and subgraphs as necessary using the DDN CLI keywords: - hasura - DDN diff --git a/docs/reference/cli/commands/ddn_project_subgraph.mdx b/docs/reference/cli/commands/ddn_project_subgraph.mdx index 4a42fea6d..c558d8bc6 100644 --- a/docs/reference/cli/commands/ddn_project_subgraph.mdx +++ b/docs/reference/cli/commands/ddn_project_subgraph.mdx @@ -20,11 +20,9 @@ Manage Subgraphs in a Hasura DDN Project ## Available operations -- [ddn project subgraph create](/reference/cli/commands/ddn_project_subgraph_create) - Create a new Subgraph in a Hasura - DDN Project +- [ddn project subgraph create](/reference/cli/commands/ddn_project_subgraph_create) - Create a new Subgraph in a Hasura DDN Project - [ddn project subgraph delete](/reference/cli/commands/ddn_project_subgraph_delete) - Delete a Subgraph from a Project -- [ddn project subgraph get](/reference/cli/commands/ddn_project_subgraph_get) - List Subgraphs for a Hasura DDN Project - or get details of a specific one +- [ddn project subgraph get](/reference/cli/commands/ddn_project_subgraph_get) - List Subgraphs for a Hasura DDN Project or get details of a specific one ## Options diff --git a/docs/reference/cli/commands/ddn_relationship.mdx b/docs/reference/cli/commands/ddn_relationship.mdx index 506d8b88d..a8b5b6a45 100644 --- a/docs/reference/cli/commands/ddn_relationship.mdx +++ b/docs/reference/cli/commands/ddn_relationship.mdx @@ -22,10 +22,8 @@ Perform Relationship related operations ## Available operations -- [ddn relationship add](/reference/cli/commands/ddn_relationship_add) - Adds Relationships from foreign keys on - collection-name or targeting collection-name -- [ddn relationship list](/reference/cli/commands/ddn_relationship_list) - Lists Relationships for a given - DataConnectorLink +- [ddn relationship add](/reference/cli/commands/ddn_relationship_add) - Adds Relationships from foreign keys on collection-name or targeting collection-name +- [ddn relationship list](/reference/cli/commands/ddn_relationship_list) - Lists Relationships for a given DataConnectorLink ## Options diff --git a/docs/reference/cli/commands/ddn_subgraph_build.mdx b/docs/reference/cli/commands/ddn_subgraph_build.mdx index 238ea02b5..a3380938d 100644 --- a/docs/reference/cli/commands/ddn_subgraph_build.mdx +++ b/docs/reference/cli/commands/ddn_subgraph_build.mdx @@ -22,8 +22,7 @@ Perform SubgraphBuild related operations - [ddn subgraph build apply](/reference/cli/commands/ddn_subgraph_build_apply) - Apply a Subgraph build on Hasura DDN - [ddn subgraph build create](/reference/cli/commands/ddn_subgraph_build_create) - Create a SubgraphBuild on Hasura DDN -- [ddn subgraph build get](/reference/cli/commands/ddn_subgraph_build_get) - List SubgraphBuilds or get details of a - specific one +- [ddn subgraph build get](/reference/cli/commands/ddn_subgraph_build_get) - List SubgraphBuilds or get details of a specific one ## Options diff --git a/docs/reference/cli/commands/ddn_supergraph_build.mdx b/docs/reference/cli/commands/ddn_supergraph_build.mdx index b1287ec7e..c78bc887d 100644 --- a/docs/reference/cli/commands/ddn_supergraph_build.mdx +++ b/docs/reference/cli/commands/ddn_supergraph_build.mdx @@ -20,20 +20,13 @@ Perform SupergraphBuild related operations ## Available operations -- [ddn supergraph build apply](/reference/cli/commands/ddn_supergraph_build_apply) - Apply a SupergraphBuild to its - Project on Hasura DDN -- [ddn supergraph build create](/reference/cli/commands/ddn_supergraph_build_create) - Create a SupergraphBuild on - Hasura DDN -- [ddn supergraph build delete](/reference/cli/commands/ddn_supergraph_build_delete) - Delete a SupergraphBuild from a - Project -- [ddn supergraph build diff](/reference/cli/commands/ddn_supergraph_build_diff) - See changes made to the GraphQL - schema from one build version to another. -- [ddn supergraph build get](/reference/cli/commands/ddn_supergraph_build_get) - List SupergraphBuilds or get details of - a specific one -- [ddn supergraph build local](/reference/cli/commands/ddn_supergraph_build_local) - Build the Supergraph and generate - assets to run the local Engine -- [ddn supergraph build set-self-hosted-engine-url](/reference/cli/commands/ddn_supergraph_build_set-self-hosted-engine-url) - - Set the engine's URL for a build for a project in a self hosted data plane. +- [ddn supergraph build apply](/reference/cli/commands/ddn_supergraph_build_apply) - Apply a SupergraphBuild to its Project on Hasura DDN +- [ddn supergraph build create](/reference/cli/commands/ddn_supergraph_build_create) - Create a SupergraphBuild on Hasura DDN +- [ddn supergraph build delete](/reference/cli/commands/ddn_supergraph_build_delete) - Delete a SupergraphBuild from a Project +- [ddn supergraph build diff](/reference/cli/commands/ddn_supergraph_build_diff) - See changes made to the GraphQL schema from one build version to another. +- [ddn supergraph build get](/reference/cli/commands/ddn_supergraph_build_get) - List SupergraphBuilds or get details of a specific one +- [ddn supergraph build local](/reference/cli/commands/ddn_supergraph_build_local) - Build the Supergraph and generate assets to run the local Engine +- [ddn supergraph build set-self-hosted-engine-url](/reference/cli/commands/ddn_supergraph_build_set-self-hosted-engine-url) - Set the engine's URL for a build for a project in a self hosted data plane. ## Options