> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência de comandos

> Referência dos comandos da CLI do CometAPI, incluindo chat, models, model info, run, balance, account, stats, tokens, logs, tasks, doctor, config e repl.

Use `cometapi -h` ou `cometapi <command> -h` para verificar os argumentos e opções exatos da versão instalada.

## Visão geral dos comandos

| Command           | Description                                                             | Auth                         |
| ----------------- | ----------------------------------------------------------------------- | ---------------------------- |
| `chat [MESSAGE]`  | Envie uma mensagem de chat ou inicie o chat REPL                        | Chave de API                 |
| `models`          | Liste e filtre os metadados do catálogo de modelos                      | Chave de API                 |
| `model info <id>` | Inspecione os metadados públicos de um modelo                           | Chave de API                 |
| `run [MODEL]`     | Envie uma solicitação por chat, responses, anthropic ou formatos gemini | Chave de API                 |
| `balance`         | Mostre o saldo da conta ou da chave de API atual                        | Chave de API ou access token |
| `account`         | Mostre o perfil da conta                                                | Access token                 |
| `stats`           | Mostre estatísticas de uso                                              | Access token                 |
| `tokens`          | Liste e pesquise chaves de API                                          | Access token                 |
| `logs`            | Navegue pelos logs de uso com filtros                                   | Access token                 |
| `tasks`           | Mostre logs de tarefas assíncronas                                      | Access token                 |
| `init`            | Execute o assistente de configuração                                    | Nenhum                       |
| `doctor`          | Execute diagnósticos                                                    | Chave de API                 |
| `config`          | Gerencie a configuração local                                           | Nenhum                       |
| `repl`            | Inicie um shell de comando interativo                                   | Depende do comando usado     |

Os comandos marcados como **Access token** exigem a variável de ambiente `COMETAPI_ACCESS_TOKEN` ou a chave de configuração `access_token`. Consulte o [guia de configuração](/pt/libraries/cli/configuration) para mais detalhes.

## Chat

Envie uma única mensagem ou inicie o chat REPL de múltiplos turnos.

```bash theme={null}
cometapi chat "Explain CometAPI in one sentence."
cometapi chat "Summarize this" --model your-model-id --system "Be concise."
cometapi chat "Hello" --no-stream
cometapi chat "Hello" --json
cometapi chat
```

| Option                 | Short | Description                         |
| ---------------------- | ----- | ----------------------------------- |
| `--model`              | `-m`  | Modelo a ser usado                  |
| `--system`             | `-s`  | Prompt do sistema                   |
| `--temperature`        | `-t`  | Temperatura de amostragem           |
| `--max-tokens`         |       | Número máximo de tokens da resposta |
| `--stream/--no-stream` |       | Ative ou desative o Streaming       |
| `--format`             | `-f`  | Formato de saída                    |
| `--json`               |       | Saída como JSON                     |

## Models

Liste modelos do catálogo público por padrão. A saída do catálogo inclui model ID, provedor, tipo de modelo, recursos, endpoints, preços, comprimento de contexto e máximo de tokens de conclusão.

```bash theme={null}
cometapi models
cometapi models --search gpt --limit 10
cometapi models --provider openai --type chat --limit 10
cometapi models --feature image --endpoint responses --json
cometapi models --refresh
cometapi models --source openai --search gpt
```

| Option                      | Short | Description                                                        |
| --------------------------- | ----- | ------------------------------------------------------------------ |
| `--search`                  | `-s`  | Filtre por ID, código, nome, descrição ou provedor                 |
| `--provider`                |       | Filtre por nome ou código do provedor                              |
| `--type`, `--modality`      |       | Filtre por tipo de modelo ou modalidade                            |
| `--feature`, `--capability` |       | Filtre por recurso ou capacidade                                   |
| `--endpoint`                |       | Filtre por nome do endpoint, método ou caminho                     |
| `--limit`                   | `-l`  | Número máximo de resultados                                        |
| `--source`                  |       | Use metadados `catalog` ou listagem `openai` compatível com OpenAI |
| `--refresh`                 |       | Atualize o cache do catálogo de uma hora                           |
| `--no-cache`                |       | Ignore o cache do catálogo para este comando                       |
| `--format`                  | `-f`  | Formato de saída                                                   |
| `--json`                    |       | Saída como JSON                                                    |

O cache do catálogo é armazenado em `~/.cache/cometapi/models.json`.

## Informações do modelo

Inspecione metadados públicos de um modelo. O comando resolve o modelo por meio do catálogo público e, em seguida, carrega metadados detalhados para o código do catálogo.

```bash theme={null}
cometapi model info your-model-id
cometapi model info your-model-id --json
cometapi model info your-model-id --refresh
```

| Option       | Short | Description                                    |
| ------------ | ----- | ---------------------------------------------- |
| `--refresh`  |       | Atualiza o cache do catálogo antes da consulta |
| `--no-cache` |       | Ignora o cache do catálogo para este comando   |
| `--format`   | `-f`  | Formato de saída                               |
| `--json`     |       | Exibe o JSON bruto dos detalhes do modelo      |

A saída em tabela inclui provider, tipo de modelo, recursos, endpoints, preços, comprimento de contexto, tokens máximos de conclusão, URL da documentação e visão geral.

## Executar

Envie uma solicitação por meio de um formato de endpoint selecionado. Use `--input-file` para um corpo JSON, valores `-i key=value` repetidos para substituições e `-p/--prompt` como atalho para Prompt.

```bash theme={null}
cometapi run your-model-id -p "Write one sentence about CometAPI."
cometapi run your-model-id --endpoint responses -p "Reply with OK only." -i max_output_tokens=32 --json
cometapi run your-model-id --endpoint anthropic -p "Reply with OK only." -i max_tokens=32
cometapi run your-model-id --endpoint gemini -p "Reply with OK only." -i generationConfig.maxOutputTokens=32
cometapi run your-model-id --endpoint responses --input-file body.json -i temperature=0.2 --json
```

| Option         | Short | Description                                                         |
| -------------- | ----- | ------------------------------------------------------------------- |
| `--endpoint`   | `-e`  | Formato do endpoint: `chat`, `responses`, `anthropic` ou `gemini`   |
| `--input-file` |       | Corpo da solicitação em objeto JSON                                 |
| `--input`      | `-i`  | Entrada da solicitação como `key=value`; repita para vários valores |
| `--prompt`     | `-p`  | Atalho para Prompt                                                  |
| `--json`       |       | Exibe a resposta JSON bruta                                         |

Mapeamento de endpoint:

| Endpoint    | Request path                              | Auth                                                     |
| ----------- | ----------------------------------------- | -------------------------------------------------------- |
| `chat`      | `POST /v1/chat/completions`               | Chave de API Bearer                                      |
| `responses` | `POST /v1/responses`                      | Chave de API Bearer                                      |
| `anthropic` | `POST /v1/messages`                       | Chave de API `x-api-key` e cabeçalho de versão Anthropic |
| `gemini`    | Caminho do modelo Gemini Generate Content | Chave de API `x-goog-api-key`                            |

A ordem de mesclagem do corpo é `--input-file`, `-i key=value` repetidos, atalho de Prompt e, por fim, `MODEL` posicional. Os valores inline são analisados como JSON quando possível. Chaves com ponto criam objetos aninhados.

## Saldo

Mostre o saldo da sua conta CometAPI ou a visualização de faturamento da chave de API atual.

```bash theme={null}
cometapi balance
cometapi balance --source account
cometapi balance --source key
cometapi balance --json
```

| Option     | Short | Description                        |
| ---------- | ----- | ---------------------------------- |
| `--source` | `-s`  | Fonte de dados: `account` ou `key` |
| `--format` | `-f`  | Formato de saída                   |
| `--json`   |       | Exibe como JSON                    |

## Conta

Mostre o perfil da sua conta. Requer um token de acesso.

```bash theme={null}
cometapi account
cometapi account --json
```

## Estatísticas

Mostre estatísticas de uso. Requer um token de acesso.

```bash theme={null}
cometapi stats
cometapi stats --json
```

## Tokens

Liste e pesquise chaves de API. Requer um token de acesso.

```bash theme={null}
cometapi tokens
cometapi tokens --search project
cometapi tokens --json
```

| Option     | Short | Description               |
| ---------- | ----- | ------------------------- |
| `--search` | `-s`  | Palavra-chave de pesquisa |
| `--page`   | `-p`  | Número da página          |
| `--limit`  | `-l`  | Resultados por página     |
| `--format` | `-f`  | Formato de saída          |
| `--json`   |       | Exibe como JSON           |

## Logs

Navegue pelos logs de uso com filtros. Requer um token de acesso.

```bash theme={null}
cometapi logs
cometapi logs --model your-model-id
cometapi logs --start 2026-04-01 --end 2026-04-14
cometapi logs --type consume
cometapi logs --export > usage.csv
cometapi logs --limit 50 --json
cometapi logs --request-id 20260617165550885561292gJBlzjtp
```

| Option         | Short | Description                                           |
| -------------- | ----- | ----------------------------------------------------- |
| `--model`      | `-m`  | Filtrar por model ID                                  |
| `--token-name` | `-t`  | Filtrar por nome da API key                           |
| `--type`       |       | Tipo de log                                           |
| `--search`     | `-s`  | Palavra-chave de busca                                |
| `--start`      |       | Data de início                                        |
| `--end`        |       | Data de término                                       |
| `--group`      | `-g`  | Filtrar por grupo de API key                          |
| `--request-id` |       | Consultar uma solicitação por `X-Cometapi-Request-Id` |
| `--page`       | `-p`  | Número da página                                      |
| `--limit`      | `-l`  | Resultados por página                                 |
| `--export`     |       | Enviar CSV do lado do servidor para stdout            |
| `--format`     | `-f`  | Formato de saída                                      |
| `--json`       |       | Saída como JSON                                       |

`logs --request-id` executa uma busca indexada no endpoint de log do operador e
aceita apenas uma correspondência exata de `request_id`. A CLI não varre páginas de log de fallback,
porque o endpoint de self-log não aplica filtragem por `request_id`.

## Tasks

Mostra logs de tarefas assíncronas. Requer um token de acesso.

```bash theme={null}
cometapi tasks
cometapi tasks --platform kling
cometapi tasks --status SUCCESS
cometapi tasks --json
```

| Option       | Short | Description              |
| ------------ | ----- | ------------------------ |
| `--platform` | `-p`  | Filtrar por plataforma   |
| `--task-id`  |       | Filtrar por ID da tarefa |
| `--status`   | `-s`  | Filtrar por status       |
| `--action`   | `-a`  | Filtrar por tipo de ação |
| `--start`    |       | Data de início           |
| `--end`      |       | Data de término          |
| `--page`     |       | Número da página         |
| `--limit`    | `-l`  | Resultados por página    |
| `--format`   | `-f`  | Formato de saída         |
| `--json`     |       | Saída como JSON          |

## Doctor

Execute diagnósticos para verificar a configuração e a conectividade com a API.

```bash theme={null}
cometapi doctor
cometapi doctor --json
```

## Config

Gerencie a configuração da CLI armazenada em `~/.config/cometapi/config.toml`.

```bash theme={null}
cometapi config show
cometapi config set api_key "$COMETAPI_KEY"
cometapi config set default_model your-model-id
cometapi config unset api_key
cometapi config path
```

Consulte o [guia de configuração](/pt/libraries/cli/configuration) para ver todas as chaves disponíveis.

## Init

Execute o assistente de configuração interativo:

```bash theme={null}
cometapi init
```

## Repl

Inicie um shell de comandos interativo completo:

```bash theme={null}
cometapi repl
```

## Output formats

A maioria dos comandos de dados oferece suporte a `--json` ou `--format`:

```bash theme={null}
cometapi models --json
cometapi models --format yaml
cometapi stats --format csv
cometapi account --format markdown
```

| Format     | Description                   |
| ---------- | ----------------------------- |
| `table`    | Tabela rica no terminal       |
| `json`     | Saída JSON                    |
| `yaml`     | Saída YAML                    |
| `csv`      | Valores separados por vírgula |
| `markdown` | Tabela Markdown               |
