🎍お正月といえば...くりきんとん。cli-kintoneをつかってみた！🌰

2023年1月5日 10:06

cli-kintoneという名前を聞いたことがあり、
ずーっと
くりきんとんに似ていて美味しそうと思ってました。
これが何なのかはＣＤＮ※を見て初めてわかりました。
せっかくなのでちょっと触ってみようと思います！

※CDN
cybozu developer network：kintoneをカスタマイズ（JavaScriptとかAPIとか）するための色んな情報を提供しているサイト
今回、こちらの記事を参考にします。
　↓　↓　↓
kintone コマンドラインツール（cli-kintone）https://developer.cybozu.io/hc/ja/articles/10663181361689

cli-kintone とは

cli-kintone とは
kintone コマンドラインツール（cli-kintone）は、コマンドで kintone のレコード情報を入出力できるツールです。
コマンドラインツールとして提供されているため、シェルスクリプトファイルから呼び出して実行できます。

レコード情報の入出力だけでなく、kintone の画面からレコードを一括登録・更新する機能ではできない、次の操作もできます。

一括でレコードの添付ファイルをダウンロードする。
一括で添付ファイルをレコードに添付する。

kintone コマンドラインツール（cli-kintone）より

コマンドラインとか、むずかしいことはわかりませんが、
kintoneの標準機能でできないことができるようです。
そういえば、プラグインやカスタマイズを使うと、アプリ間のデータ操作だったり、画像一括登録とか標準機能でできないことができるようになります。
なぜだろうと疑問だったのですが、これらはWeb上で操る・他データベースやローカル環境のデータを何とかするのを可能にするプログラムなんですね。

アプリのデータの入出力
データの入出力には、CSV形式のファイルを使用します。
https://jp.cybozu.help/k/ja/id/04056.html#appdata
※添付ファイルは標準機能では、見事に入力出力できません。

kintoneヘルプ

そして今回、目を付けたのは「一括で添付ファイルをレコードに添付する」機能。やってみたいー！

「シェルスクリプトを組めば作業が自動化できるのじゃ、さぼれるのじゃ！」と師匠も言っていたとおり、使いこなせば便利になるらしいです。

※シェルスクリプトについてメモメモ

シェルスクリプト (英語: shell script) は主にオペレーティングシステムのシェルまたはコマンドラインインタプリタから実行可能なコマンドの一連の流れをファイルにして再利用できるようにしたものである。狭義では、Unixシェルで用いられるスクリプト言語を指す。シェルスクリプトは他のコマンドを組み合わせるためのグルー型のドメイン固有言語とみなされることもある。シェルスクリプトで書かれる典型的処理としては、ファイル操作、プログラム実行、テキストの印刷などがある。

シェルスクリプト用インタプリタの多くはコマンドラインインタフェースも兼ねており、各種Unixシェル、Windows PowerShell、MS-DOSのCOMMAND.COMなどがある。他にAppleScriptやグラフィカルな Windows Script Host (WScript.exe) などもあり、コマンドラインインタフェース抜きでコンピューティング環境にスクリプト機能を加えている。

シェル (英語: shell) はオペレーティングシステム（OS）があるような高機能なコンピュータにおいて、ユーザーのためにインタフェースを提供するコンピュータプログラムであり、オペレーティングシステムが提供する機能へのアクセスを提供する。他にも、この用語はゆるやかに応用されることもあり、特定のコンポーネントの周辺に構築された任意のソフトウェアを含むこともある。例えば、ウェブブラウザや電子メールクライアントはHTMLレンダリングエンジンの「シェル」といわれることがある。コンピュータシステムとユーザーの間にある「殻」であることから、このように呼ばれる。
ｰｰｰｰｰｰｰｰｰｰｰｰｰｰｰｰ
⇒ひらたくいうと
シェル（OS）の動作を便利にまとめたものがシェルスクリプトみたい。

Wikipediaより

それから真面目に覚えるなら見ておきたいこちらの記事。コマンドラインやらをちゃんと説明してくれてます。はっきり言って超わかりやすい！
　↓　↓　↓

cli-kintoneの準備

ではCDNの手順に従ってcli-kintoneを入れてみましょう。
※Windowsの手順です。
◆１・まずはGitHubから入手

◆２・ファイルを解凍
実行ファイルが現れた！（マイクラブロックみたい）

◆３・コマンドプロンプトを起動
バージョン確認！1.2.0が現れた！

Minecraft辞典をつくるぞー！

「一括で添付ファイルをレコードに添付する」
これで、Minecraft辞典が作れるー
全アイテム（全1595種類？）いちいちレコードを作るの大変。
レコード一括登録/更新はCSVでできるものの、画像をどうする？というのが悩みでした。
（ほんとうは、cli-kintone 使ってみたい⇒マイクラの画像を登録してみよう！の流れで、実際には悩んではいない）

🌰◆材料：以前入手した画像があるので、それを使います。
※これは新キャラのモブなどですが練習として使用

🌰◆アップロードするアプリ：
”Minecraft 辞典”というアプリを作成
・名前を入れる文字列１行フィールド
・添付ファイルフィールド
※今回は最低限のフィールドのみです。いずれはブロックコードだったり属性だったりいろんな入力フィールドを入れてもいいですね。

ではやってみましょう！

前述のCDNの「添付ファイルをアップロードする」をやっていきます。
https://developer.cybozu.io/hc/ja/articles/10663181361689

🌰◆１・添付ファイルの場所
”GIFStickers”という名前のフォルダに画像があります。
これをこういった配置で入れておきます。

添付ファイルをアップロードしてレコードに添付するには、
--attachments-dir オプションにアップロードするファイルを配置したディレクトリーを指定します。
ディレクトリー名は、実行している場所からの相対パスです。

ｰｰｰｰｰｰｰｰｰｰｰｰ
🌰今回はこんな感じです
cli-kintone-win 　 ⇐cli-kintone.exe があるディレクトリー
└── GIFStickers　⇐画像が入っているフォルダ
├── Alex.gif
├── Allay.gif
└── Character-boat.gif　…
ｰｰｰｰｰｰｰｰｰｰｰｰ
そ、相対パス…?※
参照したいファイルが同一階層、同一フォルダにある場合
--file-path ./example.csv 　⇐どうやらこれは、同一階層同一フォルダを表すようです

🌰◆２・CSVファイルの作成
画像だけ用意すれば添付できると思ってたのですが、フィールドを指定しないと無理ですね。そのためにＣＳＶファイルを作成します。
「なまえ」と「添付ファイル」フィールドを用意しました。
それぞれ、名前とファイル名を入れます。※一行目はフィールドコード

ところで画像ファイルの名前をどうやって登録したか？
ひとつひとつコピペしてCSVデータに入力していったら、余計な手間に。
何のための自動化か元も子もありません。
「ぶわっかもーん」と師匠に怒られます。
これもコマンドプロンプトで操作することで解決！

今回使ったコマンド
dir /b /a-d | clip
dir　⇐ファイルの一覧を表示させる
/b　⇐ファイル名だけを表示させる
/a-d　⇐ディレクトリを除く
| clip　⇐クリップボードにコピーする
ファイル名一覧をゲット！そのままCSVファイルに添付できる！

※参考：Windowsコマンド虎の巻
https://windows.command-ref.com/cmd-dir.html

🌰◆３・レコードを追加する

レコードを追加または更新するには、record importを指定します。
また、次のオプションに、操作する kintone のドメイン名とアプリ ID を指定します。
●--base-url：操作する kintone のドメイン名（例：https://sample.cybozu.com）
●--app：アプリ ID（例：123）

●--file-path：追加するレコードの情報を記載した CSV ファイルのパス
ｰｰｰｰｰｰｰｰｰｰｰｰ
🌰今回はこんな感じです
cli-kintone.exe record import
--base-url https://×××.cybozu.com
--app 21 \
--api-token ××× \
--file-path ./minecraftappname.csv \
--attachments-dir ./GIFStickers

しかし。
じつは何度もエラーに…原因はこのようなことがありました。
・そもそもダウンロードするファイルを間違えていた
（WindowsなのにLinux）
・APIトークンをいれずに実行
・” \”を付けたところエラー
（これは改行のためにつけているものなので、今回は不要とのこと）
・単なるスペルミス

そんなこんなで想定より３倍の時間がかかったわけですが、
なんだか動きそう…
そして
Successfullyの文字が！

アプリを更新してみると…

画像と名前のデータが登録されました！！！
すごいぞ、くりきんとん！！

ん？アレックスだけ画像が表示されていないのは…

kintoneヘルプにある、あれですね。
画像のサムネイルの仕様です。
確かにアレックスだけ10MB超えている。知っててよかった！

画像のファイルサイズが10MBを超える場合は、サムネイルの設定に関わらず、ファイル名が表示されます。サムネイルは表示されません。
https://jp.cybozu.help/k/ja/user/app_settings/app_othersettings/set_thumbnail.html

kintoneヘルプ

いずれはMinecraftWikiにある全アイテムのレコードを登録したいな！？

以上。”初心者が調べながらやってみた”　ため、かなり時間がかかってしまいましたが、コツがわかればすらすらできそうです。
これからも、機会があればcli-kintoneを使ってみたいと思います！

この記事が気に入ったらサポートをしてみませんか？