Saltar para o conteúdo principal

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.

A CLI do CometAPI lê definições de um arquivo de configuração TOML, de variáveis de ambiente e de flags de linha de comando. Quando a mesma definição está disponível em várias fontes, a ordem de prioridade é: Flags da CLI > arquivo de configuração > variáveis de ambiente > padrões

​
Arquivo de configuração

Localização: ~/.config/cometapi/config.toml Execute o assistente de configuração para criar o arquivo de configuração de forma interativa: 
cometapi init
Ou gerencie definições individuais com o subcomando config: 
# View current configuration
cometapi config show

# Set a value
cometapi config set api_key sk-...

# Remove a value
cometapi config unset api_key

# Show the config file path
cometapi config path

​
Definições disponíveis

Chave de configuraçãoVariável de ambienteDescrição
api_keyCOMETAPI_KEYAPI key (obrigatória para todos os comandos)
access_tokenCOMETAPI_ACCESS_TOKENAccess token para comandos no nível da conta
base_urlCOMETAPI_BASE_URLURL base da API (padrão: https://api.cometapi.com/v1)
default_modelCOMETAPI_DEFAULT_MODELModelo padrão para chat (fallback: gpt-5.4)
output_format—Formato de saída padrão: table, json, yaml, csv ou markdown

​
Credenciais

A CLI usa dois tipos de credenciais:

​
API key

Obrigatória para todos os comandos. A API key autentica solicitações para os endpoints de modelo do CometAPI. Crie uma API key em CometAPI Console → API Keys. Defina-a de uma destas formas: 
read -rsp "CometAPI API key: " COMETAPI_KEY
printf '\n'
export COMETAPI_KEY

​
Access token

Opcional. O access token é obrigatório para comandos no nível da conta: account, stats, tokens, logs e tasks. Gere um access token em CometAPI Console → Personal Settings. Defina-o de uma destas formas: 
export COMETAPI_ACCESS_TOKEN="your-access-token"

​
Segurança

A CLI aplica as seguintes práticas de segurança:
  • API keys e access tokens nunca são registrados em logs nem exibidos por completo. Apenas os últimos 4 caracteres são mostrados na saída de diagnóstico.
  • O arquivo de configuração é criado com permissões restritivas (0600) — legível apenas pelo proprietário do arquivo.
  • As credenciais nunca devem ser enviadas para o controle de versão. Adicione o caminho do arquivo de configuração ao seu .gitignore, se aplicável.
Você é responsável por todo o uso e cobranças gerados com suas API keys. Mantenha suas chaves seguras e faça a rotação delas se suspeitar de acesso não autorizado.

​
Solução de problemas

ErroSolução
API key not configuredExecute cometapi init ou defina a variável de ambiente COMETAPI_KEY
Connection failedExecute cometapi doctor para diagnosticar a conectividade
Access token not configuredNecessário apenas para account/stats/tokens/logs/tasks. Execute cometapi init para adicionar um