Lilibtc Bot Installation Guide

Quick start · Cross-platform · Complete configuration guide

Quick Start

One-line install (recommended)

macOS / Linux

curl -sL https://api.lilibtc.com/install.sh | bash

Windows (PowerShell)

irm https://api.lilibtc.com/install.ps1 | iex

Install via npm

Prerequisites

• Node.js 18+
• npm (usually installed together with Node.js)

Installation Steps

1. Install Lilibtc Bot

npm install -g lilibtc-bot

2. Start the console

lilibtc-bot start

💡 Tip: the web console opens automatically after launch.

3. Configure API Keys

In the web console:

• On the "Login" tab, paste your API Key (get it with the Telegram Bot /api_key command)
• On the "Settings" tab, paste your Binance Square Key
• Click the "Start" button

Verify Installation

lilibtc-bot --version
# Should display: lilibtc-bot v1.0.8

Configure Binance Square API Key

Lilibtc Bot publishes content to Binance Square automatically via the Binance Square OpenAPI.

Get your Binance Square API Key

1. Visit https://www.binance.com/en/square/creator-center/home
2. Click "Create API"
3. Copy your API Key

Configure in the console

After running lilibtc-bot start, paste your Binance Square API Key on the "Settings" tab of the web console, then click the "Start" button.

Start the Bot

Start and open the console

lilibtc-bot start

The web console opens automatically after launch — log in and configure it there to get started.

Run in the background (recommended)

lilibtc-bot start --daemon

Runs in daemon mode; the web console still opens for configuration.

Check status

lilibtc-bot status

Stop the bot

lilibtc-bot stop

Update the Bot

Update via npm

npm update -g lilibtc-bot

Use the built-in update command

lilibtc-bot update

System Requirements

• OS: Windows 10/11, macOS, Linux
• Node.js: 18.0 or higher
• Memory: at least 128MB RAM
• Network: access to api.lilibtc.com and binance.com required

Troubleshooting

Problem: cannot connect to the server

1. Check your network connection
2. Confirm your API Key is correct
3. Check firewall settings

Problem: Node.js version too old

# Check Node.js version
node --version

# Upgrade Node.js (nvm recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
nvm install --lts
nvm use --lts

Problem: permission errors (Linux/macOS)

sudo npm install -g lilibtc-bot

Problem: Windows installation fails

1. Make sure PowerShell runs as Administrator
2. Check the execution policy:

Get-ExecutionPolicy
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Advanced Configuration

Environment variables

All required configuration (API Key, Binance Square Key) is done in the web console — no environment variables needed. The following are for advanced use only:

PM2 deployment (recommended for production)

# Install PM2
npm install -g pm2

# Start the bot
pm2 start ecosystem.config.js

# Enable startup on boot
pm2 startup
pm2 save

Docker deployment

⚠️ Note: with Docker, the web console opens automatically after launch. On the console's "Login" tab paste your API Key, on the "Settings" tab paste your Binance Square Key, then click "Start".

# Build the image
docker build -t lilibtc-bot .

# Run the container
docker run -d \
  --name lilibtc-bot \
  -p 3000:3000 \
  lilibtc-bot

Common Commands

# Show help
lilibtc-bot help

# Show version
lilibtc-bot --version

# Show settings
lilibtc-bot setting

# Show history
lilibtc-bot history

# Show stats
lilibtc-bot states

Uninstall

npm uninstall

npm uninstall -g lilibtc-bot

Manual cleanup

# Remove config files
rm -rf ~/.lilibtc-bot

# Remove the lock file
rm -f ~/.lilibtc-bot/publisher.lock

Get Help

• Docs: https://lilibtc.com/docs
• GitHub Issues: https://github.com/franklili3/square-agent/issues
• Support email: [email protected]