KS CLI

使用 ks-cli 安装、管理 KSpeeder,并无配置使用 kspeeder 加速 DockerHub 和 GHCR 镜像拉取。

ks-cli 是 KSpeeder 的命令行工具。你可以用它安装和管理 KSpeeder,也可以在不修改 Docker daemon 配置的情况下,直接加速 DockerHub 和 GHCR 镜像拉取。

安装 ks-cli

如果你还没有安装 KSpeeder,推荐直接使用一键安装脚本。脚本会安装 ks-cli,然后继续安装或更新 KSpeeder。

sh -c "$(curl -fsSL https://kspeeder.com/bin/install-kspeeder.sh)"

Windows PowerShell:

iwr https://kspeeder.com/bin/install-kspeeder.ps1 -UseBasicParsing | iex

如果你只需要 CLI 本体,可以只安装 ks-cli

sh -c "$(curl -fsSL https://kspeeder.com/bin/install-ks-cli.sh)"

Windows PowerShell:

iwr https://kspeeder.com/bin/install-ks-cli.ps1 -UseBasicParsing | iex

只安装 CLI 时,macOS / Linux 默认安装到 ~/.local/bin/ks-cli,Windows 默认安装到 %LOCALAPPDATA%\KSpeeder\bin\ks-cli.exe。如果当前终端提示找不到 ks-cli,请把对应目录加入 PATH,或使用完整路径运行。

安装完成后执行:

ks-cli version

无配置使用 kspeeder 加速

ks-cli docker ... 适合不想修改 Docker daemon 配置,或者只想临时加速一次拉取的场景。它会检查 KSpeeder 是否可用:如果已有常驻服务,会直接使用;如果没有检测到已安装服务,会为本次命令临时启动 KSpeeder,命令结束后自动关闭。

拉取 DockerHub 镜像:

ks-cli docker pull alpine:latest

拉取 GHCR 镜像:

ks-cli docker pull ghcr.io/n8n-io/n8n:latest

指定平台:

ks-cli docker pull --platform linux/amd64 alpine:latest

ks-cli 会自动把 DockerHub 镜像映射到 KSpeeder 的 DockerHub 加速地址,把 GHCR 镜像映射到 KSpeeder 的 GHCR 加速地址。拉取完成后,它会把镜像重新打回原始名称,所以后续 docker run alpine:latest 仍然可以正常使用。

Docker Compose

拉取 compose 文件中的服务镜像:

ks-cli docker compose pull

启动 compose 项目前预拉取镜像:

ks-cli docker compose up -d

使用 compose 文件和项目名:

ks-cli docker compose -f docker-compose.yml -p myapp up -d

只处理指定服务:

ks-cli docker compose up -d web

执行 compose up 时,ks-cli 会先读取 docker compose config --format json,找出需要的服务镜像,通过 KSpeeder 预拉取并打回原始镜像名,然后再执行原始的 docker compose up。如果你指定了某个服务,默认会同时处理它依赖的服务;加上 --no-deps 后只处理你指定的服务。

命令总览

当前 ks-cli --help 会列出这些命令:

ks-cli installer
ks-cli installer install [--version-url URL] [--cache-path PATH] [--listen :5443] [--admin :5003] [--yes] [--force-docker]
ks-cli installer uninstall [--yes] [--purge-data]
ks-cli installer set-default-mirror
ks-cli installer service status|start|stop|restart
ks-cli service status|start|stop|restart
ks-cli health [--verbose|-v|-vv]
ks-cli admin
ks-cli auth status [--admin-url URL]
ks-cli auth login [--admin-url URL] [--timeout DURATION] [--interval DURATION] [--no-qr]
ks-cli auth logout [--admin-url URL]
ks-cli clear-cache
ks-cli version
ks-cli docker pull IMAGE
ks-cli docker compose pull|up [OPTIONS] [SERVICE...]

安装和更新 KSpeeder

直接运行安装器会进入交互式菜单:

ks-cli installer

如果你想使用默认配置快速安装或更新:

ks-cli installer install --yes

自定义端口和缓存目录:

ks-cli installer install --listen :5443 --admin :5003 --cache-path /path/to/cache

如果当前系统不能使用原生系统服务,安装器会尝试改用 Docker Compose 部署。你也可以主动指定 Docker Compose 安装:

ks-cli installer install --yes --force-docker

卸载 KSpeeder:

ks-cli installer uninstall

默认卸载会保留数据。如果确认要一起删除缓存、配置目录和 Docker volume:

ks-cli installer uninstall --yes --purge-data

服务管理

安装完成后,可以用下面的命令查看和控制服务:

ks-cli service status
ks-cli service start
ks-cli service stop
ks-cli service restart

ks-cli installer service status|start|stop|restart 也可以使用,效果相同。

如果你想把 KSpeeder 写入 Docker 的默认镜像源配置,可以运行:

ks-cli installer set-default-mirror

这个命令会修改 Docker daemon 配置,并在确认后尝试重启 Docker。只想临时加速拉取镜像时,优先使用 ks-cli docker ...,不需要改 Docker 配置。

健康检查和管理面板

检查 KSpeeder 是否可用:

ks-cli health

查看更详细的检查结果:

ks-cli health -v

健康检查会确认管理面板、镜像源状态和本机 registry 代理是否可访问。

打开管理面板:

ks-cli admin

默认地址是 http://127.0.0.1:5003。如果 KSpeeder 安装在另一台机器上,请在浏览器中打开 http://<安装IP>:5003

清理 KSpeeder 缓存:

ks-cli clear-cache

执行前会要求确认,确认后会调用管理面板接口清理服务端缓存。

登录账号

查看当前登录状态:

ks-cli auth status

微信扫码登录:

ks-cli auth login

退出登录:

ks-cli auth logout

如果你的管理面板不在本机默认地址,可以指定 --admin-url

ks-cli auth login --admin-url http://<安装IP>:5003

登录命令还支持等待时间和轮询间隔:

ks-cli auth login --timeout 2m --interval 2s

如果当前终端不方便显示二维码,可以输出二维码内容:

ks-cli auth login --no-qr

当前限制

  • 支持 DockerHub 和 GHCR;其他 registry 会提示不支持。
  • 镜像必须是标签引用,例如 alpine:latest;digest 引用暂不支持。
  • docker pull --all-tags 暂不支持。
  • docker compose pull 支持服务名和 -f-p 等 compose 全局参数;暂不支持 pull 子命令自己的参数。
  • docker compose up --pull always 会让 Docker 在预拉取后再次拉取,暂不支持;可以使用默认行为、--pull missing--pull never
  • docker build --pulldocker buildx build --pull 暂不通过 ks-cli 加速。

查看完整命令列表:

ks-cli --help