Commit e upload

Enviando uma nova aplicação

api.applications.create(file) envia um zip e cria uma aplicação nova. O argumento file aceita tanto um caminho local quanto um Buffer.

import { SquareCloudAPI } from "@squarecloud/api";
import { join } from "node:path";

const api = new SquareCloudAPI(process.env.SQUARE_API_KEY!);

const result = await api.applications.create(join(__dirname, "minha-app.zip"));

console.log(result.id);              // ID da aplicação recém-criada
console.log(result.name);            // nome de exibição
console.log(result.ram);             // RAM alocada em MB
console.log(result.cpu);             // CPU alocada (shares)
console.log(result.language);        // { name: "javascript", version: "22" }
console.log(result.description);     // string, apenas quando definida no squarecloud.config
console.log(result.subdomain);       // string, apenas quando definido no squarecloud.config

Possíveis erros incluem UPLOAD_FAILED (o upload não pôde ser processado), STORAGE_UPLOAD_FAILED (o backend de armazenamento rejeitou o arquivo), INSUFFICIENT_MEMORY (o plano não tem RAM suficiente disponível) e FILE_TOO_LARGE (413, zip acima do limite de tamanho). O zip deve conter pelo menos:

Arquivo principal — ponto de entrada da sua aplicação
Arquivo de dependências — package.json, requirements.txt, etc.
squarecloud.app — arquivo de configuração com nome, descrição, arquivo principal, versão, etc. Veja o guia do arquivo de configuração

Fazendo commit de arquivos em uma aplicação existente

app.commit(file, fileName?) envia arquivos para uma aplicação já implantada. Passe um zip para substituir vários arquivos de uma vez, ou um único arquivo para atualizar apenas ele.

Parâmetro	Tipo	Descrição
`file`	`string \| Buffer`	Caminho local do arquivo ou conteúdo em `Buffer`
`fileName`	`string?`	Nome anexado ao upload. `.zip` é extraído no servidor; qualquer outra extensão é gravada como arquivo único.

Por baixo dos panos, a API aceita um parâmetro de query path para controlar onde o commit é gravado; o SDK o envia automaticamente para você.

Commit de um único arquivo (Buffer)
Commit de um zip do disco
Commit de um arquivo por caminho

const content = Buffer.from("console.log('olá')\n");
await app.commit(content, "index.js");

import { readFile } from "node:fs/promises";

const zip = await readFile("./dist.zip");
await app.commit(zip, "dist.zip");

import { join } from "node:path";

const filePath = join(__dirname, "index.js");
await app.commit(filePath, "index.js");

Na v3, commit() aceitava um terceiro argumento restart. Na v4 esse terceiro parâmetro foi removido — chame app.restart() manualmente após o commit, se precisar reiniciar.

await app.commit(zip, "dist.zip");
await app.restart();

Possíveis erros incluem UPLOAD_FAILED, STORAGE_UPLOAD_FAILED, INSUFFICIENT_MEMORY, FILE_TOO_LARGE (413), UPLOAD_ABORTED (o cliente abortou o upload) e COMMIT_FAILED.

Serviços

Runtimes

Plataforma

Solução de Problemas

CLI

SDKs

Changelog

Enviando uma nova aplicação

Fazendo commit de arquivos em uma aplicação existente

​Enviando uma nova aplicação

​Fazendo commit de arquivos em uma aplicação existente

Enviando uma nova aplicação

Fazendo commit de arquivos em uma aplicação existente