kintone / js-sdk-ja

kintone/js-sdk の日本語でのバグ報告、機能提案用リポジトリ
https://github.com/kintone/js-sdk
4 stars 0 forks source link

kintone コマンドラインツール ドキュメントのコマンドの表記ミス #35

Closed hirosassa closed 1 year ago

hirosassa commented 1 year ago

Target Package(対象パッケージ)

ドキュメントページ のコマンドの表記間違いについて

Current Behavior(現在の挙動)

Windowsユーザ向けの説明に、以下の表記があります。

cli-kintone.exe record export --base-url https://サブドメイン.cybozu.com --app アプリID \
  --api-token APIトークン

Windosコマンドプロンプトでは、バックスラッシュ(もしくは¥マーク)でのコマンド改行ができないので、そのまま入力すると誤動作を引き起こします。

誤動作の例

(c) Microsoft Corporation. All rights reserved.
C:\Windows\System32>cli-kintone.exe --version
1.2.0
C:\Windows\System32>cli-kintone.exe record export --base-url https://xxxx.cybozzu.com --app XXX \ --api-token TOKEN
cli-kintone.exe record export
export the records of the specified app
Options:
      --version              Show version number                       [boolean]
      --help                 Show help                                 [boolean]
      --base-url             Kintone Base Url
                                 [string] [required] [default: KINTONE_BASE_URL]
  -u, --username             Kintone Username
                                            [string] [default: KINTONE_USERNAME]
  -p, --password             Kintone Password
                                            [string] [default: KINTONE_PASSWORD]
      --api-token            App's API token[array] [default: KINTONE_API_TOKEN]
      --basic-auth-username  Kintone Basic Auth Username
                                 [string] [default: KINTONE_BASIC_AUTH_USERNAME]
      --basic-auth-password  Kintone Basic Auth Password
                                 [string] [default: KINTONE_BASIC_AUTH_PASSWORD]
      --app                  The ID of the app               [string] [required]
      --guest-space-id       The ID of guest space
                                      [string] [default: KINTONE_GUEST_SPACE_ID]
      --attachments-dir      Attachment file directory                  [string]
      --encoding             Character encoding
                                     [choices: "utf8", "sjis"] [default: "utf8"]
  -c, --condition            The query string                           [string]
      --order-by             The sort order as a query                  [string]
      --fields               The fields to be exported in comma-separated
                                                                        [string]
      --pfx-file-path        The path to client certificate file        [string]
      --pfx-file-password    The password of client certificate file    [string]
      --proxy                The URL of a proxy server
                                                 [string] [default: HTTPS_PROXY]
Unknown argument: \

Expected Behavior(期待する挙動)

さまざまなリテラシレベルの方が利用すると思いますので、以下のようにシンプルに一行で表記するのが良いかと思います。

cli-kintone.exe record export --base-url https://サブドメイン.cybozu.com --app アプリID --api-token APIトークン
tasshi-me commented 1 year ago

@hirosassa フィードバックありがとうございます! こちらドキュメントチームと対応検討中です。

tasshi-me commented 1 year ago

@hirosassa お待たせいたしました! こちら、コマンドプロンプトで正常に動作するハット(^)に修正いたしました。 https://cybozu.dev/ja/kintone/sdk/backup/cli-kintone/

(可読性の観点から改行は保持する方針となりました。)

hirosassa commented 1 year ago

@mshrtsr 確認できました!対応ありがとうございます!issue closeしておきます