Introduction
To develop and host an X (Twitter) bot on Square Cloud, it’s essential to follow a structured sequence of configurations and prerequisites. This technical guide will cover the entire process, from initial setup to production deployment.Prerequisites
- Square Cloud Account: Register through the signup page using your email.
- Active plan: Ensures dedicated resources and optimized performance for your application. Check our available plans and choose the most suitable for your needs.
Create the project
An active X (Twitter) account is required for authentication and bot operation. If you don’t have an account, sign up at the official X website.An X Developer account is also required to access the APIs. Request access through the X Developer Portal.
Bot application on X
1
Open the Developer Portal
- Go to the X Developer Portal.
- Log in with your X (Twitter) account.
- If this is your first time, complete the developer access request process.
2
Create a project
- In the dashboard, click “Create Project”.
- Choose a name for your project (e.g. “Square Cloud Bot”).
- Select the most appropriate use case (e.g. “Making a bot”).
- Provide a detailed description of your bot.
- Confirm project creation.
3
Create an app
- Within the created project, click “Create App”.
- Define a unique name for your application.
- Confirm application creation.
- Note down the generated App ID for future reference.
4
Generate the API keys
- Navigate to the “Keys and tokens” section of your application.
- In the “Consumer Keys” section, click “Regenerate” to generate:
- API Key (Consumer Key)
- API Secret Key (Consumer Secret)
- Important: Copy and save these keys immediately, as you won’t be able to view them again.
5
Set the app permissions
- Go to the “App permissions” section.
- Click “Edit” to modify permissions.
- Select “Read and write” to allow your bot to post tweets.
- If necessary, select “Read and write and Direct message” for DM functionality.
- Save the changes.
6
Generate the access tokens
- Return to the “Keys and tokens” section.
- In the “Access Token and Secret” section, click “Generate”.
- Confirm token generation.
- Copy and save:
- Access Token
- Access Token Secret
- Warning: These tokens cannot be viewed again after closing the page.
7
Check your credentials
- Confirm that you have all 4 required credentials:
- API Key (Consumer Key)
- API Secret Key (Consumer Secret)
- Access Token
- Access Token Secret
- Store these credentials in a secure location
- Important: Never share or expose these credentials publicly
Develop the bot
- Node.js check: Verify that Node.js is installed on your system. If not, download it from the official Node.js website.
- Project initialization: Create a new Node.js project by running:
Terminal
- Install dependencies: Install the libraries required for the bot:
Terminal
- Credentials: the code reads the four credentials from environment variables, so they never go into your code. To test the bot on your computer, put them in a
.envfile and start the bot withnode --env-file=.env index.js:
.env
- Create the main file: Develop the
index.jsfile with the bot’s base structure:
index.js
Configure Square Cloud
Create asquarecloud.app file at the root of your project, next to index.js. It tells Square Cloud how to run your bot:
squarecloud.app
MEMORYis the bot’s RAM in MB. Bots need at least 256 MB; 512 MB leaves room to grow.AUTORESTART=truestarts the bot again if it crashes. See how auto restart works.- There is no
SUBDOMAIN: the bot calls the X API and doesn’t serve web pages.
Set the credentials
Security: Never include your API credentials directly in code. Always use environment variables on Square Cloud.
API_KEY: Your X API keyAPI_SECRET_KEY: Your X API secret keyACCESS_TOKEN: Your access tokenACCESS_TOKEN_SECRET: Your access token secret
- Dashboard: on the upload page, open Advanced configuration and add the four variables. For a bot that is already deployed, add them on the application’s Environment Variables page and restart the bot.
- CLI: right after you upload the bot (see Deploy and verify), load them from your local
.envfile withsquarecloud app env setand restart the bot:
What goes in the ZIP
index.jsand your other source files.package.json.squarecloud.app.
node_modules: Square Cloud installs your dependencies when the bot starts. Also leave out your .env file: if you upload with the CLI, add a line with .env to your squarecloud.ignore file so the CLI skips it.
Deploy and verify
Create the ZIP described above, then upload it:Via dashboard
1
Access the Upload Page
Access the upload page and upload your project zip file.
2
Configure Your Environment
After uploading your zip, you will need to configure the name, main file or runtime environment and other settings for your project.
If you are uploading a web project, make sure to select “Web Publication” and set a subdomain to your project.
If you are uploading a web project, make sure to select “Web Publication” and set a subdomain to your project.
3
Deploy Your Project
Finally, click on the “Deploy” button to host your project on Square Cloud.
After deployment, you can monitor your project’s status and logs from the dashboard.
After deployment, you can monitor your project’s status and logs from the dashboard.

4
Confirm Your App Is Live
Your first deploy usually takes less than a minute. In the dashboard, wait for your application status to show as running and check the logs for any startup errors.
If you deployed a website or API, open
If you deployed a website or API, open
https://<your-subdomain>.squareweb.app in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
Via CLI
To use this method, your project needs a configuration file namedsquarecloud.app at its root. It tells Square Cloud how to run your application.
Configuration file guide
Learn how to create the
squarecloud.app configuration file that defines your application’s environment.1
Install the CLI
Install the Square Cloud CLI. If you already have it, run the same command to update it:
2
Log In
Run the command below. It opens your browser: approve the login there and the CLI is ready. There is no API key to copy. For scripts and CI, see CLI authentication.
3
Upload Your Project
From your project folder, run the command below. The CLI zips the current folder, leaving out what To upload a zip you created yourself, pass it with
squarecloud.ignore lists, and uploads it:--file:4
Confirm Your App Is Live
Your first deploy usually takes less than a minute. Check your application status and logs directly from the terminal:If you deployed a website or API, open
https://<your-subdomain>.squareweb.app in your browser: you should see your application responding. If you deployed a bot, send it a command to confirm it is online.
Test the bot
After deployment, check the application logs in the Square Cloud dashboard for theBot successfully initialized! message to confirm the bot authenticated correctly. Then, from another account, post a tweet that mentions the bot with !ping (for example, @your_bot !ping) and confirm it replies with Pong! 🤖 X Bot working correctly! on X within a few minutes. Mentions posted before the bot started are skipped.
Common errors
Request failed with code 401
The logs showError verifying bot: followed by this error. One of the four credentials is wrong or missing. Copy them again from the “Keys and tokens” section, set the four variables and restart the bot.
Request failed with code 403 when replying
The bot authenticates but can’t post. The access tokens were generated while the app had read-only permission. Set “Read and write” in the app permissions, regenerate the Access Token and Secret, updateACCESS_TOKEN and ACCESS_TOKEN_SECRET and restart the bot.
Request failed with code 429
The bot reached an X API rate limit. Wait before the next request, and space out your calls as in Rate limiting.Going further
The snippets below extendindex.js: add them to the file and call them where your bot needs them.
Hashtag monitoring
Scheduled posts
Rate limiting
X (Twitter) has strict rate limits. Implement controls to avoid exceeding these limits:Error handling
Next steps
App won't start
Fix missing modules, memory errors and other startup failures.
Environment variables
Manage your bot’s credentials and other secrets.
Node.js runtime
How Square Cloud runs Node.js applications.

