top of page
検索

kintone App Toolkit　～kintone アプリの構造情報をワンクリック出力できる Tampermonkey 用ツール～

  • 祐斗 河合
  • 10月9日
  • 読了時間: 3分

更新日：10月19日

ℹ️ 最新の機能更新はREADMEへこのページは概要の説明です。
　新機能・変更点・既知の注意事項は [README] に集約しています。
ree

主な機能

🩺 Health（ヘルスチェック）

アプリのフィールド数・状態数・アクション数などを自動解析。「多すぎて設計が重くなっていないか？」を一目で判定します。

ree

📋 Fields（フィールド一覧）

フォームの全フィールドを実際のレイアウト順で一覧化。さらに Markdown・CSV・JSON 形式で出力できます。

ree

導入方法（3分で完了）

1️⃣ Tampermonkey をブラウザに入れる

2️⃣ 以下のスクリプトURLを開いて「インストール」

3️⃣ kintone のアプリを開くと、右下に黒いパネルが出ます。

使い方イメージ

  • Healthタブ → アプリの構成サマリをチェック

  • Fieldsタブ → Markdownコピー → Notionやドキュメントへペースト→ そのまま仕様書やレビュー資料として活用できます。

本ツールは、特定案件のためだけではなく、
誰が・どの現場でも kintone 開発で自然と役立つ“共通道具”として設計しました。

・環境非依存：ユーザースクリプトなのでサーバ導入不要、権限範囲で安全に閲覧のみ。
・現状把握の定型化：アプリを開くだけでフィールド定義＋レイアウト順の一覧化。
・資料化の即戦力：Markdown → Notion/Confluence/社内Wikiへ即貼り。
・移行前後どちらでも効く：現行の棚卸し、移行設計の検証、運用後の棚卸し更新まで連続利用。

ライセンス

MIT License自由に使って、改変・再配布できます。ご利用時は GitHub のリンクを残していただけると嬉しいです。

背景

クライアント様から「kintone から Salesforce への移行を検討しているが、前任者が不在でドキュメントがない」という相談を受け、まずはフィールドの棚卸しから着手しました。

ところが、アプリは長年の拡張で巨大化。画面を見ながら手作業でnotionに転記していくやり方では、全体像が掴めず、抜け漏れのリスクが高い――そんな状況でした。

課題（移行検討中ゆえの制約）

  • いずれ Salesforce へ移行する可能性がある

  • だから kintone 側に大規模な調査システムを作り込むのは現実的ではない

  • でも、今すぐ仕様を可視化して合意形成しないと、移行要件が固められない

解決策（個別実行できるユーザースクリプト）

そこで選んだのが Tampermonkey のユーザースクリプト。

各担当者のブラウザで個別に実行でき、サーバ側に手を入れる必要がありません。kintone の REST API（GETのみ） を使ってフォーム定義とレイアウトを読み取り、ワンクリックでMarkdownの仕様表を出力します。

  • フォーム定義（/form/fields）：ラベル、コード、必須、初期値、型

  • レイアウト（/form/layout）：実際の配置順と グループ／サブテの所属

技術的なポイント

  • kintone REST API（form/fields + form/layout）で定義情報と配置情報を取得

  • レイアウト順にソートして実際の画面構成と一致

  • ルックアップ検知：SINGLE_LINE_TEXT + lookup設定 → LOOKUP として出力

  • GET専用：データは一切変更せず、閲覧権限に応じて情報を取得

さいごに

本ツールは “受託の最初の30分”を短縮する共通道具 を目指しています。使ってみて「ここが足りない」「この出力が欲しい」などあればぜひ教えてください。みんなの“最初の一歩”を速くするために、軽い改善を続けていきます。

コメント

bottom of page