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 に更新
- レコードの添付ファイルを削除できる機能を追加
注意事項
ソースコードの変更および再配布、商用利用等はライセンスに従ってご利用可能です。
こちら、ライトコースのライセンスでも使える機能でしょうか?
佐藤様
お世話になっております。
cybozu developer network 運営局です。
内部的に kintone API(kintone REST API)を利用しているため、スタンダードライセンスが必要となります。
よろしくお願いいたします。
cli-kintoneを使用していますが、アプリが0件の場合は出力できないのでしょうか?
古いバージョンで使用していた際は空ファイルで出力されましたが、最新ではエラーとなりました。
matsu 様
お世話になっております。cybozu developer network 運営局です。
はい、v0.10.1 以降のバージョンでは、レコードが0件のアプリはエラーとなり出力できません。
よろしくお願いいたします。
平素よりお世話になっております。
>CSVファイルにエクスポート において、カンマ区切りではなく、タブ区切りで出力したいのですが、どのようにすれば可能でしょうか?
お世話になっております。cybozu developer network 運営局です。
cybozu developer network 運営局 ご担当者様
ご丁寧にご教示ありがとうございました。助かりました。
今後とも何卒宜しく願い致します。
ご紹介頂いている「cli-kintone」というツールを、弊社内でダウンロードしたのですが、
弊社セキュリティソフト(SymantecEndpointProtection)にて、危険なソフトとして検疫されました。
「ファイルを許可」すれば使用できるのですが、社内で使用する上で、セキュリティ的に問題はありませんか?
ご確認、お願いいたします。
佐々木様
お世話になっております。
cybozu developer network 運営局です。
cli-kintone はアプリのレコード情報をインポートしたりエクスポートしたりするツールで、現時点でそれ以上のことは行っておりません。
オープンソースソフトウェアとして公開されているツールのため、自己責任の元でご利用ください。
cybozu developer network 運営局様
早急なご回答、ありがとうございます。
個人的に使うなら気にしないのですが、会社で使うとなると、
セキュリティリスクが気になるところです。
社内で協議して使用確認してみます。
cybozu developer network 運営局 ご担当者様
本ツールは、アップロードできるファイルサイズの上限は10MBまでの
制限がございますが、ソースコードを改変し、この制約を
取っ払うことを検討しています。
ソースコードを改変して制約を取っ払ったとき、アップロードに時間が掛かる以外に
どのような影響がございますでしょうか。
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 developer network 事務局様
ご丁寧な回答、ありがとうございます。
1ファイル10Mの制限は、サムネイルを表示できる画像サイズの上限に基づいている旨、承知しました。
また、パフォーマンスについてのご指摘ありがとうございます。
諸々参考にツールを改造させて頂きます。
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
吉田様
お世話になっております。cybozu developer network運営事務局です。
お問い合わせいただきましたエラーについて、確認いたしましたが弊社で再現ができておりません。
プロキシの設定によるものと思われますので、恐れ入りますが御社内のIT部門へお問い合わせいただけますでしょうか。
お力になれず申し訳ございません。
cli-kintoneにてEXPORTをしてみたのですが10,000件を超えないようにというメッセージが出ました
-q にて、limit と offset 指定すればいいことまでは分かったのですがなかなかうまくいきません
具体的記述を教えてください
-q "limit 10000 offset 1" では駄目でした
青柳 様
お世話になっております。cybozu developer network運営事務局です。
こちらの影響により、エラーとなっているとお見受けします。
以下をお試しください。
- Version 0.10.2以上にcli-kintoneをアップデートする
更新履歴はこちら
- -qオプションを利用し、かつ、クエリに「limit」または「offset」が含まれないようにする
バッチ起動用のプログラム内でCli-kintoneを実行しようと考えております。
このバッチ内で利用するkintoneユーザー/パスワードについてですが、バッチ起動専用のライセンスを用意する必要がありますでしょうか?
それとも、管理者ユーザーなどのアカウントを流用してもよいのでしょうか?
koki.fb様
お世話になっております。cybozu developer network 運営でございます。
APIトークンを利用すれば細かいアクセス制御もできますし、アカウントの追加も不要ですので最もおすすめです。
もちろんバッチ用のユーザーを追加(ライセンスを追加)する方法もございます。
Administratorに関してはこちらの事項をお読みください。
また、恐れ入りますが、こちらのコメント欄は記事内容のフィードバック目的となっているため、
記事から派生した技術的なご質問はcybozu developer コミュニティをご活用ください。
よろしくお願い致します。
cybozu developer network 運営局 ご担当者様
cli-kintoneを用いて、毎週月曜未明にバッチ起動でゲストスペースと同期をしています。
運用を開始して約半年が経ち、これまでは2万件超がCSVとして出力~同期できていましたが、今週分に限ってはSelectでちょうど500件(本来は20,717件)しか取得できていませんでした。
調査の段階で手動でcli-kintoneを実行しても同じくちょうど500件。cli-kintoneのバージョンは 0.12.0 、queryにはoffset、limit等指定していません。
ちょうど5月分までは毎週正常終了で、今回の事象が6月分開始直後のことでしたので、何かしら仕様変更があったのかも調べてみましたが見つからず。
何かお分かりになりますでしょうか?
実行文も掲載しておきます。不足情報ございましたらお知らせください。
\\xxx\cli-kintone.exe --export -a 999 -d abc -u kintone -p pass -e sjis -q "更新日時 >= LAST_WEEK(SUNDAY) and 更新日時 < THIS_WEEK(SUNDAY) and 作成日時 < LAST_WEEK(SUNDAY)" -c "abc","xyz" > xxx.csv
JohnnyBep 様
お世話になっております。cybozu developer network 運営でございます。
直近ではkintoneのリリースもないためkintone側の仕様変更は特にないはずではあります。
下記を確認してみていただけますでしょうか。
1. cli-kintone実行ユーザーの権限が十分である
権限設定が変わって特定のレコードしか取得できない、というようなことがありえます
2. 最新バージョンのcli-kintoneで試していただく
何か特定の不具合が起きている可能性があるため、念の為最新バージョンで試してみるのを推奨します。(最新バージョンのv0.13.1はこちらから)
よろしくお願い致します。