Commit and upload

新しいアプリケーションのアップロード

api.applications.create(file) は zip をアップロードして、まったく新しいアプリケーションを作成します。file 引数は、ローカルファイルパスまたは 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
console.log(result.name);            // 表示名
console.log(result.ram);             // 割り当てられた RAM (MB)
console.log(result.cpu);             // 割り当てられた CPU シェア
console.log(result.language);        // { name: "javascript", version: "22" }
console.log(result.description);     // string、squarecloud.config で設定した場合のみ
console.log(result.subdomain);       // string、squarecloud.config で設定した場合のみ

考えられるエラーには UPLOAD_FAILED（アップロードを処理できなかった）、STORAGE_UPLOAD_FAILED（ストレージバックエンドがファイルを拒否した）、INSUFFICIENT_MEMORY（プランに利用可能な RAM が不足している）、FILE_TOO_LARGE（413、zip がサイズ上限を超えている）があります。 zip には最低限、以下が含まれている必要があります:

メインファイル — アプリケーションのエントリーポイント
依存関係ファイル — package.json、requirements.txt など
squarecloud.app — 名前、説明、メインファイル、バージョンなどを記載した設定ファイル。設定ファイルガイドを参照してください

既存のアプリケーションへのファイルの commit

app.commit(file, fileName?) は、すでにデプロイ済みのアプリケーションにファイルをアップロードします。複数のファイルを一度に置き換えるには zip を渡し、1 つのファイルだけを更新するには単一のファイルを渡します。

Parameter	Type	Description
`file`	`string \| Buffer`	ローカルファイルパスまたは `Buffer` の内容
`fileName`	`string?`	アップロードに付与される名前。`.zip` はサーバー側で展開されます。それ以外の拡張子は単一のファイルとして書き込まれます。

内部的には、API は commit の書き込み先を制御する path クエリパラメータを受け付けます。SDK がこれを自動的に送信します。

単一のファイルを commit (Buffer)
ディスクから zip を commit
パス指定でファイルを commit

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");

v3 では commit() は 3 番目の restart 引数を受け付けていました。v4 では 3 番目のパラメータは削除されています。再起動が必要な場合は、commit の後に app.restart() を使用してください。

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

考えられるエラーには UPLOAD_FAILED、STORAGE_UPLOAD_FAILED、INSUFFICIENT_MEMORY、FILE_TOO_LARGE（413）、UPLOAD_ABORTED（クライアントがアップロードを中断した）、COMMIT_FAILED があります。

サービス

Runtimes

プラットフォーム

トラブルシューティング

CLI

SDKs

Changelog

新しいアプリケーションのアップロード

既存のアプリケーションへのファイルの commit

​新しいアプリケーションのアップロード

​既存のアプリケーションへのファイルの commit

新しいアプリケーションのアップロード

既存のアプリケーションへのファイルの commit