Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Usar o GitHub Codespaces no IDE do JetBrains

É possível usar o JetBrains Gateway para se conectar a um codespace e trabalhar no seu IDE do JetBrains preferencial.

Observação: o uso dos GitHub Codespaces com IDEs do JetBrains está em versão beta pública e sujeito a alterações no momento.

Sobre o Codespaces em IDEs do JetBrains

Se você usa um IDE do JetBrains para trabalhar com códigos, também pode aproveitá-lo para trabalhar em um codespace. Para isso, você usa o aplicativo JetBrains Gateway.

Depois de instalar o JetBrains Gateway, é possível definir o JetBrains como o editor padrão para que, sempre que um codespace do GitHub.com for aberto, o JetBrains Gateway seja iniciado a fim de permitir a escolha do IDE do JetBrains para conetar-se ao codespace.

Observação: somente os codespaces existentes estão disponíveis no JetBrains Gateway. É possível criar codespaces no GitHub.com ou usando a GitHub CLI. Para obter mais informações, confira "Como criar um codespace para um repositório".

O processo de conexão de desenvolvimento remoto do JetBrains

Veja a seguir o processo básico por trás do uso de um codespace no IDE do JetBrains.

  • No aplicativo JetBrains Gateway, você seleciona um dos codespaces ativos ou parados.
  • Em seguida, escolhe qual IDE do JetBrains será usado.
  • Depois disso, o IDE do JetBrains selecionado é baixado na máquina virtual remota que hospeda o codespace e o código-fonte.
  • Em seguida, o aplicativo thin client do JetBrains é baixado no computador local e iniciado.
  • Esse aplicativo cliente se conecta ao IDE de back-end completo.
  • É possível trabalhar em seu código no aplicativo cliente da mesma maneira que você faria em um ambiente local.

Pré-requisitos

Para trabalhar com um codespace em um IDE do JetBrains, o seguinte é necessário:

  • Uma licença válida do JetBrains
  • O aplicativo JetBrains Gateway.
  • GitHub CLI versão 2.18.0 ou mais recente
  • Um codespace existente que esteja executando um servidor SSH

Licença do JetBrains

É necessário ter uma licença para pelo menos um dos IDEs do JetBrains compatíveis a fim de se conectar a um codespace do JetBrains Gateway.

JetBrains Gateway

É possível instalar e atualizar o JetBrains Gateway por meio do aplicativo JetBrains Toolbox.

  1. Baixe e instale o JetBrains Toolbox.

  2. Abra o JetBrains Toolbox.

  3. Encontre Gateway na lista de ferramentas disponíveis e clique em Instalar.

    Captura de tela do JetBrains Toolbox

GitHub CLI

O plug-in do GitHub Codespaces para JetBrains Gateway requer a instalação e configuração da GitHub CLI versão 2.18.0 ou mais recente para que seja possível abrir um codespace no JetBrains Gateway.

Use este comando para verificar a versão da GitHub CLI:

Shell
gh --version

Para saber mais, confira "Sobre a CLI do GitHub".

Codespace executando um servidor SSH

É necessário que haja um codespace existente para se conectar. Você pode criar um codespace em GitHub.com, em Visual Studio Code, ou usando GitHub CLI. Para saber mais, confira "Criar um codespace para um repositório".

O codespace ao qual você se conecta precisa estar executando um servidor SSH. A imagem de contêiner padrão inclui um servidor SSH, que é iniciado automaticamente. Se os codespaces não forem criados com base na imagem padrão, você poderá instalar e iniciar um servidor SSH adicionando o seguinte ao objeto features no arquivo devcontainer.json.

"features": {
    ...
    "ghcr.io/devcontainers/features/sshd:1": {
        "version": "latest"
    },
    ...
}

Para saber mais sobre o arquivo devcontainer.json e a imagem de contêiner padrão, confira "Introdução aos contêineres de desenvolvimento".

Observação: para obter ajuda e se conectar ao codespace por SSH, confira "Solução de problemas de clientes do GitHub Codespaces".

Configurar o JetBrains Gateway

Ao usar o JetBrains Gateway para GitHub Codespaces pela primeira vez, é necessário instalar o plug-in do Codespaces. Também é necessário permitir que o JetBrains Gateway acesse o GitHub.com usando sua conta do GitHub.

  1. Abra o aplicativo JetBrains Gateway.

  2. Em Instalar mais provedores, clique no link Instalar para o GitHub Codespaces.

    Captura de tela da exibição inicial do JetBrains Gateway

  3. Clique em Conectar-se a um codespace.

    Captura de tela do Gateway com o botão “Conectar-se a um Codespace”

  4. Na caixa de diálogo "Bem-vindo ao JetBrains Gateway", clique em Entrar com o GitHub .

    Captura de tela do botão de entrada

  5. Clique no ícone ao lado do código de uso único para copiá-lo e, em seguida, clique no link de entrada.

    Captura de tela do código de entrada de uso único

  6. Se você não estiver conectado ao GitHub, a página de entrada será exibida.

    • Insira seus detalhes e clique em Entrar.
    • Verifique sua autenticação, por exemplo, inserindo um código de autenticação de dois fatores.
  7. Na página "Ativação do dispositivo", cole o código copiado e clique em Continuar.

  8. Se você pertencer a organizações, a página "Fazer logon único em suas organizações" será exibida. Clique em Autorizar ao lado das organizações que o JetBrains Gateway terá autorização para acessar e clique em Continuar.

  9. Na página "Autorizar o GitHub Codespaces para o JetBrains", clique em Autorizar o GitHub .

  10. Retorne ao aplicativo JetBrains Gateway e abra um codespace na lista de codespaces atualmente ativos ou parados (veja a etapa 3 do procedimento a seguir).

Abrir um codespace no IDE do JetBrains

Se você definiu o JetBrains Gateway como o editor padrão, ele será iniciado automaticamente quando você abrir um codespace no GitHub.com.

Se o JetBrains Gateway não for o editor padrão, ainda será possível abrir um codespace nele acessando a página "Seus codespaces" em github.com/codespaces e clicando nas reticências (...) à direita do codespace que você deseja abrir. Para saber mais, confira "Como abrir um codespace existente".

Como alternativa, também é possível abrir o JetBrains Gateway e selecionar um codespace existente, conforme descrito no procedimento a seguir.

  1. Abra o aplicativo JetBrains Gateway.

  2. Clique em Conectar-se a Codespaces .

    Captura de tela da exibição inicial do JetBrains Gateway

  3. Na lista "Seus codespaces", clique no codespace em que você deseja trabalhar.

    Captura de tela da lista de codespaces do JetBrains Gateway

  4. Na lista "IDEs disponíveis", clique no IDE do JetBrains que você deseja usar. O Gateway lembrará de sua escolha na próxima vez que você se conectar a um codespace.

    Captura de tela da lista de codespaces do JetBrains Gateway

  5. Clique em Conectar.

    Nota: se você estiver executando um firewall, na primeira vez que se conectar a um recurso remoto, poderá ser solicitado que você permita que o JetBrains Gateway se comunique pela rede.

    Na primeira vez que você se conectar a um codespace, o IDE de back-end será baixado no computador remoto. Isso pode levar alguns minutos. Na próxima vez que você se conectar ao mesmo codespace, essa etapa não será necessária, o que torna o processo de conexão mais rápido.

    Em seguida, o IDE de back-end é iniciado. Lembre-se de que essa etapa não será necessária no futuro se você estiver se reconectando a um IDE de back-end que ficou em execução.

    Depois disso, o aplicativo cliente é iniciado.

Leitura adicional