YAMLResume

Gerar

O comando yamlresume ai generate gera um arquivo de currículo completo e realista a partir de uma posição e idioma de destino.

$ yamlresume ai generate --help
Usage: yamlresume ai generate [options] <filename>

generate a new resume with AI

Arguments:
  filename                   output filename

Options:
  -p, --position <position>  target position or job title
  -l, --language <language>  target locale language
  -m, --model <model>        AI provider model to use
  -b, --base-url <url>       AI provider base URL
  -h, --help                 display help for command

Environment variables:

  Required (one API key for the selected cloud provider):
    DEEPSEEK_API_KEY          DeepSeek API key
    OPENAI_API_KEY            OpenAI API key
    MOONSHOT_API_KEY          Kimi (Moonshot AI) API key

  Optional:
    OLLAMA_HOST               Ollama host for local models
    YAMLRESUME_AI_MODEL       model override (overridden by --model)
    YAMLRESUME_AI_BASE_URL    API base URL override (overridden by --base-url)

Provedores suportados

O YAMLResume suporta vários provedores de LLM por meio de endpoints compatíveis com OpenAI. O provedor é inferido a partir das variáveis de ambiente:

ProvedorVariável de ambiente obrigatóriaModelo padrãoSubstituições opcionais
DeepSeekDEEPSEEK_API_KEYdeepseek-v4-flashYAMLRESUME_AI_MODEL, YAMLRESUME_AI_BASE_URL
Kimi (Moonshot AI)MOONSHOT_API_KEYkimi-k2.6YAMLRESUME_AI_MODEL, YAMLRESUME_AI_BASE_URL
Ollama (local)OLLAMA_HOSTllama3.2YAMLRESUME_AI_MODEL, YAMLRESUME_AI_BASE_URL
OpenAIOPENAI_API_KEYgpt-5YAMLRESUME_AI_MODEL, YAMLRESUME_AI_BASE_URL

Exemplos

Defina a chave de API de um provedor e execute:

$ export OPENAI_API_KEY=sk-...
$ yamlresume ai generate --position "Software Engineer" --language en resume.yml

Substitua o modelo e a URL base por meio de opções da CLI:

$ yamlresume ai generate \
    --position "Registered Nurse" \
    --language en \
    --model gpt-5 \
    --base-url https://custom.openai.endpoint/v1 \
    resume.yml

Ou por meio de variáveis de ambiente:

$ export YAMLRESUME_AI_MODEL=gpt-5
$ export YAMLRESUME_AI_BASE_URL=https://custom.openai.endpoint/v1
$ yamlresume ai generate --position "Registered Nurse" --language en resume.yml

Como funciona

O yamlresume ai generate constrói um prompt detalhado a partir das regras do esquema do YAMLResume e de um currículo de exemplo, depois solicita ao LLM que produza um currículo completo. O prompt instrui o modelo a:

  • Produzir apenas YAML válido, sem cercas markdown.
  • Manter os comentários YAML para que o arquivo gerado continue adequado para validação em editores/IDE.
  • Seguir todas as restrições do esquema, como comprimentos de campos, formatos de datas, valores de enumeração e URLs válidas.
  • Inventar conteúdo original e realista adaptado à posição e ao idioma de destino, sem copiar os dados pessoais do currículo de exemplo.

O texto gerado é então analisado e validado. Se a validação falhar, o modelo recebe a solicitação de corrigir os erros e tentar novamente, até o limite de novas tentativas configurado.

API programática

O pacote @yamlresume/ai também expõe uma API programática para gerar currículos:

import { generateResume } from "@yamlresume/ai";
import { openai } from "@ai-sdk/openai";

const model = openai("gpt-5");

const yaml = await generateResume({
  position: "Software Engineer",
  language: "en",
  model,
});
Edit on GitHub

Last updated on

On this page