カテゴリー内の他の記事

kintone コマンドラインツール

作成日2014年08月11日 13:33
更新日2021年10月08日 06:05

kintone コマンドラインツール

コマンドラインを使って、データのインポートとエクスポートができます。

動作OS

Windows
Linux
Mac OS X

Tool

License

GPL v2

Sample/Tips

kintone コマンドラインツールの使い方
定期実行でデータの同期を実現するスマートな方法
はじめようkintoneコマンドラインツールシリーズ（数回に分けてkintoneコマンドラインツールの使い方を詳しく解説しています）

更新履歴

2018/1/10 Version 0.9.0
- ユーザーエージェント名を修正
- 標準入力をインポートデータに指定できるようにする機能を追加
- CSVの読み込み開始行を指定できる機能を追加
- 100行以上のインポート処理でエラーメッセージが表示されない問題に対応し、
  インポート処理で100行毎に結果を出力するよう修正
- Basic認証のロジックを修正
2018/4/12 Version 0.9.1
- ゲストスペース内のアプリに対して下記のコマンドを使用するとインポートに失敗するバグを修正
  cli-kintone.exe -d {ドメイン名} -a xx -g xx -t {APIトークン} -f {ファイルパス}
2018/5/15 Version 0.9.2
- 3rd party libraryのバージョンを最新版ではなく、バージョン指定してリリースするように変更
2019/2/27 Version 0.9.3
- Shift-JISでエクスポートした場合、エクスポートされたファイルのフィールドに
  UTF-8からShift-JISに変換できない文字が含まれていると、フィールドの値が移動するバグを修正
2019/4/2 Version 0.9.4
- 特殊な文字コードを持つ文字列に関する不具合を修正
2019/11/26 Version 0.10.0
- Go のバージョンを 1.9.3 から 1.13.3 に更新
- -v または--version を使用してツールのバージョンを取得できるように更新
2019/11/28 Version 0.10.1
- エクスポートするレコードがない場合のメッセージを変更
2020/02/12 Version 0.10.2
- データの取得方法を以下のように変更
  - -q オプションを指定した際、クエリに「limit」または「offset」が含まれない場合にカーソル API を実行するように変更
  - クエリに「limit」または「offset」が含まれている場合にレコード一括取得 API を実行するように変更
- ユーザーエージェント名を下記フォーマットに変更
  cli-kintone/{{バージョン}}(OS 情報)
- Mac OS X/Linux と Windows でのビルドやデータ操作方法の説明を README にて更新
2020/03/31 Version 0.11.0
- 以下のエンコーディング方式に対応
  - GBK（簡体字）
  - Big5（繁体字）を追加
  - UTF-8（BOM 付き）ファイルのインポートに対応
- Go のバージョンを 1.13.3から 1.13.7 に更新
2020/12/07 Version 0.11.3
- Go のバージョンを 1.13.7 から 1.15.5 に更新
- レコードの添付ファイルを削除できる機能を追加

注意事項

ソースコードの変更および再配布、商用利用等はライセンスに従ってご利用可能です。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

佐藤 2019年08月29日 02:22

こちら、ライトコースのライセンスでも使える機能でしょうか？

cybozu Development team 2019年08月29日 03:38

佐藤様

お世話になっております。
cybozu developer network 運営局です。

内部的に kintone API（kintone REST API）を利用しているため、スタンダードライセンスが必要となります。

よろしくお願いいたします。

matsu 2020年05月29日 08:52

cli-kintoneを使用していますが、アプリが0件の場合は出力できないのでしょうか？

古いバージョンで使用していた際は空ファイルで出力されましたが、最新ではエラーとなりました。

cybozu Development team 2020年05月31日 23:39

matsu 様

お世話になっております。cybozu developer network 運営局です。

はい、v0.10.1 以降のバージョンでは、レコードが0件のアプリはエラーとなり出力できません。

よろしくお願いいたします。

てん 2020年07月07日 23:13

平素よりお世話になっております。

＞CSVファイルにエクスポート　において、カンマ区切りではなく、タブ区切りで出力したいのですが、どのようにすれば可能でしょうか？

cybozu Development team 2020年07月08日 08:25

てん様

お世話になっております。cybozu developer network 運営局です。

リファレンス（外部サイト：英語）に記載があるオプションのみ利用可能ですので、出力できる形式は現時点ではjsonかcsvのみです。

Excelなどの別ツールを用いることでcli-kintoneで出力したCSV（コンマ区切り）をTSV（タブ区切り）に変換することは可能だと思いますので、具体的な方法は外部の情報を参考にしてください。

てん 2020年07月08日 08:50

cybozu developer network 運営局ご担当者様

ご丁寧にご教示ありがとうございました。助かりました。

今後とも何卒宜しく願い致します。

てんにより編集されました 2020年07月08日 08:50

佐々木 2021年03月18日 02:09

ご紹介頂いている「cli-kintone」というツールを、弊社内でダウンロードしたのですが、

弊社セキュリティソフト（SymantecEndpointProtection）にて、危険なソフトとして検疫されました。

「ファイルを許可」すれば使用できるのですが、社内で使用する上で、セキュリティ的に問題はありませんか？

ご確認、お願いいたします。

cybozu Development team 2021年03月18日 05:14

佐々木様

お世話になっております。
cybozu developer network 運営局です。

cli-kintone はアプリのレコード情報をインポートしたりエクスポートしたりするツールで、現時点でそれ以上のことは行っておりません。

オープンソースソフトウェアとして公開されているツールのため、自己責任の元でご利用ください。

佐々木 2021年03月18日 05:38

cybozu developer network 運営局様

早急なご回答、ありがとうございます。

個人的に使うなら気にしないのですが、会社で使うとなると、

セキュリティリスクが気になるところです。

社内で協議して使用確認してみます。

kita 2021年04月07日 02:40

cybozu developer network 運営局ご担当者様

本ツールは、アップロードできるファイルサイズの上限は10MBまでの

制限がございますが、ソースコードを改変し、この制約を

取っ払うことを検討しています。

ソースコードを改変して制約を取っ払ったとき、アップロードに時間が掛かる以外に

どのような影響がございますでしょうか。

cybozu Development team 2021年04月12日 01:44

kita 様

お世話になっております。cybozu developer network 事務局です。

「アップロードできるファイルサイズの上限の 10MB」は、
アップロードできる添付ファイルの 1 ファイルあたりのファイルサイズとなっております。
この制限は、サムネイルを表示できる画像サイズの上限に基づいているので、
この制限を取り除いたとすると 10 MB 以上の画像は
サムネイルが表示されなくなる可能性があります。

また、前提といたしまして、cli-kintone の上限は、kintone REST API において
具体的に設定されている制限を参考にしていただければと思います。
参考 https://jp.cybozu.help/k/ja/admin/limitation/limit.html#limitation_limit_30

また、大量のレコードを登録する場合は、kintone のパフォーマンスに影響を与える可能性があります。
何かエラーが発生した場合は、CSV を分割するなど適宜対応していただければと存じます。

cybozu Development teamにより編集されました 2021年04月12日 01:44

kita 2021年04月12日 04:33

cybozu developer network 事務局様

ご丁寧な回答、ありがとうございます。

1ファイル10Mの制限は、サムネイルを表示できる画像サイズの上限に基づいている旨、承知しました。

また、パフォーマンスについてのご指摘ありがとうございます。

諸々参考にツールを改造させて頂きます。

吉田 2021年07月07日 08:12

cybozu developer network 運営局ご担当者様

下記のコマンドでエラーになります。

※proxyはシステム環境変数に設定済　set https_proxy="https://***:***"

対処方法をご教授下さい。

＜コマンド＞

cli-kintone.exe --export -a *** -d *** -t ***

＜エラーメッセージ＞

Get "https://***.cybozu.com/k/v1/form.json": proxyconnect tcp: tls: first record does not look like a TLS handshake

吉田により編集されました 2021年07月08日 01:10

cybozu Development team 2021年07月19日 04:55

吉田様

お世話になっております。cybozu developer network運営事務局です。

お問い合わせいただきましたエラーについて、確認いたしましたが弊社で再現ができておりません。

プロキシの設定によるものと思われますので、恐れ入りますが御社内のIT部門へお問い合わせいただけますでしょうか。

お力になれず申し訳ございません。

青柳 2021年10月13日 04:07

cli-kintoneにてEXPORTをしてみたのですが10,000件を超えないようにというメッセージが出ました
-q にて、limit と offset 指定すればいいことまでは分かったのですがなかなかうまくいきません
具体的記述を教えてください

-q "limit 10000 offset 1"　では駄目でした

cybozu Development team 2021年10月15日 06:20

青柳様

お世話になっております。cybozu developer network運営事務局です。
こちらの影響により、エラーとなっているとお見受けします。
以下をお試しください。

- Version 0.10.2以上にcli-kintoneをアップデートする
更新履歴はこちら
- -qオプションを利用し、かつ、クエリに「limit」または「offset」が含まれないようにする

koki.fb 2022年03月23日 06:58

バッチ起動用のプログラム内でCli-kintoneを実行しようと考えております。

このバッチ内で利用するkintoneユーザー／パスワードについてですが、バッチ起動専用のライセンスを用意する必要がありますでしょうか？

それとも、管理者ユーザーなどのアカウントを流用してもよいのでしょうか？

cybozu Development team 2022年03月28日 00:07

koki.fb様

お世話になっております。cybozu developer network 運営でございます。

APIトークンを利用すれば細かいアクセス制御もできますし、アカウントの追加も不要ですので最もおすすめです。
もちろんバッチ用のユーザーを追加（ライセンスを追加）する方法もございます。
Administratorに関してはこちらの事項をお読みください。

また、恐れ入りますが、こちらのコメント欄は記事内容のフィードバック目的となっているため、
記事から派生した技術的なご質問はcybozu developer コミュニティをご活用ください。

よろしくお願い致します。

サインインしてコメントを残してください。