ghcr.io/windmill-labs/windmill-cli:1.793

面向内部代码的开源开发者平台：API、后台任务、工作流和UI。可自托管的替代方案，适用于Retool、Pipedream、Superblocks以及简化版的Temporal，提供自动生成的UI和自定义UI，用于将工作流和脚本作为内部应用触发。

脚本会自动转换为可共享的UI，并且可以组合成工作流，或用于通过低代码构建的更丰富的应用中。支持的语言：Python、TypeScript、Go、Bash、SQL、GraphQL、PowerShell、Rust等。

立即尝试 - 网站 - 文档 - *** - Hub - 贡献指南

Windmill - 面向API、后台任务、工作流和UI的开发者平台

Windmill 完全开源（AGPLv3 许可），Windmill Labs 提供专用实例以及商业支持和许可。

• Windmill - Developer platform for APIs, background jobs, workflows and UIs
• Main Concepts
• Show me some actual script code
• Local Development
• Stack
• Fastest Self-Hostable Workflow Engine
• Security
• Performance
• Architecture
• How to self-host
• Docker compose
• Kubernetes (Helm charts)
• Cloud providers
• OAuth, SSO & SMTP
• License
• Integrations
• Environment Variables
• Run a local dev setup
• Frontend only
• Backend + Frontend
• Contributing
• Contributors
• Copyright

核心概念

2. 脚本参数会被自动解析并生成前端界面。

3. 构建工作流！您可以将自己的脚本或社区在WindmillHub上共享的脚本链接起来。

4. 在脚本和工作流之上构建复杂UI。

在Windmill之上构建您的整个基础设施！

实际脚本代码示例

//import any dependency from npm
import * as wmill from "windmill-client";
import * as cowsay from "cowsay@1.5.0";

// fill the type, or use the +Resource type to get a type-safe reference to a resource
type Postgresql = {
host: string;
port: number;
user: string;
dbname: string;
sslmode: string;
password: string;
};

export async function main(
a: number,
b: "my" | "enum",
c: Postgresql,
d = "inferred type string from default arg",
e = { nested: "object" }
//f: wmill.Base64
) {
const email = process.env["WM_EMAIL"];
// variables are permissioned and by path
let variable = await wmill.getVariable("f/company-folder/my_secret");
const lastTimeRun = await wmill.getState();
// logs are printed and always inspectable
console.log(cowsay.say({ text: "hello " + email + " " + lastTimeRun }));
await wmill.setState(Date.now());

// return is serialized as JSON
return { foo: d, variable };
}

本地开发

Windmill 支持多种本地开发方式并与您的实例同步：

您可以通过传递正确的环境变量，让wmill客户端库从您的实例获取资源和变量，从而在本地运行脚本。请参阅本地开发文档。

技术栈

• 数据库：Postgres（兼容Aurora、Cloud SQL、Neon、Azure PostgreSQL）
• 后端：Rust - 无状态API服务器和从Postgres队列拉取任务的工作节点
• 前端：Svelte 5
• 沙箱：https://github.com/google/nsjail 和PID命名空间隔离
• 运行时：
  • TypeScript/JavaScript：Bun（默认）和Deno
  • Python：python3，使用uv进行依赖管理
  • Go、Bash、PowerShell、PHP、Rust、C#、Java、Ansible

云服务提供商

Windmill 可在 AWS（EKS/ECS）、GCP、Azure、Ubicloud、Fly.io、Render.com、Hetzner、Digital Ocean 等平台上运行。经验法则：每 1vCPU 和 1-2 GB RAM 配置 1 个工作节点（worker）。

OAuth、SSO 与 SMTP

直接从超级管理员界面配置 OAuth 和 SSO（Google Workspace、Microsoft/Azure、Okta）。参见文档。

许可协议

社区版（Community Edition）可免费在内部使用。如需商业再分发或托管服务，请联系 。有关详细信息，请参见 LICENSE 和 定价。

托管于 ghcr.io/windmill-labs/windmill 的 Docker 镜像以及 GitHub 二进制发行版中提供的 Windmill“社区版”，包含 AGPLv3 和 Apache 2 许可下的源代码文件，同时也包含专有和非公开代码及功能，这些代码和功能并非开源，且受以下条款约束：Windmill Labs, Inc. 授予免费使用“社区版”所有功能的权利，除软件中设置的限制和配额外无其他限制；同时授予按原样分发社区版的权利，但未经明确协议，不得销售、转售、将 Windmill 作为托管服务提供、修改或以任何形式包装。

未启用“enterprise”功能标志、从本仓库源代码编译的二进制文件，根据 https://github.com/windmill-labs/windmill/blob/main/LICENSE-AGPL 许可条款开源。

若要将 Windmill 的任何部分作为产品功能直接重新暴露给您的用户（但嵌入的公开 Windmill“应用”除外），或在“Windmill 社区版”基础上构建商业销售或嵌入可分发产品或二进制文件的功能，您必须获得商业许可。如有任何问题，请联系 。对于未启用“enterprise”功能标志、从本仓库源代码编译的二进制文件，若要执行上述操作，您必须遵守 AGPLv3 许可条款，或从 Windmill Labs, Inc. 获得商业许可。

若要在组织内部按原样使用 Windmill“社区版”，或按原样使用其 API，则无需商业许可。

集成

在 Windmill 中，集成被称为资源和资源类型。每个资源都有一个资源类型，该类型定义了资源需要实现的 schema。

在自托管实例上，您可能需要从 WindmillHub 导入所有已批准的资源类型。设置脚本会提示您将其设置为每天自动同步。

环境变量

运行本地开发环境

我们建议使用 Nix。有关所有选项，请参见 ./frontend/README_DEV.md。

仅前端

使用后端配合本地前端（热重载）：

cd frontend
npm install
npm run generate-backend-client # 或在 Mac 上使用 generate-backend-client-mac
npm run dev

Windmill 可通过 http://localhost/ 访问

有关所有运行选项，请参见 ./frontend/README_DEV.md 文件。

1. 使用例如 start-dev-db.sh 脚本启动本地 Postgres 数据库，该脚本将在 postgres://postgres:changeme@localhost:5432/windmill 提供数据库。然后使用以下命令运行迁移：

cargo install sqlx-cli
   env DATABASE_URL= sqlx migrate run

这也将避免 sqlx 的 query! 宏出现编译时问题。

2. （可选，仅适用于 Linux）安装 https://github.com/google/nsjail 并确保其在 PATH 中可访问

3. 安装 bun、deno 和 python3（以及任何您想要使用的语言），确保二进制文件位于 /usr/bin/bun、/usr/bin/deno 和 /usr/local/bin/python3，或设置相应的环境变量。

4. （可选）安装 https://lld.llvm.org/

5. 进入 frontend/ 目录：

   1. npm install、npm run generate-backend-client，然后 REMOTE=http://localhost:8000 npm run dev
   2. 您可能需要为 node 运行时设置额外的堆空间：export NODE_OPTIONS="--max-old-space-size=4096"
   3. 使用 mkdir frontend/build 创建空的 frontend/build 文件夹

6. 进入 backend/ 目录：

   1. env DATABASE_URL= RUST_LOG=info cargo run
   2. 您可以指定要启用的任何功能标志，例如 cargo run --features python 以启用 Python 执行器。

7. Windmill 应可通过 http://localhost:3000 访问

贡献说明

目前，我们不寻求外部贡献。错误报告和功能请求仍然非常受欢迎，修复问题的小型、易于验证的 PR 仍会被接受。有关完整政策，请参见 CONTRIBUTING.md。

贡献者

版权所有

© 2023-2026 Windmill Labs, Inc.