Instalar o gsutil

Nesta página, descrevemos a instalação e a configuração da gsutil, uma ferramenta que permite acessar o Cloud Storage pela linha de comando usando HTTPS.

A instalação do gsutil oferece acesso imediato a dados públicos, permitindo que você leia e grave conforme permitido. Para interagir com os dados protegidos compartilhados com você, é necessário fazer a autenticação no serviço do Cloud Storage. Ao ativar o faturamento, você pode criar e gerenciar seus próprios buckets.

Requisitos do sistema

  • A ferramenta gsutil é executada em Linux/Unix, Mac OS e Windows (XP ou posterior).

  • As versões 5.35 ou mais recentes do gsutil exigem o Python 3.9 a 3.13, que pode ser obtido usando o gerenciador de versões do Python ou instalando uma versão adequada.

As instruções a seguir mostram como gerenciar as versões do Python:

Linux

Pré-requisitos: instale um gerenciador de versões do Python (pyenv) e uma versão adequada do Python.

  1. Defina a versão global do Python:
    • Para definir o Python 3.13 como a versão global:
      pyenv global 3.13
    • Ou defina a versão do Python localmente para uma pasta de projeto específica:
      pyenv local 3.13
  2. Confirme se a versão correta do Python está sendo usada:
    python --version

    Você verá:

    Python 3.13
macOS

Método 1: usar o Homebrew (brew)

Pré-requisitos: instale o Homebrew e uma versão adequada do Python usando o Homebrew.

  1. Defina uma versão específica do Python como padrão:
    • Adicione a versão que você quer ao $PATH. Por exemplo, para usar o Python 3.13:
      export PATH="/usr/local/opt/python@3.13/bin:$PATH"
    • Para tornar essa mudança permanente, adicione o caminho ao arquivo de configuração do shell (~/.bash_profile, ~/.zshrc ou ~/.bashrc).
  2. Confirme se a versão correta do Python está sendo usada:
    python --version

    Você verá:

    Python 3.13

Método 2: usar o pyenv

Pré-requisitos: instale um gerenciador de versões do Python (pyenv) e uma versão adequada do Python usando o pyenv.

  1. Defina a versão global do Python:
    • Para definir a versão do Python globalmente (para todos os terminais):
      pyenv global 3.13
    • Ou defina a versão do Python localmente para uma pasta de projeto específica:
      pyenv local 3.13
  2. Confirme se a versão correta do Python está sendo usada:
    python --version

    Você verá:

    Python 3.13
Windows

Pré-requisitos: instale o gerenciador de versões do Python (pyenv-win) e uma versão adequada do Python usando o pyenv.

  1. Defina a versão global do Python:
    • Para definir o Python 3.13 como a versão global:
      pyenv global 3.13
    • Ou defina a versão do Python localmente para uma pasta de projeto específica:
      pyenv local 3.13
  2. Confirme se a versão correta do Python está sendo usada:
    python --version

    Você verá:

    Python 3.13
  • Se você pretende usar objetos compostos, precisará instalar o crcmod compilado. No Windows, ele está disponível apenas para o Python de 32 bits. Para mais informações sobre o crcmod, instale o gsutil e consulte o tópico de ajuda usando o comando gsutil help crc32c.

Como instalar o gsutil

O método de instalação e atualização do gsutil com suporte oficial faz parte da CLI do Google Cloud.

Antes de começar

A Google Cloud CLI e o gsutil têm dependências de versão do Python que podem causar problemas de compatibilidade. A Google Cloud CLI requer Python 3.9 a 3.14, enquanto a gsutil requer Python 3.9 a 3.13.

Para instalar o gsutil, recomendamos que você faça isso como parte da Google Cloud CLI. Se você optar por instalar o gsutil diretamente, use o Python 3.9 a 3.13 para evitar problemas de compatibilidade.

Como instalar o gsutil como parte da CLI do Google Cloud

Siga as instruções do seu sistema operacional para instalar o gsutil como parte da CLI do Google Cloud:

Linux
  1. Confirme se você tem uma versão compatível do Python. A CLI do Google Cloud requer o Python de 3.9 a 3.14. O pacote Linux x86_64 inclui um intérprete de Python em pacote que terá preferência por padrão. Para informações sobre como escolher e configurar o interpretador do Python, consulte a documentação do gcloud topic startup.
  2. Faça o download de um dos seguintes itens:
    Plataforma Nome do pacote Tamanho Soma de verificação SHA256
    Linux de 64 bits

    (x86_64)

    google-cloud-cli-linux-x86_64.tar.gz 203,0 MB 8a26504b012f9b92b94d149007ed55822d5f866425cd3838dbe85f46c102458c
    Linux de 64 bits

    (Arm)

    google-cloud-cli-linux-arm.tar.gz 57,9 MB 019c831d690e3670843176b9acbe7bfa6cd9514a6de72510e84de9aecb768d9f
    Linux de 32 bits

    (x86)

    google-cloud-cli-linux-x86.tar.gz 57,9 MB 55a68d549e95b9b5eda2c097cbee7e22828b2181bcba9d41692d47ac136b016e

    Para fazer o download do arquivo do Linux, execute o seguinte comando:

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-cli-linux-x86_64.tar.gz

    Consulte a tabela acima e substitua google-cloud-cli-linux-x86_64.tar.gz pelo nome do pacote *.tar.gz que se aplica à sua configuração.

  3. Para extrair o conteúdo do arquivo para o sistema de arquivos, execute o seguinte comando:
    tar -xf google-cloud-cli-linux-x86_64.tar.gz
    Para substituir uma instalação, exclua o diretório google-cloud-sdk e extraia o arquivo para o mesmo local.
  4. Execute o script de instalação na raiz da pasta extraída:
    ./google-cloud-sdk/install.sh
    O script pede que você execute as seguintes ações de configuração. Para aceitar, responda Y quando solicitado.
    • Adicione a CLI gcloud ao seu PATH.
    • Ative o preenchimento de comandos.
    • Ative o envio de estatísticas de uso anônimas para ajudar a melhorar a gcloud CLI.
    Também é possível fazer a instalação de forma não interativa fornecendo flags. Para conferir as flags disponíveis, execute:
    ./google-cloud-sdk/install.sh --help
  5. Opcional: se você atualizou o PATH na etapa anterior, abra um novo terminal para que as mudanças entrem em vigor.
  6. Execute gcloud init para inicializar, autorizar e configurar a CLI gcloud.
  7. Opcional: instale componentes extras usando o gerenciador de componentes.
Debian/Ubuntu

Conteúdo do pacote

A CLI gcloud está disponível no formato de pacote para instalação em sistemas Debian e Ubuntu. O pacote contém apenas as ferramentas de linha de comando gcloud, gcloud alpha, gcloud beta, gsutil e bq. Ele não inclui kubectl ou as extensões do App Engine necessárias para implantar um aplicativo usando os comandos gcloud. Se você quiser esses componentes, instale-os separadamente.

Antes de começar

Antes de instalar a gcloud CLI, verifique se o sistema operacional atende aos seguintes requisitos:

  • É uma versão do Ubuntu que não atingiu o fim da vida útil ou uma versão estável do Debian que não atingiu o fim da vida útil.
  • Recentemente, os pacotes foram atualizados. Para fazer isso agora, execute o seguinte comando:
    sudo apt-get update
  • Ele tem apt-transport-https, ca-certificates, gnupg e curl instalados. Para instalar esses pacotes, execute o seguinte comando:
    sudo apt-get install apt-transport-https ca-certificates gnupg curl

Instalação

  1. Importe a Google Cloud chave pública.
    • Para distribuições mais recentes (Debian 9+ ou Ubuntu 18.04+), execute o seguinte comando:

      curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg
    • Para distribuições mais antigas, execute o seguinte comando:
      curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key --keyring /usr/share/keyrings/cloud.google.gpg add -
    • Se o comando apt-key da sua distribuição não for compatível com o argumento --keyring, execute o seguinte comando:

      curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -
    • Se não for possível receber as atualizações mais recentes devido a uma chave expirada, consiga o arquivo de chave apt-get.gpg mais recente.

  2. Adicione o URI de distribuição da CLI gcloud como uma origem de pacote.
    • Para distribuições mais recentes (Debian 9+ ou Ubuntu 18.04+), execute o seguinte comando:
      echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
    • Para distribuições mais antigas que não são compatíveis com a opção "assinado por", execute o seguinte comando:

      echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list
  3. Atualize e instale a gcloud CLI:
    sudo apt-get update && sudo apt-get install google-cloud-cli
    Para mais opções de apt-get, como desativar prompts ou simulações, consulte as apt-get páginas do manual de.

    Dica do Docker: se você estiver instalando a gcloud CLI dentro de uma imagem Docker, use uma única etapa RUN:

    RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg && apt-get update -y && apt-get install google-cloud-cli -y
        
    Para imagens de base mais antigas que não são compatíveis com o comando gpg --dearmor:
    RUN echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee -a /etc/apt/sources.list.d/google-cloud-sdk.list && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key --keyring /usr/share/keyrings/cloud.google.gpg  add - && apt-get update -y && apt-get install google-cloud-cli -y
          
  4. Opcional: instale qualquer um dos seguintes componentes adicionais:
    • google-cloud-cli-anthos-auth
    • google-cloud-cli-app-engine-go
    • google-cloud-cli-app-engine-grpc
    • google-cloud-cli-app-engine-java
    • google-cloud-cli-app-engine-python
    • google-cloud-cli-app-engine-python-extras
    • google-cloud-cli-bigtable-emulator
    • google-cloud-cli-cbt
    • google-cloud-cli-cloud-build-local
    • google-cloud-cli-cloud-run-proxy
    • google-cloud-cli-config-connector
    • google-cloud-cli-datastore-emulator
    • google-cloud-cli-firestore-emulator
    • google-cloud-cli-gke-gcloud-auth-plugin
    • google-cloud-cli-kpt
    • google-cloud-cli-kubectl-oidc
    • google-cloud-cli-local-extract
    • google-cloud-cli-minikube
    • google-cloud-cli-nomos
    • google-cloud-cli-pubsub-emulator
    • google-cloud-cli-skaffold
    • google-cloud-cli-spanner-emulator
    • google-cloud-cli-terraform-validator
    • google-cloud-cli-tests
    • kubectl

    Por exemplo, o componente google-cloud-cli-app-engine-java pode ser instalado da seguinte maneira:

    sudo apt-get install google-cloud-cli-app-engine-java
  5. Execute gcloud init para inicializar, autorizar e configurar a CLI gcloud.

Fazer downgrade das versões da gcloud CLI

Para reverter para uma versão específica da CLI gcloud, em que VERSION é do formulário 123.0.0, execute o seguinte comando:

sudo apt-get update && sudo apt-get install google-cloud-cli=123.0.0-0

As dez versões mais recentes estão sempre disponíveis no repositório. Para versões anteriores a 371.0.0, o nome do pacote é google-cloud-sdk

Red Hat/Fedora/CentOS

Conteúdo do pacote

A CLI gcloud está disponível no formato de pacote para instalação no Red Hat Enterprise Linux 7, 8, 9 e 10; Fedora 41 e 42; e CentOS 7 e 8. O pacote contém apenas os comandos gcloud, gcloud alpha, gcloud beta, gsutil e bq. Ele não inclui kubectl ou as extensões do App Engine necessárias para implantar um aplicativo usando comandos gcloud, que podem ser instalados separadamente conforme descrito posteriormente nesta seção.

Instalação

  1. Atualize o DNF com informações de repositório da gcloud CLI.
    • O comando de exemplo a seguir é para instalações compatíveis com o Red Hat Enterprise Linux 7, 8 ou 9, mas certifique-se de atualizar as configurações conforme necessário para sua configuração:

      sudo tee -a /etc/yum.repos.d/google-cloud-sdk.repo << EOM
      [google-cloud-cli]
      name=Google Cloud CLI
      baseurl=https://packages.cloud.google.com/yum/repos/cloud-sdk-el9-x86_64
      enabled=1
      gpgcheck=1
      repo_gpgcheck=0
      gpgkey=https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
      EOM
    • Para instalações compatíveis com o RHEL 10, use o seguinte comando com o gpgkey atualizado:

      sudo tee -a /etc/yum.repos.d/google-cloud-sdk.repo << EOM
      [google-cloud-cli]
      name=Google Cloud CLI
      baseurl=https://packages.cloud.google.com/yum/repos/cloud-sdk-el10-x86_64
      enabled=1
      gpgcheck=1
      repo_gpgcheck=0
      gpgkey=https://packages.cloud.google.com/yum/doc/rpm-package-key-v10.gpg
      EOM
  2. Instale libxcrypt-compat.x86_64.
    sudo dnf install libxcrypt-compat.x86_64
  3. Instale a CLI gcloud.
    sudo dnf install google-cloud-cli
  4. Opcional: instale qualquer um dos seguintes componentes adicionais:
    • google-cloud-cli-anthos-auth
    • google-cloud-cli-app-engine-go
    • google-cloud-cli-app-engine-grpc
    • google-cloud-cli-app-engine-java
    • google-cloud-cli-app-engine-python
    • google-cloud-cli-app-engine-python-extras
    • google-cloud-cli-bigtable-emulator
    • google-cloud-cli-cbt
    • google-cloud-cli-cloud-build-local
    • google-cloud-cli-cloud-run-proxy
    • google-cloud-cli-config-connector
    • google-cloud-cli-datastore-emulator
    • google-cloud-cli-firestore-emulator
    • google-cloud-cli-gke-gcloud-auth-plugin
    • google-cloud-cli-kpt
    • google-cloud-cli-kubectl-oidc
    • google-cloud-cli-local-extract
    • google-cloud-cli-minikube
    • google-cloud-cli-nomos
    • google-cloud-cli-pubsub-emulator
    • google-cloud-cli-skaffold
    • google-cloud-cli-spanner-emulator
    • google-cloud-cli-terraform-validator
    • google-cloud-cli-tests
    • kubectl

    Por exemplo, para instalar o componente google-cloud-cli-app-engine-java, execute o seguinte comando:

    sudo dnf install google-cloud-cli-app-engine-java
  5. Execute gcloud init para inicializar, autorizar e configurar a CLI gcloud.

Fazer downgrade das versões da gcloud CLI

Para reverter para uma versão específica da CLI gcloud, execute o seguinte comando. Substitua 123.0.0 pela versão que você quer instalar:

sudo dnf downgrade google-cloud-cli-123.0.0

As dez versões mais recentes estão disponíveis no repositório. Para versões anteriores a 371.0.0, use google-cloud-sdk como o nome do pacote.

macOS
  1. Confirme se você tem uma versão compatível do Python. A CLI do Google Cloud requer o Python de 3.9 a 3.14.

    Para verificar a versão do Python, execute python3 -V ou python -V.

    O script de instalação pode instalar o Python para você, se necessário. Isso exige as ferramentas de linha de comando do Xcode. Para instalá-los, execute sudo xcode-select --install. Como alternativa, você pode instalar uma versão compatível do Python em python.org.

    Para mais informações sobre como configurar o interpretador do Python, especialmente se você tiver várias versões instaladas, consulte a documentação do gcloud topic startup.

  2. Faça o download de um dos seguintes itens:
    Plataforma Pacote Tamanho Soma de verificação SHA256
    macOS de 64 bits

    (x86_64)

    google-cloud-cli-darwin-x86_64.tar.gz 58 MB ad200e25f088c5e10bcfe36d29169becb0fb5af5f920b03d64959173b5de07dd
    macOS de 64 bits

    (ARM64, Apple silicon)

    google-cloud-cli-darwin-arm.tar.gz 57,9 MB 0201e3ef794da5c5e1f9dc84c5525f56147e4c273895df649b443c085794221d
    macOS de 32 bits

    (x86)

    google-cloud-cli-darwin-x86.tar.gz 56,4 MB 97842affe829f306731022a90607929acbfc66f7d9318676c2076fcd665d190b

    Como alternativa, faça o download do arquivo na linha de comando. Substitua FILE_NAME pelo nome do pacote da sua plataforma na tabela acima.

    curl -O https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/FILE_NAME
  3. Extraia o conteúdo do arquivo para o local de sua preferência no sistema de arquivos. Uma prática comum é extrair para o diretório inicial.

    No macOS, isso pode ser feito abrindo o arquivo .tar.gz salvo no local de preferência. Outra opção é executar o seguinte na linha de comando:

    tar -xf FILE_NAME

    Para substituir uma instalação, exclua o diretório google-cloud-sdk e extraia o arquivo para o mesmo local.

  4. Execute o script de instalação na raiz da pasta extraída:
    ./google-cloud-sdk/install.sh
    O script pede que você execute as seguintes ações de configuração. Para aceitar, responda Y quando solicitado.
    • Instale o Python 3.13 e os módulos recomendados, se necessário.
    • Adicione a CLI gcloud ao PATH e ative o preenchimento de comandos.
    • Ative o envio de estatísticas de uso anônimas para ajudar a melhorar a gcloud CLI.
    Também é possível fazer a instalação de forma não interativa fornecendo flags. Para conferir as flags disponíveis, execute:
    ./google-cloud-sdk/install.sh --help
    Para executar o script de instalação com o modo de leitor de tela ativado:
    ./google-cloud-sdk/install.sh --screen-reader=true
  5. Opcional: se você atualizou o PATH na etapa anterior, abra um novo terminal para que as mudanças entrem em vigor.
  6. Execute gcloud init para inicializar, autorizar e configurar a CLI gcloud.
  7. Opcional: instale componentes extras usando o gerenciador de componentes.
Windows

A CLI do Google Cloud no Windows exige o Windows 8.1 e versões mais recentes ou o Windows Server 2012 e versões mais recentes.

  1. Faça o download do Instalador da CLI do Google Cloud.

    Se preferir, abra um terminal do PowerShell e execute os comandos a seguir:

    (New-Object Net.WebClient).DownloadFile("https://dl.google.com/dl/cloudsdk/channels/rapid/GoogleCloudSDKInstaller.exe", "$env:Temp\GoogleCloudSDKInstaller.exe")
    
    & $env:Temp\GoogleCloudSDKInstaller.exe
        
  2. Inicie o instalador e siga os prompts. O instalador é assinado pela Google LLC.

    • Se você estiver usando um leitor de tela, marque a caixa de seleção Ativar modo leitor de tela. Essa opção configura gcloud para usar rastreadores de status em vez de spinners unicode, exibir o progresso como uma porcentagem e nivelar tabelas. Para mais informações, consulte o Guia de recursos de acessibilidade.
    • A Google Cloud CLI requer Python. As versões compatíveis são Python 3.9 a 3.14. Por padrão, a versão para Windows da Google Cloud CLI vem com o Python 3. Para usar a CLI do Google Cloud, seu sistema operacional precisa executar uma versão compatível do Python.
    • O instalador instala todas as dependências necessárias, incluindo a versão necessária do Python. Embora a CLI do Google Cloud instale e gerencie o Python 3 por padrão, é possível usar uma instalação atual do Python ao desmarcar a opção de instalar o Bundled Python, se necessário. Consulte gcloud topic startup para saber como usar uma instalação existente do Python.
  3. Depois que a instalação for concluída, o instalador oferecerá a opção de criar os atalhos do menu e da área de trabalho, iniciar o shell da CLI do Google Cloud e configurar a CLI gcloud. Deixe as opções para iniciar o shell e configurar a instalação selecionadas. O instalador abre uma janela de terminal e executa o comando gcloud init para inicializar, autorizar e configurar a CLI gcloud.
  4. A instalação padrão não inclui as extensões do App Engine necessárias para implantar um aplicativo usando comandos gcloud. Para instalar esses componentes, use o gerenciador de componentes da CLI gcloud.

Dicas para solução de problemas

  • Se a instalação não for bem-sucedida devido ao comando find não ter sido reconhecido, verifique se sua variável de ambiente PATH está definida para incluir a pasta que contém find. Geralmente, isso é C:\WINDOWS\system32;.
  • Se você desinstalou a CLI gcloud, é necessário reinicializar o sistema antes de instalá-la novamente.
  • Se a descompactação falhar, execute o instalador como um administrador.

Como parte da instalação do gsutil, defina a variável de ambiente CLOUDSDK_PYTHON para usar a versão correta do Python. Para mais detalhes, consulte gcloud startup topic.

Execute as atualizações com o comando components update: gcloud components update.

Como configurar credenciais para acessar dados protegidos

Para acessar dados protegidos ou gravar em um bucket protegido, é necessário configurar as credenciais (autenticar). Por exemplo, se outra pessoa criou uma conta do Cloud Storage e fez upload de dados que só podem ser acessados por você ou por outras pessoas específicas, configure suas credenciais para que o serviço do Cloud Storage consiga acessar esses dados.

Ao usar o gsutil como parte da CLI do Google Cloud, o OAuth2 é usado para autenticar e autorizar o acesso aos recursos do Cloud Storage. Para estabelecer o acesso, execute o comando gcloud init e siga as instruções fornecidas na linha de comando, que incluem o login na sua conta de usuário. Se você seguiu as etapas de instalação, provavelmente já fez essa configuração. Se você executou gcloud init anteriormente, ao executar o comando novamente, será perguntado se quer reinicializar a configuração ou criar uma nova. Para mais informações, consulte Inicializar a Google Cloud CLI.

Isso é tudo! Já é possível acessar os dados protegidos. Para ver uma lista de comandos gsutil, digite gsutil no prompt de comando.

Solução de problemas

Se você tentar autenticar o gsutil usando o comando gcloud init, mas ainda não conseguir acessar os buckets ou objetos esperados, seu sistema poderá ter a versão legada e autônoma do gsutil e o Google Versão do pacote da CLI do Cloud gsutil instalada. Execute o comando gsutil version -l e verifique o valor de using cloud sdk. Se for False, seu sistema estará usando a versão autônoma da gsutil ao executar comandos. É recomendável remover a versão autônoma da gsutil do sistema. No entanto, você também pode autenticar usando gsutil config -a ou gsutil config -e.

Autenticar com HMAC

O OAuth 2.0 é o meio de autenticação recomendado para o gsutil. No entanto, também é possível usar chaves HMAC como credenciais. Para autenticar com HMAC, use o seguinte comando:

gsutil config -a

Esse comando direciona você para um processo de autenticação em que é solicitado o ID de acesso e o secret associados à sua chave HMAC.

Ao autenticar com chaves HMAC, desative a transmissão de credenciais da CLI do Google Cloud usando o comando: gcloud config set pass_credentials_to_gsutil false.

Ativar o mTLS

Também é possível ativar o TLS mútuo (mTLS, na sigla em inglês). Quando o mTLS está ativado no dispositivo, ele tenta se conectar ao endpoint de solicitação mTLS para a API JSON. Antes que a conexão seja permitida, o Cloud Storage verifica o certificado no dispositivo.

A maneira mais simples de conseguir um certificado é pela CLI do Google Cloud. É possível definir um manualmente no arquivo .boto definindo os seguintes valores em "Credentials":

  1. use_client_certificate: uma sinalização que controla se o mTLS será usado ou não
  2. cert_provider_command: um comando de shell que imprime um certificado no stdout para que a gsutil leia.

Faça um teste

Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho do Cloud Storage em situações reais. Clientes novos recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

Faça uma avaliação gratuita do Cloud Storage