🚀 Flootup CLI

The official Command Line Interface to manage and deploy your bots to Flootup directly from your terminal.

📦 Installation

Install the Flootup CLI globally via npm to access the tool from any directory:

npm install -g flootup

Now you can use the flootup command anywhere.

🛠 Commands

🔑 Authentication

flootup login

Logs you into your Flootup account.

flootup logout

Clears your local session data and logs you out of the CLI.

🏗 Lifecycle

flootup init

The easiest way to start:

1. Select an existing project or create a new one.
2. Select an existing bot or create a new one.
3. Optional: Zip and upload your current directory code immediately.
4. Generates a flootup.json configuration file in your current folder.

flootup link

A streamlined version of init. Use this when you just want to link the current directory to an existing project and bot without any creation prompts.

📁 Project Management

flootup projects list

Lists all your projects with their IDs and current plans.

flootup projects usage <projectId>

Shows detailed resource usage (RAM, CPU, Bots) for a specific project.

🚀 Deployment

flootup deploy

Triggers the Industrial Deployment Protocol:

1. Architecture Scan: Detects if your project uses a Dockerfile (Industrial Mode) or standard runtimes (Hybrid Mode).
2. Build Preparation: If no Dockerfile is found, it offers to execute npm run build locally.
3. Transmission: Zips and uploads your code to our secure R2 storage.
4. Trigger: Initiates the remote build & orchestration sequence on the container grid.

flootup delete

Permanently decommission the bot linked to the current directory. This action is irreversible and purges all related image artifacts and local configurations.

📋 Logs

flootup logs

View the latest runtime logs of your bot.

🔐 Environment Variables

Manage your bot's secrets and configurations:

• List variables: flootup env list
• Set a variable: flootup env set KEY VALUE
• Remove a variable: flootup env unset KEY

📄 Configuration (flootup.json)

The init command creates a flootup.json file. It maps your local folder to a specific bot on the platform:

{
  "projectId": "your-project-id",
  "botId": "your-bot-id",
  "botName": "my-cool-bot"
}

❤️ Happy Coding!

cli