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

# CometAPI CLI

> Instale e use a interface de linha de comando do CometAPI para conversar com modelos, consultar metadados de modelos, executar requests multi-protocolo, verificar saldo e inspecionar o uso pelo terminal.

O [CometAPI CLI](https://pypi.org/project/cometapi-cli/) é a ferramenta oficial de linha de comando do CometAPI. Ela ajuda você a conversar com modelos, inspecionar o catálogo de modelos, enviar requests únicos, verificar saldo e consultar o uso da conta pelo terminal.

Use a [página do pacote no PyPI](https://pypi.org/project/cometapi-cli/) como página inicial pública para instalação e metadados do pacote. Esta documentação amplia os mesmos comandos sem exigir acesso ao repositório de código-fonte privado.

<Note>
  O CometAPI CLI está em beta. Os nomes dos comandos e as opções podem mudar enquanto a interface se estabiliza.
</Note>

## Features

* Converse com modelos usando saída em streaming ou um REPL interativo
* Navegue pelos metadados do catálogo de modelos, incluindo campos de provider, modality, endpoint, capability, context e pricing
* Inspecione um modelo com `cometapi model info <id>`
* Envie um request por meio dos formatos Chat Completions, Responses, Anthropic Messages ou Gemini Generate Content com `cometapi run`
* Verifique saldo, perfil da conta, estatísticas de uso, API keys, logs e histórico de tarefas assíncronas
* Exporte dados em tabela, JSON, YAML, CSV ou Markdown
* Armazene a configuração local em `~/.config/cometapi/config.toml`

## Prerequisites

* Python 3.10 ou superior
* Uma [CometAPI API key](https://www.cometapi.com/console/token)

## Install the CLI

Instale o pacote a partir do PyPI:

<CodeGroup>
  ```bash pip theme={null}
  pip install cometapi-cli
  ```

  ```bash pipx theme={null}
  pipx install cometapi-cli
  ```

  ```bash uv theme={null}
  uv tool install cometapi-cli
  ```
</CodeGroup>

Verifique o comando instalado:

```bash theme={null}
cometapi --version
cometapi -h
```

## Start using the CLI

<Steps>
  <Step title="Configure credentials">
    Execute o assistente de configuração:

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

    Você também pode configurar a API key com uma variável de ambiente:

    ```bash theme={null}
    export COMETAPI_KEY="your-api-key"
    ```

    O valor opcional `COMETAPI_ACCESS_TOKEN` é necessário apenas para os comandos de account, stats, tokens, logs e tasks.
  </Step>

  <Step title="Chat with a model">
    Envie uma mensagem de chat:

    ```bash theme={null}
    cometapi chat "Explique o CometAPI em uma frase."
    ```

    Execute `cometapi chat` sem uma mensagem para iniciar o REPL de chat.
  </Step>

  <Step title="Browse models">
    Pesquise o catálogo público de modelos:

    ```bash theme={null}
    cometapi models --search gpt --limit 10
    ```

    Filtre pelos metadados do catálogo:

    ```bash theme={null}
    cometapi models --provider openai --type chat --limit 10
    cometapi models --feature image --endpoint responses --json
    ```
  </Step>

  <Step title="Inspect one model">
    Mostre os metadados detalhados de um modelo:

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

    Exiba a carga bruta de detalhes:

    ```bash theme={null}
    cometapi model info your-model-id --json
    ```
  </Step>

  <Step title="Run a multi-protocol request">
    Envie um request único pelo endpoint padrão de chat:

    ```bash theme={null}
    cometapi run your-model-id -p "Responda apenas com OK."
    ```

    Selecione outro formato de endpoint quando o corpo da request seguir um schema diferente do provider:

    ```bash theme={null}
    cometapi run your-model-id --endpoint responses -p "Responda apenas com OK." --json
    cometapi run your-model-id --endpoint anthropic -p "Responda apenas com OK." -i max_tokens=32
    cometapi run your-model-id --endpoint gemini -p "Responda apenas com OK." -i generationConfig.maxOutputTokens=32
    ```
  </Step>
</Steps>

## Get command help

Use `-h` no comando raiz ou em qualquer subcomando para inspecionar as opções da versão instalada:

```bash theme={null}
cometapi -h
cometapi models -h
cometapi model info -h
cometapi run -h
```

## Comandos principais

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

## Links

* [Pacote PyPI](https://pypi.org/project/cometapi-cli/)
* [Referência de comandos](/pt/libraries/cli/commands)
* [Guia de configuração](/pt/libraries/cli/configuration)