CLI em scripts e no CI

Este guia é para quem roda o Steel CLI onde não há ninguém para responder: scripts, cron e pipelines de CI. Fora de um terminal, o CLI não pergunta nada, não abre navegador e escreve JSON.

Crie o token do job

No CI não há navegador para o steel login. Use um token pessoal criado à mão:

1. No Steel, abra Configurações › Segurança › Tokens de API e clique em Criar token.
2. Dê um Nome que diga onde ele roda (por exemplo, "Deploy no GitHub Actions"), escolha o Workspace, só os Módulos de que o job precisa, o Nível de acesso (Ler e alterar, se o job cria ou altera algo) e a Validade.
3. Clique em Criar token e copie o valor (stl_pat_…) na hora. Ele não aparece de novo.
4. Guarde o valor como segredo do CI (no GitHub, em Settings › Secrets and variables › Actions) com o nome STEEL_TOKEN.

O token age em seu nome, com as suas permissões no workspace. Cada usuário pode ter até 50 tokens ativos. Os detalhes de escopos, módulos e validade estão em API pública v1.

Rode no GitHub Actions

O job abaixo abre um incidente no ServiceDesk quando o deploy falha:

# .github/workflows/deploy.yml (trecho)
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      # ... os passos do deploy ...
      - name: Abrir chamado se o deploy falhar
        if: failure()
        run: |
          npm install -g @steel-so/cli
          steel sd ticket create --type incidente \
            --title "Deploy falhou em ${{ github.ref_name }}" \
            --description "Execução: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
        env:
          STEEL_TOKEN: ${{ secrets.STEEL_TOKEN }}
          STEEL_URL: https://homologacao.stratustelecom.com.br

Fora de um terminal, as alterações não pedem confirmação, então --yes não é necessário. A exceção é steel webhooks endpoints delete, que num script só roda com --yes.

O ambiente do GitHub Actions define CI, então o CLI também não consulta versão nova. Para fixar a versão no job, use npm install -g @steel-so/cli@0.1.0.

Variáveis de ambiente