> /docs/install-and-deploy/deployment-scripts

Install & Management Scripts

> 更新时间: 2026-02-09 14:27:59

Install & Management Scripts (one-click install, start, update)


1) Two types of scripts

A. One-click installers (recommended)

  • getcoolvibe.sh (macOS / Linux)
  • getcoolvibe.ps1 (Windows)

They automatically:

  1. Resolve the latest version (or use your pinned version)
  2. Download the management script
  3. Run installation and start the service

B. Management scripts (used after installation)

  • coolvibe.sh (macOS / Linux)
  • coolvibe.ps1 (Windows)

They provide start/stop/restart, logs, update/rollback, config management, and uninstall.


2) One-click install

macOS / Linux

curl -fsSL https://get.coolvibe.io/getcoolvibe.sh | bash

Pin a version (optional):

export COOLVIBE_VERSION=1.0.0
curl -fsSL https://get.coolvibe.io/getcoolvibe.sh | bash

Set install dir (optional, default is ~/.coolvibe):

export COOLVIBE_HOME="$HOME/.coolvibe"
curl -fsSL https://get.coolvibe.io/getcoolvibe.sh | bash

Windows (PowerShell)

powershell -NoProfile -ExecutionPolicy Bypass -Command "Invoke-RestMethod https://get.coolvibe.io/getcoolvibe.ps1 | Invoke-Expression"

Optional: pin a version:

powershell -NoProfile -ExecutionPolicy Bypass -Command "$env:COOLVIBE_VERSION='1.0.0'; Invoke-RestMethod https://get.coolvibe.io/getcoolvibe.ps1 | Invoke-Expression"

Optional: set install dir:

powershell -NoProfile -ExecutionPolicy Bypass -Command "$env:COOLVIBE_HOME=(Join-Path $HOME '.coolvibe'); Invoke-RestMethod https://get.coolvibe.io/getcoolvibe.ps1 | Invoke-Expression"

If coolvibe is not found after installation, open a new terminal session.


3) Common commands (after install)

coolvibe status
coolvibe logs
coolvibe start
coolvibe stop
coolvibe restart
coolvibe update
coolvibe update 1.0.0
coolvibe config show
coolvibe config get PORT
coolvibe config set PORT 4001
coolvibe restart
coolvibe uninstall

Windows extra (auto-start on login):

coolvibe enable
coolvibe disable

4) Config file

A config file is created automatically under your install directory:

  • Default home:
    • macOS/Linux: ~/.coolvibe
    • Windows: %USERPROFILE%\.coolvibe
  • Config file: coolvibe.env

Common keys:

  • HOST, PORT, PUBLIC_URL, DATA_DIR, RUST_LOG
  • JWT_SECRET (auto-generated; usually do not change)

5) (Optional) Allow LAN access

By default it binds to localhost only. To allow LAN access:

coolvibe expose

This changes HOST to 0.0.0.0 and restarts the service.


6) FAQ

  • Installed, but the command is not available: your terminal session may not have picked up PATH changes yet. Open a new terminal and try again.
  • Port is already in use: change it via coolvibe config set PORT <new_port>, then run coolvibe restart.
  • Need to troubleshoot quickly: run coolvibe status first, then coolvibe logs.