ForHosting KIT · Strumenti per sviluppatori

README a mano o generato dal codice?

Uno strumento che legge la struttura di un progetto — file principali, dipendenze, un estratto del codice — e scrive un README di partenza: cosa fa il progetto, come si installa, come si usa. Pensato per chi ha un repository senza documentazione e non vuole scriverla da zero.

● Betaper richiesta + per repository$0.003

Esegui — $0.003 + $0.0135/repository Vedi l'API

Usalo da WebAPIEmailApp prestoTelegram presto

Esegui online

Esegui questo sui nostri server con il tuo account. Gli strumenti gratuiti girano nel tuo browser; questo viene addebitato sul tuo saldo KIT al prezzo indicato sopra.

Cosa gli serve per lavorare bene

Più contesto dai, meglio esce il risultato: incolla l'elenco dei file principali, il contenuto del file di dipendenze (package.json, requirements.txt, composer.json) e, se vuoi, un estratto delle funzioni più importanti del progetto. Con solo il codice di un file singolo produce comunque un README minimo e utilizzabile, ma con la struttura completa del progetto il risultato è molto più utile, completo e pronto da pubblicare quasi senza modifiche.

Le sezioni che genera

Titolo e descrizione breve, istruzioni di installazione dedotte dal file di dipendenze, un esempio d'uso quando lo trova nel codice, e una sezione di licenza segnaposto da completare tu. Non inventa dettagli che non può dedurre dal codice che gli dai — se non trova un file di licenza, lo segnala chiaramente invece di inventarne uno a caso, lasciandoti la scelta finale su quale usare per il progetto.

Perché è in beta

Su progetti piccoli e con una struttura chiara il risultato è quasi pronto da pubblicare così com'è, con poche righe da rivedere. Su progetti grandi, con più moduli e configurazioni particolari, serve sempre una rilettura per aggiungere ciò che solo chi ha scritto il codice sa spiegare: perché certe scelte, quali sono i limiti noti del progetto e cosa manca ancora da completare.

Prezzo e canali

$0.003 a richiesta più $0.0135 a progetto analizzato, senza abbonamento e senza costi fissi aggiuntivi. Si usa dalla pagina web incollando la struttura del repository e il file di dipendenze; se lo integri in una pipeline di pubblicazione automatica, che genera il README a ogni nuova versione del progetto, lo stesso motore risponde via API allo stesso prezzo pubblicato, senza differenze di risultato.

Casi d'uso

Pubblicare finalmente un progetto interno

Francesca Colombo ha un piccolo tool interno usato da anni in Rossi & Figli S.r.l. e vuole renderlo open source. Genera il README di partenza dalla struttura del progetto e lo completa con le note che solo lei conosce.

Onboarding più veloce per chi arriva dopo

Un repository dello Studio Commercialista Bianchi non ha mai avuto un README. Generarne uno dalla struttura attuale dà a chi entra nel progetto un primo punto di partenza, invece di dover chiedere tutto a voce.

Uniformare i README di più progetti piccoli

Un freelance che gestisce diversi repository per clienti diversi usa lo strumento per dare a tutti la stessa struttura minima di README, invece di scriverla ogni volta da capo con formati diversi.

Domande frequenti

Serve dargli tutto il codice del progetto?

No, basta la struttura principale e il file di dipendenze. Più contesto dai, più completo esce il risultato, ma funziona anche con poche informazioni.

Perché è etichettato beta?

Perché su progetti grandi e complessi il risultato è un buon punto di partenza, non il README definitivo: la rilettura di chi conosce il progetto resta necessaria.

Quanto costa?

$0.003 a richiesta più $0.0135 a progetto analizzato. A consumo, prezzo pubblicato, senza abbonamento.

Il codice che incollo resta privato?

Viene elaborato per generare il README e poi eliminato: non lo conserviamo. Per repository privati, valuta comunque cosa incolli, come con qualsiasi strumento online.

Inventa funzionalità che il progetto non ha?

No: descrive solo quello che trova nel codice e nella struttura che gli dai. Dove manca un'informazione — come la licenza — lo segnala invece di inventarla.

Posso chiederlo in inglese anche se il progetto è in italiano?

Sì, scegli tu la lingua del README: molti progetti italiani lo pubblicano in inglese per raggiungere più sviluppatori.

Per sviluppatori — accesso via API

Tutto quello che vedi in questa pagina è disponibile anche via API. Questa sezione è per i team che vogliono integrarlo nei propri sistemi; chi non ne ha bisogno può semplicemente usare lo strumento qui sopra.

Endpoint

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

Autenticazione con Bearer token: un POST mette in coda l'attività e il risultato arriva via webhook o link firmato.

Chiamala dal tuo 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)

Esempio di richiesta

{
  "input": "…"
}

Esempio di risposta

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

L'API è asincrona: ricevi subito un task_id e puoi fare polling fino a 1 richiesta al secondo.

Prezzi

per richiesta$0.003

per repository$0.0135

Prezzo pubblicato, senza token né crediti. Se l'attività fallisce, non paghi.

Errori

HTTP	Codice	Significato
`401`	`unauthorized`	Chiave API mancante o non valida: controlla l'header Authorization.
`402`	`insufficient_balance`	Credito esaurito: ricarica per continuare a eseguire attività.
`404`	`unknown_type`	Tipo di attività sconosciuto: controlla il campo type della richiesta.
`429`	`rate_limited`	Troppe richieste in poco tempo: rallenta e riprova tra qualche secondo.
`422`	`task_failed`	L'attività non è andata a buon fine: non ti viene addebitato nulla.

Leggi la documentazione completa del KIT →