这是indexloc提供的服务,不要输入任何密码
Skip to content

Chore: Update CLI docs #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn
sidebar_position: 1
description: DDN Command Line Interface using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn"
keywords:
- hasura
- DDN
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn_auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth
sidebar_position: 2
description: Manage Hasura DDN CLI Auth using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth generate-promptql-secret-key
sidebar_position: 3
description: Generates the project's PromptQL secret key and saves to global config using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth_generate-promptql-secret-key"
keywords:
- hasura
- DDN
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn_auth_login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth login
sidebar_position: 4
description: Login to DDN using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth_login"
keywords:
- hasura
- DDN
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn_auth_logout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth logout
sidebar_position: 5
description: Logout from DDN using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth_logout"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth print-access-token
sidebar_position: 6
description: Prints the access token to STDOUT using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth_print-access-token"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn auth print-promptql-secret-key
sidebar_position: 7
description: Prints the project's PromptQL secret key to STDOUT using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_auth_print-promptql-secret-key"
keywords:
- hasura
- DDN
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/commands/ddn_codemod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn codemod
sidebar_position: 8
description: Perform transformations on your Hasura project directory using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
sidebar_label: ddn codemod configure-header-forwarding
sidebar_position: 9
description: Configure headers to be forwarded to your connector using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_configure-header-forwarding"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod fix-traces-env-var
sidebar_position: 11
sidebar_position: 10
description: Fix env var used for configuring traces for connectors using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_fix-traces-env-var"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod rename-graphql-prefixes
sidebar_position: 12
sidebar_position: 11
description: Rename GraphQL root field and type name prefixes in metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_rename-graphql-prefixes"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-auth-config-to-v3
sidebar_position: 13
sidebar_position: 12
description: Upgrade AuthConfig version from "v1"/"v2" to "v3" using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-auth-config-to-v3"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-context-v2-to-v3
sidebar_position: 14
sidebar_position: 13
description: Upgrade project's context config from v2 to v3 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-context-v2-to-v3"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-graphqlconfig-aggregate
sidebar_position: 15
sidebar_position: 14
description: Upgrade GraphqlConfig to support aggregates using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-aggregate"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-graphqlconfig-subscriptions
sidebar_position: 16
sidebar_position: 15
description: Upgrade GraphqlConfig to support subscriptions using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-graphqlconfig-subscriptions"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-model-v1-to-v2
sidebar_position: 17
sidebar_position: 16
description: Upgrade model from "version" "v1" to "v2" in metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-model-v1-to-v2"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-object-boolean-expression-types
sidebar_position: 18
sidebar_position: 17
description: Upgrade object boolean expression types metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-object-boolean-expression-types"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-project-config-v2-to-v3
sidebar_position: 19
sidebar_position: 18
description: Upgrade project directory from version v2 to v3 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-project-config-v2-to-v3"
keywords:
- hasura
- DDN
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn codemod upgrade-supergraph-config-v1-to-v2
sidebar_position: 20
sidebar_position: 19
description: Upgrade all Supergraph config files at the root of the project directory from v1 to v2 using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_codemod_upgrade-supergraph-config-v1-to-v2"
keywords:
- hasura
- DDN
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_command.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command
sidebar_position: 21
sidebar_position: 20
description: Perform Command-related operations using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command"
keywords:
- hasura
- DDN
Expand Down
18 changes: 10 additions & 8 deletions docs/reference/cli/commands/ddn_command_add.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command add
sidebar_position: 22
sidebar_position: 21
description: Add new Commands to the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_add"
keywords:
- hasura
- DDN
Expand Down Expand Up @@ -29,10 +30,10 @@ ddn command add <connector-link-name> <procedure/function-name> [flags]
ddn command add myfns "*"

# Add a new Command "Login" from the procedure "Login" in the DataConnectorLink "myfns" in "app" Subgraph
ddn command add myfns Login --subgraph ./app/subgraph.yaml
ddn command add myfns Login --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Add all the Commands from the procedures/functions in the DataConnectorLink "myfns" in "app" Subgraph
ddn command add myfns "*" --subgraph ./app/subgraph.yaml
ddn command add myfns "*" --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Add Commands filtered by glob pattern from the procedures/functions in the DataConnectorLink "myfns" in "app" Subgraph
ddn command add myfns "user*" --subgraph ./app/subgraph.yaml
Expand All @@ -41,11 +42,12 @@ ddn command add <connector-link-name> <procedure/function-name> [flags]
## Options

```sass
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for add
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for add
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--supergraph string Path to Supergraph config file
```

## Options inherited from parent operations
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_command_list.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command list
sidebar_position: 23
sidebar_position: 22
description: Lists details about the functions/procedures of DataConnectorLink, and their corresponding Commands using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_list"
keywords:
- hasura
- DDN
Expand Down
20 changes: 11 additions & 9 deletions docs/reference/cli/commands/ddn_command_remove.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command remove
sidebar_position: 24
sidebar_position: 23
description: Removes Commands (and related metadata) in the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_remove"
keywords:
- hasura
- DDN
Expand Down Expand Up @@ -29,23 +30,24 @@ ddn command remove <command-name> [flags]
ddn command remove "*"

# Remove the Command "Album" in the "app" Subgraph
ddn command remove Album --subgraph ./app/subgraph.yaml
ddn command remove Album --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Remove all the Commands in the Subgraph "app"
ddn command remove "*" --subgraph ./app/subgraph.yaml
ddn command remove "*" --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Remove Command filtered by glob pattern in the Subgraph "app"
ddn command remove "user*" --subgraph ./app/subgraph.yaml
ddn command remove "user*" --subgraph ./app/subgraph.yaml --supergraph ./supergraph.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 remove
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for remove
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--supergraph string Path to Supergraph config file
```

## Options inherited from parent operations
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_command_show.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command show
sidebar_position: 25
sidebar_position: 24
description: Show diff between the command and its corresponding ndc function/procedure using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_show"
keywords:
- hasura
- DDN
Expand Down
20 changes: 11 additions & 9 deletions docs/reference/cli/commands/ddn_command_update.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn command update
sidebar_position: 26
sidebar_position: 25
description: Update Commands in the local metadata using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_command_update"
keywords:
- hasura
- DDN
Expand Down Expand Up @@ -29,23 +30,24 @@ ddn command update <command-name> [flags]
ddn command update "*"

# Update the Command "Login" in the "app" Subgraph
ddn command update Login --subgraph ./app/subgraph.yaml
ddn command update Login --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Update all the Commands in "app" Subgraph
ddn command update "*" --subgraph ./app/subgraph.yaml
ddn command update "*" --subgraph ./app/subgraph.yaml --supergraph ./supergraph.yaml

# Update Commands filtered by glob pattern in the Subgraph "app"
ddn command update "user*" --subgraph ./app/subgraph.yaml
ddn command update "user*" --subgraph ./app/subgraph.yaml --supergraph ./supergraph.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 update
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for update
--pattern string Pattern to detect targets. Can be 'glob' or 'literal'. (default "glob")
--subgraph string Path to Subgraph config file
--supergraph string Path to Supergraph config file
```

## Options inherited from parent operations
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_connector-link.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn connector-link
sidebar_position: 43
sidebar_position: 42
description: Perform DataConnectorLink related operations using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_connector-link"
keywords:
- hasura
- DDN
Expand Down
14 changes: 8 additions & 6 deletions docs/reference/cli/commands/ddn_connector-link_add-resources.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn connector-link add-resources
sidebar_position: 45
sidebar_position: 44
description: Add all models, commands and relationships from a DataConnectorLink's schema using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_connector-link_add-resources"
keywords:
- hasura
- DDN
Expand All @@ -26,16 +27,17 @@ ddn connector-link add-resources <connector-link-name> [flags]

```bash
# Add all models, commands and relationships from the schema of DataConnectorLink 'mydb' for Subgraph config 'app'
ddn connector-link add-resources mydb --subgraph ./app/subgraph.yaml
ddn connector-link add-resources mydb --subgraph ./app/subgraph.yaml --supergraph ./supergraph.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 add-resources
--subgraph string Path to Subgraph config file
--ci Disables the use of context
-c, --context string Name of the context to use. (default <current_context>)
-h, --help help for add-resources
--subgraph string Path to Subgraph config file
--supergraph string Path to Supergraph config file
```

## Options inherited from parent operations
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_connector-link_add.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn connector-link add
sidebar_position: 44
sidebar_position: 43
description: Add a new DataConnectorLink to a Subgraph using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_connector-link_add"
keywords:
- hasura
- DDN
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/commands/ddn_connector-link_remove.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_label: ddn connector-link remove
sidebar_position: 46
sidebar_position: 45
description: Remove a DataConnectorLink from a Subgraph using the DDN CLI
canonicalUrl: "https://promptql.io/docs/reference/cli/commands/ddn_connector-link_remove"
keywords:
- hasura
- DDN
Expand Down
Loading
Loading