{"meta":{"title":"gerar consulta-ajuda","intro":"Gere a ajuda de consulta do usuário final por meio dos arquivos .qhelp.","product":"Qualidade de segurança e código","breadcrumbs":[{"href":"/pt/code-security","title":"Qualidade de segurança e código"},{"href":"/pt/code-security/reference","title":"Referência"},{"href":"/pt/code-security/reference/code-scanning","title":"Varredura de código"},{"href":"/pt/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/pt/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"Manual da CLI do CodeQL"},{"href":"/pt/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help","title":"gerar consulta-ajuda"}],"documentType":"article"},"body":"# gerar consulta-ajuda\n\nGere a ajuda de consulta do usuário final por meio dos arquivos .qhelp.\n\n> [!NOTE]\n> Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/codeql-cli-binaries/releases.\n>\n> Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção <span style=\"white-space: nowrap;\">`--help`</span> no terminal.\n\n## Sinopse\n\n```shell copy\ncodeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...\n```\n\n## Description\n\nGere a ajuda de consulta do usuário final por meio dos arquivos .qhelp.\n\n## Opções\n\n### Opções principais\n\n#### `<qhelp|mdhelp|query|dir|suite>...`\n\n              \\[Obrigatório] Consulte os arquivos de ajuda a serem renderizados. Cada argumento é um dos seguintes:\n\n* Um arquivo .qhelp a ser renderizado.\n* Um arquivo .md a ser renderizado.\n* Um arquivo .ql com um arquivo .qhelp ou .md correspondente a ser renderizado.\n* Um diretório que será pesquisado recursivamente em busca de arquivos .ql com arquivos .qhelp ou .md correspondentes.\n* Um arquivo .qls que define determinado conjunto de consultas.\n* O nome base de um arquivo .qls \"conhecido\" exportado por um dos pacotes QL instalados.\n\n#### `--format=<format>`\n\n              \\[Obrigatório] O formato no qual a documentação será renderizada. Um destes:\n\n              `markdown`: GitHub Flavored Markdown.\n\n              `sarif-latest`: SARIF (Static Analysis Results Interchange Format), um formato baseado em JSON usado para descrever os resultados da análise estática. Essa opção de formato usa a versão mais recente com suporte (v2.1.0). Essa opção não é adequada para uso na automação, pois produzirá diferentes versões do SARIF entre diferentes versões do CodeQL.\n\n              `sarifv2.1.0`: SARIF v2.1.0.\n\n#### `-o, --output=<dir|file>`\n\nUm caminho no qual a documentação renderizada será gravada. Normalmente, esse é um diretório no qual a saída renderizada será gravada.\n\nSe apenas um arquivo .qhelp ou .ql for fornecido e nenhum diretório existir no caminho de saída, a saída será gravada em um arquivo individual nesse caminho.\n\nSe nenhum caminho de saída for fornecido, apenas um arquivo .qhelp ou .ql será aceito e a saída será gravada em stdout.\n\nSe um diretório de saída for usado, os nomes de arquivos _contidos_ no diretório de saída serão derivados dos nomes de arquivos .qhelp.\n\n#### `--warnings=<mode>`\n\nComo tratar os avisos do renderizador de ajuda de consulta. Um destes:\n\n              `hide`: Suprimir avisos.\n\n              `show`\n              _(padrão)_ : imprima os avisos, mas continue com a renderização.\n\n              `error`: tratar avisos como erros.\n\n#### `--no-sarif-minify`\n\n              \\[Somente formatos SARIF] Produza uma saída SARIF impressa bonita. Por padrão, a saída SARIF é minificada para reduzir o tamanho do arquivo de saída.\n\n### Opções para encontrar pacotes QL (que podem ser necessário para resolver conjuntos de consultas)\n\n#### `--search-path=<dir>[:<dir>...]`\n\nUma lista de diretórios nos quais os pacotes QL podem ser encontrados. Cada diretório pode ser um pacote QL (ou um conjunto de pacotes que contém um arquivo `.codeqlmanifest.json` na raiz) ou o pai imediato de um ou mais desses diretórios.\n\nSe o caminho contiver mais de um diretório, a ordem deles definirá a precedência entre eles: quando for encontrada uma correspondência do nome de um pacote que precisa ser resolvido em mais de uma das árvores do diretório, a primeira fornecida vencerá.\n\nSe você apontar isso para um check-out do repositório do CodeQL de código aberto, isso deverá funcionar durante a consulta de uma das linguagens que se encontram nele.\n\nSe você tiver feito check-out do repositório do CodeQL como um irmão da cadeia de ferramentas CodeQL descompactada, não precisará fornecer essa opção. Nesses diretórios irmãos, sempre será feita a pesquisa por pacotes QL que não podem ser encontrados de outra forma. (Caso esse padrão não funcione, recomendamos fortemente configurar `--search-path` de uma vez por todas em um arquivo de configuração por usuário).\n\n(Observação: no Windows, o separador de caminho é `;`).\n\n#### `--additional-packs=<dir>[:<dir>...]`\n\nSe essa lista de diretórios for fornecida, nesses diretórios, será feita a pesquisa de pacotes antes daqueles contidos em `--search-path`. A ordem entre eles não importa: será indicado um erro se o nome de um pacote for encontrado em dois locais diferentes nessa lista.\n\nIsso será útil se você estiver desenvolvendo temporariamente uma nova versão de um pacote que também aparece no caminho padrão. Por outro lado, _não recomendamos_ substituir essa opção em um arquivo de configuração. Algumas ações internas adicionarão essa opção em tempo real, substituindo qualquer valor configurado.\n\n(Observação: no Windows, o separador de caminho é `;`).\n\n### Opções para configurar o gerenciador de pacotes CodeQL\n\n#### `--registries-auth-stdin`\n\nAutentique-se nos registros de contêiner do GitHub Enterprise Server transmitindo uma lista separada por vírgula de pares \\<registry\\_url>=\\<token>.\n\nPor exemplo, você pode transmitir `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\npara se autenticar em duas instâncias do GitHub Enterprise Server.\n\nIsso substitui as variáveis de ambiente CODEQL\\_REGISTRIES\\_AUTH e GITHUB\\_TOKEN. Se você só precisar se autenticar no registro de contêiner do github.com, poderá se autenticar usando a opção `--github-auth-stdin` mais simples.\n\n#### `--github-auth-stdin`\n\nAutentique-se no registro de contêiner do github.com transmitindo um token do GitHub Apps do github.com ou um token de acesso pessoal por meio da entrada padrão.\n\nPara se autenticar nos registros de contêiner do GitHub Enterprise Server, transmita `--registries-auth-stdin` ou use a variável de ambiente CODEQL\\_REGISTRIES\\_AUTH.\n\nIsso substitui a variável de ambiente GITHUB\\_TOKEN.\n\n### Opções comuns\n\n#### `-h, --help`\n\nMostre este texto de ajuda.\n\n#### `-J=<opt>`\n\n              \\[Avançado] Dê opções à JVM que executa o comando.\n\n(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)\n\n#### `-v, --verbose`\n\nAumente incrementalmente o número de mensagens de progresso impressas.\n\n#### `-q, --quiet`\n\nDiminua incrementalmente o número de mensagens de progresso impressas.\n\n#### `--verbosity=<level>`\n\n              \\[Avançado] Defina explicitamente o nível de detalhamento para um dos seguintes: erros, avisos, progresso, progresso+, progresso++, progresso+++. Substitui `-v` e `-q`.\n\n#### `--logdir=<dir>`\n\n              \\[Avançado] Grava registros detalhados em um ou mais arquivos no diretório especificado, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.\n\n(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça `--log-to-stderr` e redirecione stderr conforme desejado.)\n\n#### `--common-caches=<dir>`\n\n              \\[Avançado] Controla a localização dos dados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilados. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado `.codeql` no diretório inicial do usuário; que será criado se ainda não existir.\n\nDisponível desde `v2.15.2`."}