O que é

A gws é a CLI do painel: pela linha de comando (SSH), ela executa as mesmas ações do
painel
, falando com o api.php em loopback — com os mesmos gates de permissão, jobs
assíncronos e auditoria da interface. É a base da automação por SSH ou agente.

Não confunda com o gws-cli, que é a ferramenta de emergência (senha, 2FA, unban). A gws
é a CLI de operação, autenticada por token escopado. Crie os tokens em
Automação e CLI.

Autenticação

A gws usa um token: /etc/gws-panel/machine-token (root), ~/.config/gws/token, ou o arquivo
apontado por $GWS_TOKEN_FILE. O token define o que aquele acesso pode fazer.

Estrutura dos comandos

Comando Para quê
gws actions Lista o que o token atual pode fazer
gws api <ação> [--chave valor ...] Chama qualquer ação do catálogo
gws api <ação> --wait Espera um job assíncrono terminar
gws api <ação> --json Saída em JSON
gws job status <id> Status/log de um job
gws job wait <id> [timeout] Espera um job terminar
gws help Ajuda

Qualquer ação do painel (as *_* do api.php) é chamável por gws api. Exemplos:

gws actions
gws api sites
gws api site_info --domain exemplo.com
gws api site_cache_purge --domain exemplo.com
gws api site_backup_run --domain exemplo.com --wait

Por que passa pela API

Como a gws fala com o mesmo api.php do painel, ela herda tudo: as permissões do token, a
fila de jobs, e o registro de auditoria. Uma ação feita por gws aparece nos
logs do painel como qualquer ação da interface.

Veja também