ForHosting KIT · Outils pour développeurs

Générer un README

Cet outil rédige un brouillon de README à partir de ce que vous décrivez de votre dépôt : nom, langage, dépendances, commandes d’installation et d’utilisation. Il en tire une page structurée — présentation, installation, exemples, licence — que vous relisez et complétez. La fonction est en bêta et produit une base, pas un texte définitif.

● Betapar requête + par dépôt$0.003

Lancer — $0.003 + $0.0135/dépôt Voir l’API

Utilisez-le depuis WebAPIE-mailApp bientôtTelegram bientôt

Exécuter en ligne

Exécutez cette tâche sur nos serveurs, avec votre compte. Les outils gratuits tournent dans votre navigateur ; celui-ci est facturé sur votre solde KIT au prix affiché ci-dessus.

Une structure attendue

Un bon README répond toujours aux mêmes questions : à quoi sert ce projet, comment l’installer, comment l’utiliser, sous quelle licence. L’outil met en place ces sections dans l’ordre habituel, avec des titres clairs et des blocs de code aux bons endroits. Vous partez d’une page cohérente plutôt que d’un fichier vide où l’on ne sait par quel bout commencer, et où la rédaction s’enlise.

Vous décrivez, il met en forme

L’outil ne devine pas votre projet : il met en forme ce que vous lui donnez. Plus vous précisez le langage, les dépendances et les commandes réelles, plus le README est juste. Il n’invente pas une commande d’installation qui n’existe pas ; si vous ne la fournissez pas, il laisse un emplacement à compléter plutôt qu’une valeur trompeuse qui ferait échouer votre premier utilisateur.

Bêta : relisez avant de publier

Comme la fonction est en bêta, considérez le résultat comme un premier jet. Vérifiez que les commandes fonctionnent vraiment, que les exemples correspondent à la version actuelle et que rien d’important ne manque. Un README est la vitrine d’un projet : une commande fausse décourage un contributeur dès la première minute. La mise en forme est offerte, l’exactitude reste votre responsabilité.

Markdown prêt à coller

Le résultat est du Markdown standard, que vous copiez directement dans le fichier README.md de votre dépôt ; les titres, listes et blocs de code s’affichent correctement sur les forges habituelles. Essayez sur cette page, ou appelez l’API pour générer des README en série sur plusieurs projets internes, avec d’autres canaux à venir pour déclencher la génération là où vous travaillez.

Cas d’usage

Un projet perso enfin présentable

Sophie a écrit un petit outil en ligne de commande sans jamais prendre le temps de le documenter. Elle décrit l’installation et deux exemples, obtient un README propre et publie enfin son dépôt sans honte.

Standardiser les README internes

Studio Lumen SAS veut la même trame pour tous ses dépôts. En générant chaque README à partir d’une description structurée, l’équipe obtient des pages homogènes que tout nouveau venu sait lire d’un coup d’œil.

Franchir l’étape la plus repoussée

Le README est la tâche que Julien remet toujours à plus tard. En partant d’un brouillon déjà structuré, il n’a plus qu’à corriger et compléter, au lieu d’affronter la page blanche.

Questions fréquentes

Que dois-je lui fournir ?

Le nom et le but du projet, le langage, les dépendances principales et les commandes d’installation et d’utilisation. Plus la description est complète, plus le README est fidèle et exploitable sans retouche.

Invente-t-il les commandes d’installation ?

Non. Il met en forme ce que vous fournissez. Si une commande manque, il laisse un emplacement à compléter plutôt qu’une valeur inventée qui induirait vos utilisateurs en erreur.

En quelle langue est rédigé le README ?

Français ou anglais, à votre choix. L’anglais est fréquent pour un projet ouvert ; le français convient à un dépôt interne ou destiné à un public francophone.

Mes informations sont-elles conservées ?

Elles sont transmises le temps de générer le README, puis ne sont pas conservées. Ne fournissez pas de secret, comme une clé d’accès, dans la description.

Qu’implique le statut « bêta » ?

La fonction s’exécute déjà, mais le résultat demande relecture et corrections avant publication. La qualité progresse ; en attendant, traitez la sortie comme un brouillon.

Combien ça coûte ?

$0.003 par appel, plus $0.0135 par dépôt traité, en dollars US. Tarif affiché, sans abonnement.

Pour les développeurs — accès API

Tout sur cette page est disponible par programmation. Cette section s'adresse aux équipes qui veulent l'intégrer à leurs systèmes ; les autres peuvent simplement utiliser l'outil ci-dessus.

Endpoint

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

Authentification par jeton Bearer : un seul POST met la tâche en file d’attente, et le résultat vous parvient par webhook ou lien signé.

Appeler depuis votre stack

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)

Exemple de requête

{
  "input": "…"
}

Exemple de réponse

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

L’API est asynchrone : chaque appel renvoie un task_id immédiatement, puis vous interrogez l’état à raison d’une requête par seconde.

Tarifs

par requête$0.003

par dépôt$0.0135

Le prix est publié, sans tokens ni crédits. Une tâche qui échoue n’est pas facturée.

Erreurs

HTTP	Code	Signification
`401`	`unauthorized`	Clé API absente ou invalide : vérifiez l’en-tête Authorization.
`402`	`insufficient_balance`	Solde insuffisant : rechargez votre compte pour lancer cette tâche.
`404`	`unknown_type`	Type de tâche inconnu : vérifiez le champ type de votre requête.
`429`	`rate_limited`	Trop de requêtes : ralentissez la cadence, puis réessayez.
`422`	`task_failed`	La tâche a échoué : elle ne vous est pas facturée.

Consulter la documentation complète du KIT →