Skip to main content

ChatCoolify

AI-safe Python client and MkDocs guide for the official Coolify API.

文档 · English · PyPI · 源码

解决什么问题

ChatCoolify 不替代 Coolify,而是把官方 REST API 变成可测试的 Python 客户端和 CLI:

  • 默认只读,适合 AI 清点服务器、项目、应用与部署状态;
  • 写操作必须有 Coolify Token 权限并显式传递 --allow-write;
  • 支持 ChatEnv 配置、公开 Git 网站计划与创建、部署触发;
  • 文档覆盖邀请制协作、MCP、网站、API、数据库和运维边界。

安装

python -m pip install --upgrade ChatCoolify
coolify --version
coolify --tree

支持 Python >=3.10。发布包仍叫 ChatCoolify,Python import 仍是 chatcoolify;安装后的唯一 CLI 是 coolify,不提供 chatcoolify 命令别名。

最快开始

已有平台账号可通过 coolify platform 完成本地目录上传、原生预览、显式发布及回退;平台按项目授权,普通用户不持有原生 Team token。见本地项目平台。以下保留原生 Coolify 客户端用法,其写操作仍需 --allow-write。

coolify --base-url https://<coolify-url> health

需要受保护 API 时,先在 Coolify 创建 Team-scoped 最小权限 Token,再通过 ChatEnv 配置:

chatenv init -t coolify -I
chatenv set COOLIFY_BASE_URL=https://<coolify-url>
chatenv set COOLIFY_API_TOKEN='<team-scoped-token>'
coolify overview

网站计划示例

coolify website-plan \
  --project-uuid PROJECT_UUID \
  --server-uuid SERVER_UUID \
  --environment-uuid ENVIRONMENT_UUID \
  --repository-url https://github.com/example/simple-site

省略 --domain 时,计划会请求 Coolify 从已配置的泛域名池自动分配唯一 tenant URL;需要自定义域名时才显式传入 --domain。查看完整的 真实 Git 到 HTTPS 演示。

以上为直接原生 API 的低层命令。面向普通协作者的 coolify platform 使用项目名分配可读的正式/预览子域名,owner 可在“我的网站”管理页或通过 domains set 自定义受管前缀,并用 domains apply 应用到已发布网站。新项目默认公开阅读,管理登录与访客留言分离;登录、项目列表、目录上传与明确发布流程见本地项目平台。

该命令只输出官方 API payload。真正创建资源需要同时具备 write Token 和显式写门:

coolify --allow-write website-create ...

安全边界

  • 不把 Token 写入参数、仓库、日志或提示词。
  • 不向普通 AI 或 CI 提供 root Token。
  • Team 角色不是虚拟机隔离;不可信代码不应共享生产 Docker 守护进程。
  • 完整操作流程见 文档。

开发

python -m pip install -e '.[dev,docs,comments]'
python -m pytest -q
python -m mkdocs build --strict
python -m build
python -m twine check dist/*

许可证

MIT。

Metadata

Release files for ChatCoolify 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ChatCoolify 0.2.2
File Size Uploaded Provenance
chatcoolify-0.2.2.tar.gz 67.9 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ChatCoolify 0.2.2
File Interpreter ABI Platform
chatcoolify-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 121.3 kB

Release files / chatcoolify-0.2.2.tar.gz

Download URL chatcoolify-0.2.2.tar.gz
Size 67.9 kB
Tags Source
SHA-256 checksum
How to use checksums
d78fe4185051eff973695bf69c85303ff0f845dee862c7d72ca201a9f61a4524
BLAKE2b-256 checksum
How to use checksums
a437d555c7216ff749b285602fd9c12fee321061fd5609600a936f66a466fc3c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Release files / chatcoolify-0.2.2-py3-none-any.whl

Download URL chatcoolify-0.2.2-py3-none-any.whl
Size 53.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7dcea33b7bd1fde44222bd52a434dd94362b670c214b024f9588371278327a20
BLAKE2b-256 checksum
How to use checksums
3196e095ee613576452c052950efa808a6f97d571d5f7ada593c7a98d2bc6406
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

Security for ChatCoolify 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for chatcoolify-0.2.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 21, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page