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

Chore: Update CLI docs #1027

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.

Sign up for GitHub

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 2 commits into from
Jul 16, 2025
Merged

Chore: Update CLI docs #1027

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1afbb29
Updates CLI docs
dliub Jul 15, 2025
7dd6847
Merge branch 'main' into sync/cli-release-v3.2.0
robertjdominguez Jul 16, 2025
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
14 changes: 11 additions & 3 deletions docs/reference/cli/commands/ddn_auth_login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,22 @@ ddn auth login [flags]

# Login with Personal Access Token
ddn auth login --access-token <your-access-token>

# Login with OIDC ID Token
ddn auth login --oidc-id-token <your-id-token>

# Login with OIDC Access Token
ddn auth login --oidc-access-token <your-access-token>
```

## Options

```sass
--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)
--access-token string The Personal Access Token or Service Account Token [env: HASURA_DDN_ACCESS_TOKEN]
-h, --help help for login
--oidc-access-token string The OIDC Access Token [env: HASURA_DDN_OIDC_ACCESS_TOKEN]
--oidc-id-token string The OIDC ID Token [env: HASURA_DDN_OIDC_ID_TOKEN]
--pat string Personal Access token [env: HASURA_DDN_PAT] (DEPRECATED: use --access-token instead)
```

## Options inherited from parent operations
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_context_get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,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, noBuildConnectors) [flags]
ddn context get <key> (Allowed keys: noBuildConnectors, project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags]
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_context_set.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,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: noBuildConnectors, project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane) [flags]
ddn context set <key> <value> (Allowed keys: cloudEnvFile, selfHostedDataPlane, noBuildConnectors, project, supergraph, subgraph, localEnvFile) [flags]
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_context_unset.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,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: project, supergraph, subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane, noBuildConnectors) [flags]
ddn context unset <key> (Allowed keys: subgraph, localEnvFile, cloudEnvFile, selfHostedDataPlane, noBuildConnectors, project, supergraph) [flags]
```

## Examples
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_subgraph_init.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ddn subgraph init <subgraph-name> --dir <dir-name> [flags]
--graphql-root-field-prefix string Prefix to use while generating GraphQL root fields
--graphql-type-name-prefix string Prefix to use while generating GraphQL type names
-h, --help help for init
--subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case' or 'none'.
--subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case', 'snake_case_v2' or 'none'.
--target-supergraph stringArray Supergraph config file to add the Subgraph. Can be repeated to provide multiple Supergraph config files
```

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/commands/ddn_supergraph_init.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ddn supergraph init <path-to-project-dir> [flags]
--project-data-plane-id uuid The DDN instance where the Project should be hosted, only used with --create-project flag or --with-promptql flag
--project-name string Create a new project with this name, only used with --create-project flag or --with-promptql flag
--project-plan string DDN Project plan, only used with --create-project flag or --with-promptql flag
--subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case' or 'none'.
--subgraph-naming-convention string Naming convention for the subgraph. Can be 'graphql', 'snake_case', 'snake_case_v2' or 'none'.
--with-project string Use an existing project instead of creating a new one, only used with --create-project flag or --with-promptql flag
--with-promptql Initialize with PromptQL support, this also initializes a project with PromptQL enabled. (alpha)
```
Expand Down
Loading