SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillskuroco-docs

kuroco-docs

Coding & development

View repository

Updated 10-15 21:10

About this skill

Kuroco Documentation Search Guide

This Skill supports searching and referencing the official Kuroco documentation.

Documentation Location and Format

The documentation is bundled with this skill. Its location is as follows:

This SKILL.md is located in the same directory as, and docs/ is used. In the examples below, it is referred to as docs/ as a relative path based on this skill's directory. Do not depend on client-specific environment variables or fixed paths within the repository.

The bundled documentation is a snapshot at the time of distribution.If the information may be outdated, or if the relevant item cannot be found in the bundled documentation, check the official site (https://kuroco.app/ja/docs/ ). Updating the skill package will also update the bundled documentation to the latest version (the update procedure differs depending on the installation method, so refer to the repository's README).

Each page of the official documentation isconsolidated file per categoryand is included as such.

  • A single consolidated file contains multiple official pages, and each page starts with a # タイトル heading
  • Directly below the page heading are the original page's slug and official site URL (https://kuroco.app/ja/docs/...) exists
  • At the beginning of each file there is a table of contents of "included pages"
  • Large categories are split as -1.md, -2.md such as (search with Glob as tutorials-auth-member*.md such as)

File Structure

File Contents
INDEX.md List of all files and number of included pages
tutorials-*.md Tutorials (auth-member / frontend / content / api-custom / ai-mcp / ec / form-mail / integration / admin-customize / misc)
reference-*.md Reference (api / content / smarty-trigger / mcp-ai / file / misc)
management-*.md Admin panel guides (account / api / campaign / content / ec / integration / member / operation / misc)
faq-*.md FAQ（content / frontend / api / api-error / admin / email-form / domain / file / login-session / password / smarty / tls / infrastructure / deploy / member / email / assessment / contracts / other）
about.md Kuroco overview, pricing, limitations, security
troubleshooting.md Troubleshooting

Announcements and release notes are not bundled because freshness is important. If needed, refer to the official site (https://kuroco.app/ja/docs/ ).

Search Methods

Method 1: Keyword search with Grep (recommended)

Use a full-text search tool (equivalent to Grep) to search across all of docs/, and read the vicinity of the matching lines in the hit files with a file reading tool (equivalent to Read; one that allows specifying a starting line). In environments without a search tool, you can do the same by running grep -rn in a shell.

# キーワードで検索（ファイル特定）
Grep: pattern="エンドポイント" path="docs/"

# 行番号付きで内容を確認 → その行から Read で該当セクションを読む
Grep: pattern="フィルタークエリ" path="docs/" output_mode="content" -n=true

# 元ページのslugがわかっている場合（各ページ見出し直下に slug が記載されている）
Grep: pattern="how-to-use-batch" path="docs/"

# ファイル名で分類を絞る
Grep: pattern="ログイン" path="docs/" glob="tutorials-*.md"

Because consolidated files are large, it is efficient to **not Read the entire file, but rather Grep line numbers → Read (with offset/limit specified)** and read only the necessary sections. Page boundaries are # This is a heading.

Method 2: Check the file list in INDEX.md

cat docs/INDEX.md

You can check the list of which integrated files contain how many pages. At the beginning of each integrated file, there is a table of contents (titles and slugs) of the included pages.

Quick Reference by Purpose

Purpose Reference
API/endpoint settings reference-api*.md（endpoint-settings, filter-query, api-cache）、tutorials-api-custom*.md（configure-endpoint）
Authentication, login, member registration tutorials-auth-member*.md(login, signup, two-factor authentication, SSO/SAML)
Frontend integration (Nuxt/Next, SSG) tutorials-frontend*.md（integrate-kuroco-with-nuxt, beginners-guide, corporate-sample-site-to-ssg）
Content management, CSV bulk registration tutorials-content*.md（adding-a-topics, bulk-upload-in-csv）、management-content*.md
Batch processing, triggers, Smarty reference-smarty-trigger*.md（smarty-plugin, trigger-variables）、tutorials-api-custom*.md（how-to-use-batch）
External service integration (Slack/SendGrid/Firebase, etc.) tutorials-integration*.md、tutorials-form-mail*.md、management-integration*.md
EC/payments (Stripe/Paygent) tutorials-ec*.md、management-ec*.md
MCP/AI features (Kuroco RAG, etc.) tutorials-ai-mcp*.md、reference-mcp-ai*.md
Error/troubleshooting faq-*.md、troubleshooting.md、reference-api*.md（error）
Pricing, limitations, infrastructure about.md、faq-contracts.md、faq-infrastructure.md

Search Tips

  1. Japanese keywords: エンドポイント, ログイン, コンテンツ
  2. English keywords: Topics, Member, API, CORS
  3. Feature names/slugs: batch, webhook, trigger, smarty, filter-query
  4. Narrow down by category: tutorials-*(implementation method),reference-*(specifications),management-*(admin panel),faq-*（Q&A）
  5. Include official URLs in answers: Quote the "Official page" URL directly below each page heading

Documentation Updates

The documentation is updated together with plugin updates.

/plugin marketplace update diverta-kuroco-skills

For the procedure to regenerate integrated files (for maintainers), see the docstring of scripts/consolidate_docs.py .