Skip to content

docs(ja): use English CLI flag names in TiDB Cloud CLI docs #23050

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
qiancai merged 2 commits into from
Jun 12, 2026
Merged

docs(ja): use English CLI flag names in TiDB Cloud CLI docs #23050

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
a412b1c
docs(ja): use English CLI flag names in TiDB Cloud CLI docs
yahonda Jun 12, 2026
fe2ac2a
fix: add missing commas and argument types per gemini-code-assist review
yahonda Jun 12, 2026
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
2 changes: 1 addition & 1 deletion tidb-cloud/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@

| フラグ | 説明 | 必須 | 注記 |
| ------------------- | ----------------------------------- | --- | ---------------------------------------------------------- |
| --色なし | 出力における色の使用を無効にします。 | いいえ | 非対話モードでのみ動作します。対話モードでは、一部のUIコンポーネントで色の無効化が正しく機能しない場合があります。 |
| --no-color | 出力における色の使用を無効にします。 | いいえ | 非対話モードでのみ動作します。対話モードでは、一部のUIコンポーネントで色の無効化が正しく機能しない場合があります。 |

Check failure on line 119 in tidb-cloud/cli-reference.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/cli-reference.md", "range": {"start": {"line": 119, "column": 88}}}, "severity": "ERROR"}

Check failure on line 119 in tidb-cloud/cli-reference.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/cli-reference.md", "range": {"start": {"line": 119, "column": 47}}}, "severity": "ERROR"}
| -P、--profile string | このコマンドで使用されるアクティブなユーザープロファイルを指定します。 | いいえ | 非対話モードと対話モードの両方で動作します。 |
| -D、--debug | デバッグモードを有効にする | いいえ | 非対話モードと対話モードの両方で動作します。 |

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/ticloud-auth-login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@

| フラグ | 説明 | 必須 | 注記 |
| ------------ | --------------------------------- | --- | ------------------------ |
| --安全でないストレージ | 認証資格情報を資格情報ストアではなくプレーンテキストで保存します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| --insecure-storage | 認証資格情報を資格情報ストアではなくプレーンテキストで保存します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Check failure on line 34 in tidb-cloud/ticloud-auth-login.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-login.md", "range": {"start": {"line": 34, "column": 89}}}, "severity": "ERROR"}

Check failure on line 34 in tidb-cloud/ticloud-auth-login.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-login.md", "range": {"start": {"line": 34, "column": 56}}}, "severity": "ERROR"}
| -h, --help | このコマンドのヘルプ情報を表示します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

## 継承されたフラグ {#inherited-flags}

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |

Check failure on line 41 in tidb-cloud/ticloud-auth-login.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-login.md", "range": {"start": {"line": 41, "column": 129}}}, "severity": "ERROR"}

Check failure on line 41 in tidb-cloud/ticloud-auth-login.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-login.md", "range": {"start": {"line": 41, "column": 41}}}, "severity": "ERROR"}
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-auth-logout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |

Check failure on line 26 in tidb-cloud/ticloud-auth-logout.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-logout.md", "range": {"start": {"line": 26, "column": 129}}}, "severity": "ERROR"}

Check failure on line 26 in tidb-cloud/ticloud-auth-logout.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-logout.md", "range": {"start": {"line": 26, "column": 41}}}, "severity": "ERROR"}
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-auth-whoami.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |

Check failure on line 34 in tidb-cloud/ticloud-auth-whoami.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.

Raw Output:
{"message": "[PingCAP.ZhPunctuation] Don't use Chinese punctuation (。) in English text.", "location": {"path": "tidb-cloud/ticloud-auth-whoami.md", "range": {"start": {"line": 34, "column": 41}}}, "severity": "ERROR"}
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/ticloud-branch-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ ticloud serverless branch create --cluster-id <cluster-id> --display-name <branc
| ---------------------- | ------------------------------------------------------------------------- | --- | ----------------------- |
| -c, --cluster-id 文字列 | ブランチが作成されるクラスターの ID を指定します。 | はい | 非対話型モードでのみ動作します。 |
| -n, --display-name 文字列 | 作成するブランチの名前を指定します。 | はい | 非対話型モードでのみ動作します。 |
| --親ID文字列 | ブランチの親のIDを指定します。デフォルト値はクラスタIDです。 | いいえ | 非対話型モードでのみ動作します。 |
| --parent-id 文字列 | ブランチの親のIDを指定します。デフォルト値はクラスタIDです。 | いいえ | 非対話型モードでのみ動作します。 |
| --parent-timestamp 文字列 | 親ブランチのタイムスタンプをRFC3339形式（例： `2024-01-01T00:00:00Z` ）で指定します。デフォルト値は現在の時刻です。 | いいえ | 非対話型モードでのみ動作します。 |
| -h, --help | このコマンドのヘルプ情報を表示します。 | いいえ | 非対話型モードと対話型モードの両方で動作します |

## 継承されたフラグ {#inherited-flags}

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-branch-delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ ticloud branch delete --branch-id <branch-id> --cluster-id <cluster-id>

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-branch-describe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ticloud serverless branch describe --branch-id <branch-id> --cluster-id <cluster

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/ticloud-branch-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ ticloud serverless branch list <cluster-id> -o json
| -------------------- | --------------------------------------------------------------------------------- | --- | ------------------------ |
| -c, --cluster-id 文字列 | クラスターの ID を指定します。 | はい | 非対話型モードでのみ動作します。 |
| -h, --help | このコマンドのヘルプ情報を表示します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -o, --出力文字列 | 出力形式を指定します（デフォルトは`human` ）。有効な値は`human`または`json`です。完全な結果を得るには、 `json`形式を使用してください。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -o, --output | 出力形式を指定します（デフォルトは`human` ）。有効な値は`human`または`json`です。完全な結果を得るには、 `json`形式を使用してください。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

## 継承されたフラグ {#inherited-flags}

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/ticloud-branch-shell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ ticloud serverless branch shell -c <cluster-id> -b <branch-id> -u <user-name> --

| フラグ | 説明 | 必須 | 注記 |
| ----------------- | ------------------------------------------------------------------------------ | --- | ------------------------------------------------------- |
| --色なし | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| --no-color | 出力のカラーを無効にします。 | いいえ | 非対話モードでのみ機能します。対話モードでは、一部のUIコンポーネントで色の無効化が機能しない場合があります。 |
| -P, --profile 文字列 | このコマンドで使用するアクティブ[ユーザープロフィール](/tidb-cloud/cli-reference.md#user-profile)を指定します。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |
| -D, --debug | デバッグ モードを有効にします。 | いいえ | 非対話型モードと対話型モードの両方で動作します。 |

Expand Down
Loading
Loading