Skip to content

Repository files navigation

CI Release GitHub tag

tpsp

tpsp (acrônimo para "Transporte Público de São Paulo") é uma pequena aplicação de linha de comando que exibe o estado atual das linhas do Metro, CPTM, ViaMobilidade e ViaQuatro.

AVISO: Este projeto não possui relações com o Estado de São Paulo, a CPTM, o Metro ou qualquer outro órgão governamental.

Requerimentos

  • Go 1.26 ou superior (apenas para compilação)
  • just (apenas para compilação)
  • Docker (opcional, para uso via imagem de container)

Compilação

just build

O binário será gerado em bin/tpsp.

Uso

tpsp [service] [flags]

Services:
    metro          Exibe apenas linhas do Metro
    cptm           Exibe apenas linhas da CPTM
    viamobilidade  Exibe apenas linhas da ViaMobilidade
    viaquatro      Exibe apenas linhas da ViaQuatro

    Se nenhum serviço for especificado, todas as linhas são exibidas.

Flags:
    -j, --json     Exibe a saída em formato JSON
    -v, --version  Exibe a versão do programa
    -h, --help     Exibe a ajuda
    --copyright    Exibe informações de copyright

Exemplos

# Exibe o estado de todas as linhas
tpsp

# Exibe apenas as linhas do Metro
tpsp metro

# Exibe as linhas da CPTM em formato JSON
tpsp cptm --json

Saída de exemplo:

Linha              Status
---------------------------------
Azul               Operação Normal
Verde              Operação Normal
Vermelha           Operação Normal
Amarela            Operação Normal
Lilás              Operação Normal
Prata              Operação Normal

Saída em JSON

{
    "code": 200,
    "data": [
        {
            "line": "Azul",
            "status": "Operação Normal"
        },
        {
            "line": "Verde",
            "status": "Operação Normal"
        }
    ],
    "message": "success"
}

Docker

A imagem oficial do projeto é publicada no GitHub Container Registry:

docker pull ghcr.io/caian-org/tpsp:latest

Também é possível usar uma versão específica:

docker pull ghcr.io/caian-org/tpsp:v2.0.4

Exemplos:

# Exibe o estado de todas as linhas
docker run --rm ghcr.io/caian-org/tpsp:latest

# Exibe apenas as linhas do Metro
docker run --rm ghcr.io/caian-org/tpsp:latest metro

# Exibe as linhas da CPTM em formato JSON
docker run --rm ghcr.io/caian-org/tpsp:latest cptm --json

Licença

Na medida do permitido por lei, Caian Ertl renunciou a todos os direitos autorais e direitos conexos a este trabalho. No espírito de liberdade de informação, você é encorajado a clonar, modificar, distribuir, compartilhar ou fazer o que quiser com este projeto! ^C ^V

Licença

About

CLI para status das linhas de trem e metrô de São Paulo

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages