generate query-help

Sinopse

codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

Descrição

Gere a ajuda de consulta do usuário final por meio dos arquivos .qhelp.

Opções

Opções principais

<qhelpquerysuite>...

[Obrigatório] Consulte os arquivos de ajuda a serem renderizados. Cada argumento é um dos seguintes:

• Um arquivo .qhelp a ser renderizado.
• Um arquivo .md para renderizar.
• Um arquivo .ql com um arquivo .qhelp ou .md correspondente a ser renderizado.
• Um diretório que será pesquisado recursivamente em busca de arquivos .ql com os arquivos .qhelp ou .md correspondentes.
• Um arquivo .qls que define determinado conjunto de consultas.
• O nome base de um arquivo .qls "conhecido" exportado por um dos pacotes QL instalados.

--format=<format>

[Obrigatório] O formato no qual a documentação será renderizada. Um destes:

markdown: GitHub Flavored Markdown.

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.

sarifv2.1.0: SARIF v2.1.0.

-o, --output=<dir|file>

Um caminho no qual a documentação renderizada será gravada. Normalmente, esse é um diretório no qual a saída renderizada será gravada.

Se 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.

Se nenhum caminho de saída for fornecido, apenas um arquivo .qhelp ou .ql será aceito e a saída será gravada em stdout.

Se 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.

--warnings=<mode>

Como tratar os avisos do renderizador de ajuda de consulta. Um destes:

hide: suprima os avisos.

show (padrão) : imprima os avisos, mas continue com a renderização.

error: trate os avisos como erros.

--no-sarif-minify

[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.

Opções para encontrar pacotes QL (que podem ser necessário para resolver conjuntos de consultas)

--search-path=<dir>[:<dir>...]

Uma 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.

Se 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á.

Se 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.

Se 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).

(Observação: no Windows, o separador de caminho é ;).

--additional-packs=<dir>[:<dir>...]

Se 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.

Isso 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.

(Observação: no Windows, o separador de caminho é ;).

Opções para configurar o gerenciador de pacotes CodeQL

--registries-auth-stdin

Autentique-se nos registros de contêiner do GitHub Enterprise Server transmitindo uma lista separada por vírgula de pares <registry_url>=<token>.

Por exemplo, você pode transmitir https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 para se autenticar em duas instâncias do GitHub Enterprise Server.

Isso 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.

--github-auth-stdin

Autentique-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.

Para 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.

Isso substitui a variável de ambiente GITHUB_TOKEN.

Opções comuns

-h, --help

Mostre este texto de ajuda.

-J=<opt>

[Avançado] Forneça a opção para a JVM que executa o comando.

(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)

-v, --verbose

Aumente incrementalmente o número de mensagens de progresso impressas.

-q, --quiet

Diminua incrementalmente o número de mensagens de progresso impressas.

--verbosity=<level>

[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.

--logdir=<dir>

[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.

(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.)

--common-caches=<dir>

[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. 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.

Disponível desde v2.15.2.