Commit et upload

Envoyer une nouvelle application

api.applications.create(file) envoie un zip et crée une toute nouvelle application. L’argument file est soit un chemin de fichier local, soit un 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, "my-app.zip"));

console.log(result.id);              // ID de l'application nouvellement créée
console.log(result.name);            // nom d'affichage
console.log(result.ram);             // RAM allouée en Mo
console.log(result.cpu);             // parts CPU allouées
console.log(result.language);        // { name: "javascript", version: "22" }
console.log(result.description);     // string, uniquement si défini dans squarecloud.config
console.log(result.subdomain);       // string, uniquement si défini dans squarecloud.config

Les erreurs possibles incluent UPLOAD_FAILED (l’envoi n’a pas pu être traité), STORAGE_UPLOAD_FAILED (le backend de stockage a rejeté le fichier), INSUFFICIENT_MEMORY (le plan n’a pas assez de RAM disponible) et FILE_TOO_LARGE (413, zip au-delà de la limite de taille). Le zip doit contenir au minimum :

Fichier principal — point d’entrée de votre application
Fichier de dépendances — package.json, requirements.txt, etc.
squarecloud.app — fichier de configuration avec le nom, la description, le fichier principal, la version, etc. Consultez le guide du fichier de configuration

Committer des fichiers vers une application existante

app.commit(file, fileName?) envoie des fichiers dans une application déjà déployée. Passez un zip pour remplacer plusieurs fichiers à la fois, ou un seul fichier pour ne mettre à jour que celui-ci.

Paramètre	Type	Description
`file`	`string \| Buffer`	Chemin de fichier local ou contenu `Buffer`
`fileName`	`string?`	Nom associé à l’envoi. Un `.zip` est extrait sur le serveur ; toute autre extension est écrite comme un fichier unique.

En arrière-plan, l’API accepte un paramètre de requête path pour contrôler l’endroit où le commit est écrit ; le SDK l’envoie pour vous.

Committer un seul fichier (Buffer)
Committer un zip depuis le disque
Committer un fichier par chemin

const content = Buffer.from("console.log('hello')\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");

En v3, commit() acceptait un troisième argument restart. En v4, ce troisième paramètre a été supprimé — utilisez app.restart() après le commit si vous avez besoin d’un redémarrage.

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

Les erreurs possibles incluent UPLOAD_FAILED, STORAGE_UPLOAD_FAILED, INSUFFICIENT_MEMORY, FILE_TOO_LARGE (413), UPLOAD_ABORTED (le client a interrompu l’envoi) et COMMIT_FAILED.

Services

Runtimes

Plateforme

Dépannage

CLI

SDKs

Changelog

Envoyer une nouvelle application

Committer des fichiers vers une application existante

​Envoyer une nouvelle application

​Committer des fichiers vers une application existante

Envoyer une nouvelle application

Committer des fichiers vers une application existante