ForHosting KIT · 開発者向けツール

リポジトリからREADMEを自動生成

プロジェクトのディレクトリ構成や主要なコードを読み込み、概要・使い方・インストール手順を含むREADMEの下書きを生成するツールです。公開直前になって後回しにしがちな作業の土台を作ります。

● Betaリポジトリあたり$0.003

実行 — $0.003 + $0.0135/リポジトリ API仕様を見る

ご利用方法ウェブAPIメールアプリ近日Telegram 近日

オンラインで実行

アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。

読み込む情報

主要なファイルの内容やディレクトリ構成、パッケージの設定ファイルなどから、プロジェクトが何をするものかを読み取ります。既存のコメントやコミット履歴の要約があれば、それも手がかりとして使います。

現在の位置づけ

現在ベータ版として提供しています。プロジェクトの目的や対象ユーザーといった、コードから読み取れない情報は含まれないため、生成後に冒頭の説明文を書き足すことをおすすめします。

使い方

主要なファイルの内容を貼り付けて実行すると、概要・インストール手順・基本的な使い方の見出しを含む下書きが返されます。個人開発のリポジトリを初めて公開する際の、体裁を整える時間を短縮できます。

料金

1回の生成につき基本料金$0.003（米ドル）と生成料金$0.0135の合計、$0.0165です。プロジェクトごとに1回実行すれば、あとは加筆と修正で仕上げられます。

活用例

個人開発ツールの公開準備

個人開発者の鈴木美咲は、副業で作ったツールをGitHubで公開する前に、この機能でREADMEの下書きを作成し、目的の説明だけを書き足しています。

社内ライブラリの説明資料

有限会社ささき印刷の情報システム部門では、社内共有用のライブラリにREADMEがなかったため、この機能で下書きを作成してから配布しています。

受託案件の納品資料の一部

合同会社みどりデザインは、納品物に含めるREADMEをこの機能で下書きし、クライアント向けの表現に整えてから提出しています。

よくある質問

送信したコードやディレクトリ構成は保存されますか

READMEを生成する処理にのみ使用し、処理後にサーバー側で保管され続けることはありません。非公開のリポジトリでもご利用いただけます。

生成されたREADMEをそのまま公開してよいですか

下書きとしての精度は高いものの、プロジェクトの目的や対象ユーザーなどコードから読み取れない情報は含まれません。公開前に冒頭の説明を書き足すことをおすすめします。

対応する言語やフレームワークは限られますか

特定の言語やフレームワークに限定していません。設定ファイルやディレクトリ構成から、一般的なプロジェクトの形であれば読み取ります。

大きなリポジトリでも1回で処理できますか

固定の上限は設けていませんが、分量が多いほど処理量が増え精度も粗くなりやすいため、主要なファイルに絞って渡すことをおすすめします。

見出しの構成は指定できますか

指示に希望する見出しを含めることで調整できます。指定がない場合は、概要・インストール手順・使い方といった一般的な構成で生成されます。

料金はどのように計算されますか

1回の生成につき$0.003に$0.0135を加えた$0.0165です。米ドル建てで、月額契約は不要です。

日本語のサポートはありますか

日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/dev/readme

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/dev/readme \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d &#39;{"input":"…"}'

const res = await fetch("https://api.kit.forhosting.com/dev/readme", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "input": "…"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/readme",
    headers={"Authorization": f"Bearer {os.environ[&#39;KIT_KEY']}"},
    json={
    "input": "…"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/readme", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => &#39;{"input":"…"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"input":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/readme", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "input": "…"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.readme",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.003

リポジトリあたり$0.0135

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。
`422`	`task_failed`	タスクの処理に失敗しました。このタスクは課金されません。

KITの完全なドキュメントを見る →