メインコンテンツまでスキップ
提供版: β版

Kuroco Skills リファレンス

このページでは、Kuroco Skills に含まれる 5 つのスキルについて詳しく説明します。

kuroco-docs - ドキュメント検索​

Kuroco 公式ドキュメントの検索・参照を支援するスキルです。

機能​

  • プラグインに同梱された公式ドキュメントの横断検索
  • 目的別クイックリファレンス（API、認証、フロントエンド、コンテンツ管理など）

使用例​

「Kuroco のエンドポイント設定方法を知りたい」
「ログイン API の仕様を調べたい」
「フィルタークエリの書き方を教えて」

同梱ドキュメントの構成​

ディレクトリ内容
tutorials/機能の使い方、実装手順、サンプルコード
reference/API 設定項目、Smarty プラグイン、フィルタークエリ
management/管理画面の各機能の詳細説明
faq/よくある質問と回答
about/Kuroco の概要、料金プラン、制限事項、用語集
troubleshooting/エラー解決、問題診断ガイド
information/お知らせ、リリース情報
update/アップデート情報

kuroco-api-content - API 連携 & コンテンツ管理​

Kuroco API の設計・実装およびコンテンツ管理（CRUD 操作）に関するベストプラクティスを提供するスキルです。 旧 kuroco-api-integration と kuroco-content-management を統合したスキルです。

機能​

API 連携:

  • エンドポイント設計パターン（URL 構造、主要モデル、オペレーション）
  • 3 つの認証方式（Cookie 認証 / トークン認証 / StaticToken 認証）
  • CORS 設定、キャッシュ戦略、流量制限
  • エラーハンドリングパターン

コンテンツ管理:

  • コンテンツ構造（Topics / TopicsGroup / TopicsCategory）
  • 拡張項目（カスタムフィールド）の設定・利用方法
  • Topics API のオペレーション（list / details / insert / update / delete / bulk_upsert）
  • フィルタークエリの構文と使い方
  • ファイルアップロード、CSV インポート/エクスポート

使用例​

「Kuroco の API でログインを実装したい」
「トークン認証の使い方を教えて」
「CORS のエラーが出る。設定方法は？」
「Kuroco でコンテンツ定義を作りたい」
「記事の一覧を API で取得したい」
「フィルターで特定カテゴリの記事だけ取得したい」

対応するキーワード​

Kuroco API エンドポイント設定 認証 CORS Cookie認証 トークン認証 StaticToken JWT 流量制限 credentials include 401エラー 403エラー 429エラー pageInfo ページネーション コンテンツ定義 Topics カテゴリ WYSIWYG ファイルアップロード CSVインポート ext_col filter order_by bulk_upsert topics_flg 拡張項目

主な認証方式の比較​

認証方式推奨ユースケース特徴
Cookie 認証Web アプリセッションベース。credentials: 'include' が必須
トークン認証モバイルアプリJWT ベース。ヘッダーにトークンを付与
StaticToken 認証サーバー間通信固定トークン。管理画面で設定

フィルタークエリの基本構文​

演算子例
=, !=filter=category_id = 1
>, >=, <, <=filter=ymd >= '2024-01-01'
containsfilter=subject contains 'キーワード'
in, not_infilter=category_id in [1, 2, 3]

kuroco-frontend-integration - フロントエンド統合 & AI 自動デプロイ​

Kuroco と Nuxt.js / Next.js の統合パターンおよび AI 自動デプロイワークフローを提供するスキルです。 旧 kuroco-ai-deployment の機能を統合しています。

実践的なチュートリアルは Kuroco サンプルサイトチュートリアル を参照してください。

機能​

フロントエンド統合:

  • Nuxt 3 / Nuxt 2 / Next.js（App Router / Pages Router）の統合パターン
  • 環境変数設定、プロジェクト構成例
  • 認証実装（ログイン / ログアウト / ログイン状態確認 / 会員登録）
  • SSG / SSR 設定
  • KurocoPages との連携
  • サードパーティ Cookie 問題への対応

AI 自動デプロイ:

  • デプロイワークフロー（サイト登録 → ビルド → アップロード → デプロイ）
  • 署名付き URL を使った一時ファイルアップロード
  • プレビューデプロイ / 本番デプロイ
  • フレームワーク自動検出（Nuxt / Next.js / Vite）

使用例​

「Nuxt3 で Kuroco のコンテンツを表示したい」
「Next.js で Kuroco の認証を実装したい」
「SSG で静的サイトを生成したい」
「Safari でログインできない（Cookie の問題）」
「Kuroco のサイトを自動デプロイしたい」
「プレビュー環境にデプロイして確認したい」

対応するキーワード​

Nuxt3 Next.js App Router SSG SSR useAsyncData $fetch composable useAuth KurocoPages credentials include サードパーティCookie AI自動デプロイ add_site temp-upload presigned URL kuroco_front/deploy artifact_url stage_url CI/CD

フレームワーク別の推奨​

フレームワーク推奨ユースケース
Nuxt.js 3.x新規 Vue プロジェクト（推奨）
Nuxt.js 2.x既存 Vue プロジェクト
Next.js 13+（App Router）新規 React プロジェクト
Next.js（Pages Router）既存 React プロジェクト

デプロイワークフロー​

1. サイト登録       → admin_api (add_site)
2. フロントビルド   → npm run build / nuxt generate
3. アップロード     → 署名付き URL → S3
4. デプロイ実行     → admin_api (KurocoFront deploy)
5. 完了            → stage_url（プレビュー） or production_url

kuroco-server-processing - Smarty プラグイン & バッチ処理​

Kuroco の Smarty テンプレートの完全リファレンスおよびバッチ処理・Webhook・トリガーを使った自動化パターンを提供するスキルです。 旧 kuroco-smarty-plugins と kuroco-webhook-processing を統合したスキルです。

機能​

Smarty プラグインリファレンス:

  • 206 個のプラグインの完全なリファレンス
  • カテゴリ別索引（API / 文字列 / 配列 / フォーム / 認証 / 外部連携 / ファイル / Vue.js）
  • Smarty 基本構文（変数代入、ループ、条件分岐、修飾子）
  • セキュリティ設定（IF_FUNCS / MODIFIER_FUNCS）

バッチ処理 & Webhook:

  • バッチ処理の設定方法と実行頻度
  • 内部 API 呼び出し（api_internal）
  • 外部 API 呼び出し（api_request）
  • トリガー処理（コンテンツ更新時 / フォーム送信時）
  • 外部サービス連携（Slack / メール / GitHub Actions）

使用例​

「Smarty で記事一覧を取得して表示したい」
「sendmail プラグインの使い方を教えて」
「Smarty で JSON をパースする方法は？」
「バッチ処理で毎日 CSV を生成したい」
「コンテンツ更新時に Slack に通知を送りたい」
「GitHub Actions でデプロイをトリガーしたい」

対応するキーワード​

Smartyプラグイン Smarty関数 Smarty修飾子 assign foreach escape date_format api_internal sendmail slack_post_message ai_completion write_file バッチ処理 Webhook 定期実行 cron Slack通知 GitHub Actions api_request トリガー カスタム処理

カテゴリ別リファレンス​

カテゴリ主なプラグイン
API・データ取得api_internal, assign_topics_list, assign_tag_list
文字列処理escape, truncate, date_format, translate
配列操作count, in_array, implode, explode
フォーム・UIfileupload, inquiry_input, pager
認証・権限rcms_auth, login, logout
外部連携sendmail, slack_post_message, ai_completion
ファイル操作write_file, put_file, read_file
Vue.js 連携rcms_vue_component, head_include

バッチ処理の実行頻度​

頻度用途
15 分毎頻繁な同期が必要な場合
30 分毎準リアルタイム処理
1 時間毎定期的な集計・更新
毎日（指定時刻）日次レポート、バックアップ

kuroco-admin-api - 管理 API 操作​

Kuroco の管理 API（admin_api）を CLI（kuroco-admin）で操作するスキルです。 Bash ツールからコマンド一発で API 実行・探索・スキーマ取得が可能です。

機能​

  • admin_api の 5 つのモード（whoami / discover / schema / advise / execute）
  • kuroco-admin login によるセッション Cookie 認証（~/.kuroco-admin/cookies.txt）
  • API 探索（discover モード / advise モード）
  • CLI 経由の API 実行（--columns でレスポンスカラム選択可能）

使用例​

「管理 API でコンテンツを作成して」
「このサイトのコンテンツ定義一覧を確認したい」
「管理 API でメンバー情報を取得したい」
「ターミナルから API 操作を実行したい」

対応するキーワード​

admin_api 管理API kuroco-admin admin CLI 管理API CLI discover advise Topics作成 Member登録

前提条件​

  • Bun ランタイムがインストール済みであること
  • kuroco-admin CLI がビルド済みまたは PATH に追加済みであること
  • kuroco-admin login --url <管理画面URL> でログイン済みであること

admin_api のモード​

モード説明用途
whoamiセッション情報の取得認証確認、member_id・名前・group_ids の取得
discover利用可能なモジュール・コントローラの探索API 構造の把握
schemaリクエスト・レスポンススキーマ取得パラメータ仕様の確認
adviseAI 支援による API ガイダンスやりたいことを伝えると API 手順とパラメータを回答
executeAPI の実行（GET/POST）データの取得・作成・更新・削除

セキュリティ上の注意事項​

  • Cookie 値を表示・ログ出力しない（~/.kuroco-admin/cookies.txt は mode 0o600 で保護）
  • --verbose の出力をユーザーに見せない（HTTP ヘッダーに Cookie 値が含まれる）
  • 変更操作（INSERT / UPDATE / DELETE）は実行前にユーザーに確認
  • --dry-run を活用して書き込み前にリクエスト内容をプレビュー
  • API レスポンスのファイル保存はユーザー同意が必要（個人情報を含む可能性）
Client CLI

Client API に CLI ベースでアクセスする場合は、別途 Client CLI（kuroco-client）も利用可能です。 詳細は Kuroco AI アーキテクチャ を参照してください。

関連ドキュメント​

サポート

お探しのページは見つかりましたか？解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。

フォームから問い合わせをする
Slackコミュニティに参加する