Skip to main content
A CLI cube faz pelo terminal o que a API pública faz: listar e ver projetos, enviar a pasta do projeto, acompanhar os logs, iniciar, parar e reiniciar, e gravar variáveis de ambiente. Ela usa a sua chave de API, com as mesmas permissões e limites.

​
Instalar

Precisa do Node.js 20 ou mais novo, no macOS, no Linux, no WSL ou no Windows.
Confira com cube --version. Para atualizar, rode o mesmo comando de novo.
Não use npm update -g para atualizar a CLI. Ele procura o pacote pelo nome no registro do npm, onde a CLI não está: hoje dá erro, e um pacote de mesmo nome publicado por outra pessoa seria instalado no lugar, com acesso à sua chave. Atualize sempre com o npm i -g do endereço acima.
A CLI é instalada por este endereço do site da Cube, e não pelo nome de um pacote do npm: um pacote com nome parecido no npm não é da Cube. Para travar uma versão (no CI, por exemplo), use o endereço com o número, como https://cubehosting.com.br/cli/cube-cli-0.1.2.tgz.

​
Entrar

Crie uma chave em Chaves de API no painel. Leitura basta para ver projetos e logs; para enviar, iniciar, parar, reiniciar e mexer nas variáveis, use uma de leitura e escrita.
Cole a chave quando ela for pedida: ela não aparece na tela. A CLI confere a chave na Cube e guarda num arquivo que só o seu usuário lê: cube logout apaga a chave deste computador. Ela continua valendo até você revogar em Chaves de API.
No CI, não use cube login: defina a variável de ambiente CUBE_API_KEY com a chave, guardada nos segredos do CI. Ela vale no lugar do arquivo. Veja GitHub Actions.

​
Comandos

O <id> é o ID do projeto: está em cube projects e no topo da página do projeto no painel. Opções de cube logs: As linhas de stderr saem na saída de erro do terminal. O log passa por um filtro que tira as sequências de controle do terminal (cores, título da janela), como no painel.

​
Variáveis sem deixar rastro

cube vars set <id> TOKEN=valor deixa o valor no histórico do terminal. Para evitar, passe só o nome: a CLI pede o valor sem mostrar na tela.
Fora de um terminal (num script), o valor vem da entrada padrão: printf '%s' "$TOKEN" | cube vars set <id> DISCORD_TOKEN. A entrada padrão dá o valor de um nome só por comando; nome que fica sem valor é recusado, sem gravar nada (para gravar vazio, use NOME=). Variável nova ou trocada vale na próxima subida: a CLI avisa quando é preciso cube restart.

​
Enviar com cube deploy

  1. Confere o limite do .zip do seu plano (5 MB no Free, 10 MB nos pagos).
  2. Compacta a pasta, deixando de fora o que o .gitignore e o .cubeignore mandam (os da pasta e das subpastas, e também os das pastas acima até a raiz do repositório git, como faz o git), e as pastas que a Cube ignora de qualquer jeito (node_modules, .git, venv, .venv, __pycache__). Se passar do limite, para antes de enviar e mostra os maiores arquivos.
  3. Envia como um novo código do projeto: a configuração não muda, e as dependências só são reinstaladas se o package.json, o package-lock.json ou o requirements.txt mudaram.
  4. Mostra a instalação ao vivo até o projeto sair de “Instalando”. Se ele subiu, confere por mais 15 segundos se continua no ar.
  5. Sai com o código 0 se o projeto ficou no ar (ou parado, se estava parado) e 1 se a instalação falhou ou se o app caiu, reiniciou ou parou nesses 15 segundos (um token errado, por exemplo). Uma queda depois disso não muda o resultado: acompanhe com cube logs <id> --follow.
--no-wait envia e termina sem esperar a instalação.
O código novo substitui a pasta do projeto inteira, como no painel. Um .env que está no .gitignore não vai junto, e o que estava no servidor some: a CLI avisa no terminal quando isso acontece. Guarde os segredos em variáveis de ambiente (cube vars set). Se quiser mesmo mandar o .env, desfaça a regra no .cubeignore com !.env.
Sem --project, o cube deploy cria um projeto novo a partir do cube.json da pasta, e já inicia. Sem cube.json, ele não envia nada. No fim, mostra o ID do projeto novo para os próximos envios.

​
O .cubeignore

Mesmo formato do .gitignore, na raiz ou em qualquer subpasta, lido depois do .gitignore da mesma pasta. Use para deixar de fora o que o git guarda mas o servidor não precisa, ou para trazer de volta, com !, algo que o .gitignore deixa de fora.
.cubeignore
Links simbólicos ficam de fora (o envio não aceita links), com um aviso.

​
Erros

Todo erro sai em português, com o código da API e o link de como resolver:
A lista completa está em Códigos de erro. Comando ou opção errada sai com o código 2; erro da Cube ou do envio, com 1. Cada comando conta no limite de pedidos do seu plano, como qualquer pedido com chave. Um cube deploy faz 5 pedidos, mais 1 a cada 20 segundos de instalação.