AppleScript — Referência de comandos

Consulte as mesmas descrições de comandos e exemplos para copiar da seção Automação do app para Mac. As referências incluem os comandos existentes e as adições da versão 2.0.17.

Todas as explicações e scripts completos são sincronizados da referência incluída no app. Troque nomes e IDs de exemplo antes de executar. Os exemplos podem alterar conexões e ajustes reais; não execute a página inteira como um script.

Referência de comandos

Use a expressão do comando mostrada aqui. Coloque entre aspas o nome da conexão ou a tag do grupo.

start

Inicia o Secure Pipes sem mostrar a janela.

tell application "Secure Pipes" to start

show

Mostra a janela do Secure Pipes.

tell application "Secure Pipes" to show

hide

Oculta a janela enquanto o Secure Pipes e as conexões continuam em execução.

tell application "Secure Pipes" to hide

shutdown

Encerra o Secure Pipes e para as conexões ativas.

tell application "Secure Pipes" to shutdown

list connections

Lista as conexões salvas.

tell application "Secure Pipes" to list connections

list connection groups

Lista as tags usadas como grupos de conexões.

tell application "Secure Pipes" to list connection groups

connect connection "Build Tunnel (Local Forward)"

Inicia uma conexão salva.

tell application "Secure Pipes" to connect connection "Build Tunnel (Local Forward)"

disconnect connection "Build Tunnel (Local Forward)"

Para uma conexão salva.

tell application "Secure Pipes" to disconnect connection "Build Tunnel (Local Forward)"

connection status "Build Tunnel (Local Forward)"

Consulta o estado atual da conexão.

tell application "Secure Pipes" to connection status "Build Tunnel (Local Forward)"

connect group "engineering"

Inicia um grupo com as configurações salvas.

tell application "Secure Pipes" to connect group "engineering"

disconnect group "engineering"

Para o grupo e as conexões de seus membros.

tell application "Secure Pipes" to disconnect group "engineering"

Use o UUID da conexão nos scripts para que continuem funcionando após renomeá-la. Nomes exclusivos e nomes completos com o tipo também são aceitos. Se houver nomes duplicados, use um UUID.

Área de trabalho remota

list remote desktops

Listar conexões RDP/VNC salvas.

tell application "Secure Pipes" to list remote desktops

get remote desktop "<ID>"

Ler uma conexão por ID, sem credenciais.

tell application "Secure Pipes" to get remote desktop "DESKTOP-ID"

create remote desktop <JSON>

Criar com name e values. Use hostProfileUUID para um host predefinido.

tell application "Secure Pipes" to create remote desktop "{\"name\":\"Office desktop\",\"values\":{\"hostProfileUUID\":\"PRESET-HOST-ID\",\"remoteDesktopType\":\"rdp\",\"remoteDesktopUsername\":\"alice\",\"remoteHost\":\"192.168.1.91\"}}"

tell application "Secure Pipes" to create remote desktop "{\"name\":\"Office VNC\",\"values\":{\"hostProfileUUID\":\"PRESET-HOST-ID\",\"remoteDesktopType\":\"vnc\",\"remoteDesktopVNCOpenMode\":\"screenSharing\"}}"

update remote desktop <JSON>

Atualizar por id; name e values são opcionais.

tell application "Secure Pipes" to update remote desktop "{\"id\":\"DESKTOP-ID\",\"values\":{\"remoteDesktopOptions\":{\"screen mode id\":1,\"audiomode\":2}}}"

open remote desktop "<ID>"

Iniciar o túnel SSH se necessário e abrir o cliente RDP/VNC salvo.

tell application "Secure Pipes" to open remote desktop "DESKTOP-ID"

delete remote desktop "<ID>"

Excluir uma conexão desconectada pelo ID.

tell application "Secure Pipes" to delete remote desktop "DESKTOP-ID"

Nomes de usuário podem ser gravados, mas nunca são retornados. Defina senhas SSH e arquivos de identidade no Secure Pipes; digite a senha da área de trabalho no cliente.

Planos de tarefas

Criar e controlar ações agendadas. Leituras nunca retornam senhas ou conteúdo de chaves privadas.

list task plans

Listar planos como JSON sem dados sensíveis.

tell application "Secure Pipes" to list task plans

get task plan "work-start"

Ler por ID um plano como JSON sem dados sensíveis.

tell application "Secure Pipes" to get task plan "work-start"

create task plan <JSON>

Criar plano validado com IDs de conexão/grupo nas ações, sem credenciais.

tell application "Secure Pipes"
    create task plan "{\"id\":\"work-start\",\"hour\":9,\"minute\":0,\"repeat\":2,\"actions\":[{\"type\":\"start_group\",\"id\":\"work\"}]}"
end tell

update task plan <JSON>

Atualizar com ID existente e campos a alterar.

tell application "Secure Pipes"
    update task plan "{\"id\":\"work-start\",\"hour\":8,\"minute\":45,\"repeat\":2,\"actions\":[{\"type\":\"start_group\",\"id\":\"work\"}]}"
end tell

set task plan enabled "work-start"

Ativar/desativar sem alterar agenda. Parâmetro true por padrão.

tell application "Secure Pipes" to set task plan enabled "work-start" enabled false
tell application "Secure Pipes" to set task plan enabled "work-start" enabled true

run task plan "work-start"

Executar plano agora e retornar resultado JSON.

tell application "Secure Pipes" to run task plan "work-start"

delete task plan "work-start"

Excluir plano salvo por ID.

tell application "Secure Pipes" to delete task plan "work-start"

JSON aceita repeat 0–6, dias personalizados, períodos ISO 8601 ou YYYY-MM-DD e ações validadas. Primeiro obtenha IDs com list connections e list connection groups.

Regras e cenários de uso

Use um ID ou um nome exclusivo para alterar regras ou trocar de cenário. A troca encerra e restabelece as conexões ativas. Excluir um cenário mantém suas regras; as que não pertencem a outro cenário tornam-se comuns.

list proxy rules

Lista as regras em ordem com ID, nome, estado, ação e IDs de cenários.

tell application "Secure Pipes" to list proxy rules

list scenarios

Lista os cenários, incluindo Universal, com ID, nome e estado ativo.

tell application "Secure Pipes" to list scenarios

current scenario

Mostra o nome do cenário atualmente ativo.

tell application "Secure Pipes" to current scenario

switch scenario "Office"

Troca o cenário por ID ou nome único e reconecta as conexões afetadas com as regras selecionadas.

tell application "Secure Pipes" to switch scenario "Office"

enable proxy rule "Work websites"

Ativa uma regra por ID ou nome único.

tell application "Secure Pipes" to enable proxy rule "Work websites"

disable proxy rule "Work websites"

Desativa uma regra sem excluí-la.

tell application "Secure Pipes" to disable proxy rule "Work websites"

set rule scenarios "Work websites" scenarios {"Office", "Travel"}

Substitui os cenários atribuídos a uma regra. Universal torna a regra universal.

tell application "Secure Pipes" to set rule scenarios "Work websites" scenarios {"Office", "Travel"}

create scenario "Travel"

Cria um cenário com nome único e retorna seu ID.

tell application "Secure Pipes" to create scenario "Travel"

rename scenario "Travel" to "Mobile work"

Renomeia um cenário mantendo suas atribuições de regras.

tell application "Secure Pipes" to rename scenario "Travel" to "Mobile work"

delete scenario "Travel"

Exclui um cenário sem excluir suas regras. Regras sem outro cenário tornam-se universais.

tell application "Secure Pipes" to delete scenario "Travel"

Exemplo completo

tell application "Secure Pipes"
    set savedRules to list proxy rules
    set savedScenarios to list scenarios
    set selectedScenario to current scenario
    switch scenario "Office"
    enable proxy rule "Work websites"
    disable proxy rule "Work websites"
    set rule scenarios "Work websites" scenarios {"Office", "Travel"}
    set rule scenarios "Work websites" scenarios {}
    set newScenarioID to create scenario "Travel"
    rename scenario newScenarioID to "Mobile work"
    delete scenario newScenarioID
end tell

Proxy e compartilhamento de rede

O compartilhamento usa o endereço, a porta e a autenticação salvos. A janela de confirmação é aberta quando necessário. O modo gateway ainda exige confirmação de riscos e autorização do macOS.

list proxy servers

Lista os servidores proxy configurados com ID, nome, tipo e endereço, sem credenciais.

tell application "Secure Pipes" to list proxy servers

transparent proxy status

Mostra o estado do proxy transparente, da extensão do sistema e a compatibilidade das versões.

tell application "Secure Pipes" to transparent proxy status

initialize transparent proxy

Instala ou repara a extensão do sistema. O macOS pode pedir aprovação; isso não inicia o proxy transparente.

tell application "Secure Pipes" to initialize transparent proxy

start transparent proxy

Inicia o proxy transparente com as regras de roteamento atuais quando a extensão estiver pronta.

tell application "Secure Pipes" to start transparent proxy

stop transparent proxy

Para o proxy transparente. O compartilhamento de rede depende desse serviço.

tell application "Secure Pipes" to stop transparent proxy

network sharing status

Mostra os estados do compartilhamento e do gateway. Em execução, os modos são os efetivos; parado, são os salvos.

tell application "Secure Pipes" to network sharing status

set sharing modes "both"

Seleciona proxy, gateway, ambos ou desativado para a próxima inicialização manual. Pare o compartilhamento antes de alterar os modos.

tell application "Secure Pipes" to set sharing modes "both"

start network sharing

Inicia os modos selecionados com o endereço, a porta e a autenticação salvos. Pode ser necessária confirmação.

tell application "Secure Pipes" to start network sharing

stop network sharing

Para o gateway e o listener do proxy compartilhado. O proxy transparente continua em execução.

tell application "Secure Pipes" to stop network sharing

Exemplo completo

tell application "Secure Pipes"
    set servers to list proxy servers
    set proxyState to transparent proxy status
    initialize transparent proxy
    start transparent proxy
    set sharing modes "both"
    set sharingState to network sharing status
    start network sharing
    stop network sharing
    stop transparent proxy
end tell

Conexões, atividade e logs

Use os IDs das listas para consultar itens com precisão. Os detalhes são retornados como texto JSON.

group status "engineering"

Mostra o resultado do grupo e o estado de cada membro.

tell application "Secure Pipes" to group status "engineering"

wait for connection "Build Tunnel" timeout 30

Aguarda a conexão ficar pronta; falha ou tempo esgotado retorna um erro.

tell application "Secure Pipes" to wait for connection "Build Tunnel" timeout 30

preview route "example.com" port 443

Prevê a regra local no cenário atual; não testa a conectividade.

tell application "Secure Pipes" to preview route "example.com" port 443 application "com.apple.Safari" transport "TCP"

test proxy server "proxy-id"

Testa um proxy salvo e retorna resultado, motivo e duração.

tell application "Secure Pipes" to test proxy server "proxy-id"

list active flows "PROXY"

Mostra a atividade do proxy; LAN mostra o compartilhamento e ALL mostra ambos.

tell application "Secure Pipes" to list active flows "PROXY"

list active flows "LAN"

Mostra as conexões do compartilhamento de rede.

tell application "Secure Pipes" to list active flows "LAN"

end active flow "flow-id"

Encerra um fluxo conectado pelo ID.

tell application "Secure Pipes" to end active flow "flow-id"

list recent logs

Mostra até 200 logs recentes sem dados sensíveis, do mais novo para o mais antigo.

tell application "Secure Pipes" to list recent logs

log detail "log-id"

Mostra o registro completo de um log recente pelo ID.

tell application "Secure Pipes" to log detail "log-id"

Exemplos no Terminal

Execute um comando AppleScript no Terminal com osascript. O macOS pode pedir permissão para o Terminal controlar o Secure Pipes.

Listar grupos de conexões

osascript -e 'tell application "Secure Pipes" to list connection groups'

Exemplo de resultado

engineering, on-call

As tags determinam os membros do grupo. A inicialização segue a ordem, o modo paralelo ou sequencial e a política de erros salvos.

Iniciar ou parar um grupo

osascript -e 'tell application "Secure Pipes" to connect group "engineering"'
osascript -e 'tell application "Secure Pipes" to disconnect group "engineering"'

Consultar e controlar uma conexão

osascript -e 'tell application "Secure Pipes" to list connections'
osascript -e 'tell application "Secure Pipes" to connection status "Build Tunnel (Local Forward)"'
osascript -e 'tell application "Secure Pipes" to connect connection "Build Tunnel (Local Forward)"'

Executar pelo Terminal

Salve o arquivo e passe o caminho dele ao osascript:

osascript ~/Scripts/Connect\ Tunnel.applescript

Executar por arquivo de script

Salve um exemplo com a extensão .applescript e execute-o no Editor de Scripts ou com osascript.

Conectar pelo nome

Substitua o nome de exemplo por um nome retornado por list connections.

on run
    -- Leave this blank to skip opening a URL after connecting.
    set postConnectURL to ""
    -- Get the saved connections.
    tell application "Secure Pipes"
        set availableConnections to list connections
    end tell
    if (count of availableConnections) is 0 then return

    set selectedConnection to choose from list availableConnections
    if selectedConnection is false then return
    set targetConnection to item 1 of selectedConnection

    -- Start the selected connection and wait up to 90 seconds.
    tell application "Secure Pipes"
        connect connection targetConnection
        set currentState to "connecting"
        repeat with attempt from 1 to 90
            set currentState to connection status targetConnection
            if currentState is "connected" then exit repeat
            if currentState is "authentication failed" or currentState is "unknown host key" or currentState is "host key changed" or currentState is "invalid" or currentState is "error" then exit repeat
            delay 1
        end repeat
    end tell
    -- Open the URL only if the connection comes up.
    if currentState is "connected" and postConnectURL is not "" then
        open location postConnectURL
    end if
    return currentState
end run

Escolher e iniciar um grupo

Lista as tags disponíveis, permite escolher um grupo e inicia todas as conexões nele.

on run
    -- Get the groups saved in Secure Pipes.
    tell application "Secure Pipes"
        set availableGroups to list connection groups
    end tell
    -- Let the user know if there are no groups to choose from.
    if (count of availableGroups) is 0 then
        display dialog "No tagged connection groups are available." buttons {"OK"}
        return
    end if

    -- Ask which group to start.
    set selectedGroup to choose from list availableGroups
    if selectedGroup is false then return
    set targetGroup to item 1 of selectedGroup

    tell application "Secure Pipes"
        connect group targetGroup
    end tell
end run

Permissão de automação

Se o macOS solicitar, permita que o app que executa o script, como Terminal ou Editor de Scripts, controle o Secure Pipes em Ajustes do Sistema > Privacidade e Segurança > Automação.