ForHosting KIT · Ferramentas para dev

Gerador de README

Envie a estrutura e os arquivos principais do seu repositório e receba um README completo: o que o projeto faz, como instalar, como usar, exemplos e seções organizadas. Para aquele projeto que funciona muito bem — mas que ninguém consegue rodar sem te chamar no chat.

● Betapor repositórioUS$ 0,003

Executar — US$ 0,003 + US$ 0,0135/repositório Ver a API

Use pelo WebAPIE-mailApp em breveTelegram em breve

Rode online

Rode nos nossos servidores com a sua conta. As ferramentas grátis rodam no seu navegador; esta aqui é descontada do seu saldo do KIT pelo preço acima.

O que entra no README gerado

O resultado traz as seções que um bom README pede: descrição objetiva do projeto, pré-requisitos, passo a passo de instalação, exemplos de uso com comandos tirados do próprio código, estrutura de pastas comentada e, quando faz sentido, seção de configuração com as variáveis de ambiente encontradas. O texto nasce do que existe no repositório — não é um modelo genérico com lacunas para preencher.

O que enviar na chamada

Mande o que descreve o projeto: a árvore de arquivos, o manifesto de dependências (package.json, requirements.txt ou equivalente), os arquivos de entrada principais e qualquer documentação solta que já exista. Quanto mais contexto real, menos o texto precisa generalizar. Repositório privado? Você escolhe o que sai: dá para enviar só a estrutura e os trechos que não expõem nada sensível.

Beta: o que esperar

Esta capacidade está em beta. O README sai completo e bem organizado, mas detalhes muito específicos — uma flag de configuração obscura, um passo de deploy fora do comum — podem precisar do seu ajuste. A revisão é rápida: você corrige sobre um documento estruturado em vez de encarar a página em branco. Preferimos publicar o status a deixar você descobrir na primeira chamada.

Preço por repositório

US$ 0,003 pela chamada mais US$ 0,0135 por repositório processado — cerca de US$ 0,017 por README, em dólares americanos. Documentar os quinze repositórios da sua organização custa menos de US$ 0,30. Não tem plano, não tem assinatura: você paga o que gerar, quando gerar, e o valor está publicado nesta página. A compra é direta, sem cadastro.

Casos de uso

Open source apresentável

Você publicou uma lib no GitHub e o README de duas linhas espanta quem chega. Gere um documento completo, revise os exemplos e publique: projeto com README decente recebe issue melhor, PR melhor e mais estrela.

Entrega de projeto para o cliente

A TecnoSul Soluções Digitais fecha cada entrega com README de instalação e operação. Gerar o rascunho pela API virou etapa do checklist: o dev revisa em dez minutos o que antes tomava a tarde de sexta.

Portfólio para vaga

Recrutador técnico abre o GitHub do candidato. Thiago Barbosa Lima gerou READMEs para os quatro projetos do portfólio antes de se candidatar — quem abre o link entende o que cada projeto faz em trinta segundos.

Perguntas frequentes

O README sai em português ou inglês?

No idioma que você pedir. Para open source com ambição internacional, inglês; para o time interno e projetos de cliente brasileiro, português — ou os dois, gerando duas vezes.

Preciso mandar o repositório inteiro?

Não. A árvore de arquivos, o manifesto de dependências e os fontes principais bastam. Você controla exatamente o que sobe na chamada — critério útil quando o repositório é privado.

E se o projeto tiver documentação desatualizada?

Envie junto: o serviço aproveita o que estiver correto e reescreve o resto com base no código atual. Sinalize na chamada o que já não vale, para o texto não perpetuar instrução morta.

Por que está em beta?

Porque passos muito específicos de configuração ou deploy ainda podem exigir ajuste manual no texto. O grosso vem pronto; a lapidação final é sua. O aviso fica aqui na página, antes da primeira chamada.

Como pago sem criar conta?

Via PayPal, pagamento direto por uso — sem cadastro, sem mensalidade. O preço em dólares americanos (US$ 0,003 por chamada mais US$ 0,0135 por repositório) está publicado nesta página.

Para desenvolvedores — acesso via API

Tudo nesta página está disponível via API. Esta seção é para equipes que querem integrar a ferramenta aos próprios sistemas; quem não precisa disso pode simplesmente usar a ferramenta acima.

Endpoint

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

Autenticação por token Bearer. Um único POST coloca a tarefa na fila; o resultado chega por webhook ou link assinado.

Chame do seu código

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)

Exemplo de requisição

{
  "input": "…"
}

Exemplo de resposta

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

A API é assíncrona: cada chamada devolve um task_id na hora. Se preferir polling, consulte o status a até 1 requisição por segundo.

Preço

por chamadaUS$ 0,003

por repositórioUS$ 0,0135

Preço publicado, sem tokens nem créditos escondidos. Tarefa que falha não é cobrada.

Erros

HTTP	Código	O que significa
`401`	`unauthorized`	Token ausente ou inválido. Confira o header Authorization.
`402`	`insufficient_balance`	Saldo insuficiente para esta tarefa. Faça uma recarga e tente de novo.
`404`	`unknown_type`	Esse tipo de tarefa não existe. Confira o campo type no catálogo.
`429`	`rate_limited`	Muitas requisições em pouco tempo. Espere um instante e tente de novo.
`422`	`task_failed`	A tarefa falhou do nosso lado. Você não paga nada por ela.

Ver a documentação completa do KIT →