Quick Start Guide

Get a fast overview in your first steps with Square Cloud.

Official API

Our API documentation for developers (and you’re here!).

​
Before you begin

To get started, create a Square Cloud account. Then you can select the plan that's right for you.

Sign Up

If you've never used Square before, sign up to get started.

Log in

If you already have an account, log in to get started.

Once you’ve signed up, you can start deploying your applications on Square Cloud after selected the plan that suits your needs.

​
Facilitating your journey with CLI 💻

This Overview uses a Square Cloud CLI to deploy your applications. The CLI is a command-line tool that allows you to interact with Square Cloud services. You can use the CLI to deploy applications, manage services, and view logs.

To use the CLI, you need to install it on your local machine. You can install the CLI using the following commands:


1

Read the instructions about your language

Node.js

Python

Java

Rust

Elixir

PHP

Go

C#

+ 😉

For this example, we will use the JavaScript (Node.js) language.
2

Create your Square Cloud config file

After installing the CLI, you need to create a configuration file. You can create a configuration file reading this article here.

My configuration file looks like this:

MAIN=index.js
MEMORY=512
VERSION=recommended
DISPLAY_NAME=Robin bot
DESCRIPTION=This bot system is designed to help you with your daily tasks.
3

Upload your project

After this journey, you need to upload your project to Square Cloud. You can do this by running the following command:

squarecloud upload

​
Facilitating your journey with web interface 😉

If you don’t like command lines or prefer to use the web interface, you can upload your project directly to the Square Cloud website. To do this, follow these steps:

1

Access the Square Cloud website

Access the Square Cloud dashboard using your account.

2

Create your Square Cloud config file

After accessing the dashboard, you need to create a configuration file. You can create a configuration file reading this article here.

3

ZIP your project

After creating the configuration file, you need to zip your project.

Using the CLI
squarecloud zip

Or you can zip your project manually:

Or you can use the command line to compress your project folder:

4

Deploy your project

After uploading your project, click on the “Add New” button to deploy your project.

​
What’s next?

Now that you’ve learned how to deploy your project, you can explore the Square Cloud platform further. Here are some resources to help you get started:

API Reference

Learn more about the Square Cloud API.

CLI Reference

Learn more about the Square Cloud CLI.

Join our community on Discord to get help from other developers and share your experiences.

Square Cloud Community

Join our community on Discord. We’re here to help you!

If you have any questions or need help, you can reach out to our support team. We’re here to help you! 🚀

Was this page helpful?

Quickstart