Skip to main content
Este guia leva um projeto da sua máquina até uma aplicação rodando na Square Cloud e depois mostra como enviar uma alteração. Leva poucos minutos.
1

Instale a CLI

Confira se ela funciona com squarecloud --version. Se o comando não for encontrado, veja Instalação.
2

Faça login

A CLI mostra um código curto e abre a página de autorização no seu navegador. Digite o código ali e aprove. A página de Autenticação explica as chaves de API e o uso no CI.
3

Adicione um arquivo de configuração

Na raiz do projeto, crie um arquivo squarecloud.app. Ele diz à Square Cloud qual arquivo executar, quanta memória reservar e qual versão do runtime usar:
squarecloud.app
Para um site, adicione SUBDOMAIN=<nome> para publicá-lo em <nome>.squareweb.app. Cada chave é explicada no guia do arquivo de configuração.
4

Envie o projeto

Na pasta do projeto, execute:
A CLI compacta a pasta, deixando de fora o que o squarecloud.ignore lista (além de node_modules, .git e os lockfiles, por padrão), e cria uma nova aplicação:
Saída
Ela também grava o ID da nova aplicação no seu arquivo de configuração, para que os próximos comandos saibam de qual aplicação você está falando:
squarecloud.app
5

Confira se ela está rodando

Nenhum ID é necessário: os dois comandos leem a linha ID=. Para acompanhar a saída ao vivo, execute squarecloud app realtime e pressione Ctrl+C para parar.
6

Envie uma alteração

Edite o seu código, envie a pasta para a mesma aplicação e reinicie-a:
O upload cria uma nova aplicação toda vez; o commit atualiza a que você já tem e mantém o ID, o domínio e as configurações dela.

​
Como a CLI encontra sua aplicação

Os comandos que agem sobre uma aplicação mostram [appID] no uso: o ID é opcional. A CLI escolhe a aplicação nesta ordem:
  1. O ID que você passa. Ele é o primeiro argumento, ou --app <appID> nos comandos cujos argumentos são outra coisa: app env set, remove e replace, todos os comandos app file, app deploy webhook, app deploy github link e unlink, e app network domain.
  2. A linha ID= do arquivo squarecloud.app da pasta atual (ou do squarecloud.config; quando os dois existem, o squarecloud.app tem prioridade).
  3. Um seletor com as suas aplicações, quando a CLI roda em um terminal. Use as setas e Enter; Esc cancela.
Alguns comandos funcionam de outro jeito:
  • O commit nunca abre o seletor. Sem um argumento ou uma linha ID=, ele para com código de saída 1 e pede um ID.
  • O app snapshot restore sempre recebe o ID da aplicação como primeiro argumento.
  • Bancos de dados não têm arquivo de configuração: os comandos db recebem o ID do banco de dados ou abrem um seletor com os seus bancos de dados.
  • Os comandos workspace que agem sobre um workspace sempre recebem o ID dele.
Para descobrir um ID, execute squarecloud app list. Em scripts e no CI, sempre passe o ID ou mantenha a linha ID=: o seletor precisa de um terminal interativo.

​
Onde o ID da aplicação é salvo

O upload grava ID=<appID> apenas quando a pasta já tem um arquivo de configuração, que o upload exige de qualquer forma. Ele altera só essa linha e mantém as suas outras chaves e comentários como estão. A Square Cloud ignora a linha ao ler o arquivo, então ela pode continuar no zip. Executar o upload de novo na mesma pasta cria outra aplicação e aponta a linha ID= para ela. Para atualizar a aplicação que você já tem, use o commit. Para trabalhar com outra aplicação a partir desta pasta, edite ou apague a linha.

​
Próximos passos

Upload e commit

Todas as flags do upload, do commit e do zip, e o que entra no zip.

Variáveis de ambiente

Defina variáveis pelo terminal ou carregue-as de um arquivo .env.

Deploys pelo GitHub

Faça deploy a cada push pelo GitHub App da Square Cloud.

Flags globais e CI

Saída em JSON, códigos de saída e a CLI em pipelines.