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

安装与管理脚本

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

安装与管理脚本(用于一键安装、启动、更新)


1) 脚本分两类

A. 一键安装脚本(推荐使用)

  • getcoolvibe.sh:macOS / Linux 一键安装入口
  • getcoolvibe.ps1:Windows 一键安装入口

它们会自动:

  1. 获取最新版本(或使用你指定的版本)
  2. 下载“管理脚本”
  3. 执行安装并启动服务

B. 管理脚本(安装后常用)

  • coolvibe.sh:macOS / Linux 管理命令
  • coolvibe.ps1:Windows 管理命令

它们提供:启动/停止/重启、查看状态与日志、更新/回滚、修改配置、卸载等操作。


2) 一键安装(推荐)

macOS / Linux

在终端执行:

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

可选:指定版本(例如安装/回滚到 1.0.0):

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

可选:指定安装目录(默认是 ~/.coolvibe):

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

Windows(PowerShell)

在 PowerShell 执行:

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

可选:指定版本:

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

可选:指定安装目录:

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

安装完成后如果提示找不到 coolvibe 命令:请重新打开一个终端窗口再试。


3) 常用管理命令(安装后)

以下命令在 macOS/Linux/Windows 上含义一致(Windows 也可以直接在 PowerShell 里运行 coolvibe ...):

  • 查看是否在运行:
coolvibe status
  • 查看日志(实时滚动):
coolvibe logs
  • 启动 / 停止 / 重启:
coolvibe start
coolvibe stop
coolvibe restart
  • 更新到最新(或回滚到指定版本):
coolvibe update
coolvibe update 1.0.0
coolvibe update v1.0.0
  • 查看/修改配置:
coolvibe config show
coolvibe config get PORT
coolvibe config set PORT 4001
coolvibe restart
  • 卸载:
coolvibe uninstall

Windows 额外命令:开机/登录自动启动

coolvibe enable
coolvibe disable

4) 配置文件在哪里、改什么

安装后会生成一个配置文件(通常不需要你手动创建):

  • 默认安装目录:
    • macOS/Linux:~/.coolvibe
    • Windows:%USERPROFILE%\.coolvibe
  • 配置文件:coolvibe.env

常见配置项(按需改,改完建议重启):

  • PORT:服务端口(默认 4001
  • HOST:监听地址(默认 127.0.0.1,仅本机可访问)
  • PUBLIC_URL:对外展示的访问地址(通常用于生成链接;需要与实际访问方式一致)
  • DATA_DIR:数据目录(默认在安装目录下)
  • RUST_LOG:日志级别(排障时可临时调高)
  • JWT_SECRET:安全密钥(自动生成,不建议随意修改

5)(可选)让同一局域网设备访问

默认只允许本机访问。如果你希望同一局域网设备访问,可以执行:

coolvibe expose

这会将监听地址改为 0.0.0.0 并重启服务。

重要提示:

  • 这会让你的服务对局域网可见;是否能访问还取决于防火墙/网络设置。
  • 如果你要对公网开放,请务必做好访问控制与安全加固(例如 HTTPS、强密码、访问限制等)。

6) 常见问题

  • 安装完成但命令不可用:通常是终端还没刷新环境变量,重开终端即可。
  • 端口被占用:用 coolvibe config set PORT <新端口> 修改后 coolvibe restart
  • 想快速定位问题:先看 coolvibe status,再看 coolvibe logs