# windmill-labs/windmill-cli-docs architecture

> Architecture diagram of the GitHub repository windmill-labs/windmill-cli-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/windmill-labs/windmill-cli-docs
- Repository: https://github.com/windmill-labs/windmill-cli-docs

## Overview

This repository is an auto-generated mirror of Windmill CLI command references and AI-agent guidance, not the CLI implementation. Its main user journey is to consult the quickstart, connect and initialize a workspace project, then use the command reference and task-specific guides for syncing, running jobs, and working with Windmill entities. The README documents the CLI’s broader capabilities, while the skill files provide schemas and task instructions. No runtime source was supplied, so the graph represents documented navigation and guidance, not executable calls or backend data flow.

Main entry points: [`README.md`](https://github.com/windmill-labs/windmill-cli-docs/blob/main/README.md) (Quickstart), [`cli-commands.md`](https://github.com/windmill-labs/windmill-cli-docs/blob/main/cli-commands.md) (CLI commands), [`skills/cli-commands/SKILL.md`](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/cli-commands/SKILL.md) (CLI guide), [`skills/write-flow/SKILL.md`](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-flow/SKILL.md) (Flow authoring)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_overview["Getting started"]
  node_quickstart["Quickstart<br/>[README.md]"]
end

subgraph group_reference["Command reference"]
  node_command_reference["CLI commands<br/>[cli-commands.md]"]
end

subgraph group_guides["Task guides"]
  node_cli_guide["CLI guide<br/>[SKILL.md]"]
  node_flow_guide["Flow authoring<br/>[SKILL.md]"]
  node_workflow_code_guide["Workflow as code<br/>[SKILL.md]"]
  node_app_guide["Raw apps<br/>[SKILL.md]"]
  node_trigger_guide["Triggers<br/>[SKILL.md]"]
  node_schedule_guide["Schedules<br/>[SKILL.md]"]
  node_resource_guide["Resources<br/>[SKILL.md]"]
  node_preview_guide["Preview<br/>[SKILL.md]"]
  node_script_ansible["Ansible scripts<br/>[SKILL.md]"]
  node_script_bash["Bash scripts<br/>[SKILL.md]"]
  node_script_bigquery["BigQuery scripts<br/>[SKILL.md]"]
  node_script_bun["Bun scripts<br/>[SKILL.md]"]
  node_script_bunnative["Bun native scripts<br/>[SKILL.md]"]
  node_script_csharp["C&#35; scripts<br/>[SKILL.md]"]
  node_script_deno["Deno scripts<br/>[SKILL.md]"]
  node_script_duckdb["DuckDB scripts<br/>[SKILL.md]"]
  node_script_go["Go scripts<br/>[SKILL.md]"]
  node_script_graphql["GraphQL scripts<br/>[SKILL.md]"]
  node_script_java["Java scripts<br/>[SKILL.md]"]
  node_script_mssql["SQL Server scripts<br/>[SKILL.md]"]
  node_script_mysql["MySQL scripts<br/>[SKILL.md]"]
  node_script_php["PHP scripts<br/>[SKILL.md]"]
  node_script_postgresql["PostgreSQL scripts<br/>[SKILL.md]"]
  node_script_powershell["PowerShell scripts<br/>[SKILL.md]"]
  node_script_python["Python scripts<br/>[SKILL.md]"]
  node_script_rlang["R scripts<br/>[SKILL.md]"]
  node_script_rust["Rust scripts<br/>[SKILL.md]"]
  node_script_snowflake["Snowflake scripts<br/>[SKILL.md]"]
end

node_engineer(("CLI user"))

node_engineer -->|"reads"| node_quickstart
node_quickstart -->|"references"| node_command_reference
node_quickstart -->|"lists"| node_cli_guide
node_quickstart -->|"lists"| node_flow_guide
node_quickstart -->|"lists"| node_workflow_code_guide
node_quickstart -->|"lists"| node_app_guide
node_quickstart -->|"references"| node_trigger_guide
node_quickstart -->|"references"| node_schedule_guide
node_quickstart -->|"lists"| node_resource_guide
node_quickstart -->|"lists"| node_preview_guide
node_quickstart -->|"indexes"| node_script_ansible
node_quickstart -->|"indexes"| node_script_bash
node_quickstart -->|"indexes"| node_script_bigquery
node_quickstart -->|"indexes"| node_script_bun
node_quickstart -->|"indexes"| node_script_bunnative
node_quickstart -->|"indexes"| node_script_csharp
node_quickstart -->|"indexes"| node_script_deno
node_quickstart -->|"indexes"| node_script_duckdb
node_quickstart -->|"indexes"| node_script_go
node_quickstart -->|"indexes"| node_script_graphql
node_quickstart -->|"indexes"| node_script_java
node_quickstart -->|"indexes"| node_script_mssql
node_quickstart -->|"indexes"| node_script_mysql
node_quickstart -->|"indexes"| node_script_php
node_quickstart -->|"indexes"| node_script_postgresql
node_quickstart -->|"indexes"| node_script_powershell
node_quickstart -->|"indexes"| node_script_python
node_quickstart -->|"indexes"| node_script_rlang
node_quickstart -->|"indexes"| node_script_rust
node_quickstart -->|"indexes"| node_script_snowflake

click node_quickstart "https://github.com/windmill-labs/windmill-cli-docs/blob/main/README.md"
click node_command_reference "https://github.com/windmill-labs/windmill-cli-docs/blob/main/cli-commands.md"
click node_cli_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/cli-commands/SKILL.md"
click node_flow_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-flow/SKILL.md"
click node_workflow_code_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-workflow-as-code/SKILL.md"
click node_app_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/raw-app/SKILL.md"
click node_trigger_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/triggers/SKILL.md"
click node_schedule_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/schedules/SKILL.md"
click node_resource_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/resources/SKILL.md"
click node_preview_guide "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/preview/SKILL.md"
click node_script_ansible "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-ansible/SKILL.md"
click node_script_bash "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bash/SKILL.md"
click node_script_bigquery "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bigquery/SKILL.md"
click node_script_bun "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bun/SKILL.md"
click node_script_bunnative "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bunnative/SKILL.md"
click node_script_csharp "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-csharp/SKILL.md"
click node_script_deno "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-deno/SKILL.md"
click node_script_duckdb "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-duckdb/SKILL.md"
click node_script_go "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-go/SKILL.md"
click node_script_graphql "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-graphql/SKILL.md"
click node_script_java "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-java/SKILL.md"
click node_script_mssql "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-mssql/SKILL.md"
click node_script_mysql "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-mysql/SKILL.md"
click node_script_php "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-php/SKILL.md"
click node_script_postgresql "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-postgresql/SKILL.md"
click node_script_powershell "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-powershell/SKILL.md"
click node_script_python "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-python3/SKILL.md"
click node_script_rlang "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-rlang/SKILL.md"
click node_script_rust "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-rust/SKILL.md"
click node_script_snowflake "https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-snowflake/SKILL.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_quickstart,node_engineer toneBlue
class node_command_reference toneAmber
class node_cli_guide,node_flow_guide,node_workflow_code_guide,node_app_guide,node_trigger_guide,node_schedule_guide,node_resource_guide,node_preview_guide,node_script_ansible,node_script_bash,node_script_bigquery,node_script_bun,node_script_bunnative,node_script_csharp,node_script_deno,node_script_duckdb,node_script_go,node_script_graphql,node_script_java,node_script_mssql,node_script_mysql,node_script_php,node_script_postgresql,node_script_powershell,node_script_python,node_script_rlang,node_script_rust,node_script_snowflake toneMint
```

## Components

### Getting started

- [Quickstart](https://github.com/windmill-labs/windmill-cli-docs/blob/main/README.md): `README.md`

### Command reference

- [CLI commands](https://github.com/windmill-labs/windmill-cli-docs/blob/main/cli-commands.md): `cli-commands.md`

### Task guides

- [CLI guide](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/cli-commands/SKILL.md): `skills/cli-commands/SKILL.md`
- [Flow authoring](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-flow/SKILL.md): `skills/write-flow/SKILL.md`
- [Workflow as code](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-workflow-as-code/SKILL.md): `skills/write-workflow-as-code/SKILL.md`
- [Raw apps](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/raw-app/SKILL.md): `skills/raw-app/SKILL.md`
- [Triggers](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/triggers/SKILL.md): `skills/triggers/SKILL.md`
- [Schedules](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/schedules/SKILL.md): `skills/schedules/SKILL.md`
- [Resources](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/resources/SKILL.md): `skills/resources/SKILL.md`
- [Preview](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/preview/SKILL.md): `skills/preview/SKILL.md`
- [Ansible scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-ansible/SKILL.md): `skills/write-script-ansible/SKILL.md`
- [Bash scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bash/SKILL.md): `skills/write-script-bash/SKILL.md`
- [BigQuery scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bigquery/SKILL.md): `skills/write-script-bigquery/SKILL.md`
- [Bun scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bun/SKILL.md): `skills/write-script-bun/SKILL.md`
- [Bun native scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-bunnative/SKILL.md): `skills/write-script-bunnative/SKILL.md`
- [C# scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-csharp/SKILL.md): `skills/write-script-csharp/SKILL.md`
- [Deno scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-deno/SKILL.md): `skills/write-script-deno/SKILL.md`
- [DuckDB scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-duckdb/SKILL.md): `skills/write-script-duckdb/SKILL.md`
- [Go scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-go/SKILL.md): `skills/write-script-go/SKILL.md`
- [GraphQL scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-graphql/SKILL.md): `skills/write-script-graphql/SKILL.md`
- [Java scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-java/SKILL.md): `skills/write-script-java/SKILL.md`
- [SQL Server scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-mssql/SKILL.md): `skills/write-script-mssql/SKILL.md`
- [MySQL scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-mysql/SKILL.md): `skills/write-script-mysql/SKILL.md`
- [PHP scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-php/SKILL.md): `skills/write-script-php/SKILL.md`
- [PostgreSQL scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-postgresql/SKILL.md): `skills/write-script-postgresql/SKILL.md`
- [PowerShell scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-powershell/SKILL.md): `skills/write-script-powershell/SKILL.md`
- [Python scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-python3/SKILL.md): `skills/write-script-python3/SKILL.md`
- [R scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-rlang/SKILL.md): `skills/write-script-rlang/SKILL.md`
- [Rust scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-rust/SKILL.md): `skills/write-script-rust/SKILL.md`
- [Snowflake scripts](https://github.com/windmill-labs/windmill-cli-docs/blob/main/skills/write-script-snowflake/SKILL.md): `skills/write-script-snowflake/SKILL.md`

### Other components

- **CLI user**

## Connections

- CLI user → Quickstart: reads
- Quickstart → CLI commands: references
- Quickstart → CLI guide: lists
- Quickstart → Flow authoring: lists
- Quickstart → Workflow as code: lists
- Quickstart → Raw apps: lists
- Quickstart → Triggers: references
- Quickstart → Schedules: references
- Quickstart → Resources: lists
- Quickstart → Preview: lists
- Quickstart → Ansible scripts: indexes
- Quickstart → Bash scripts: indexes
- Quickstart → BigQuery scripts: indexes
- Quickstart → Bun scripts: indexes
- Quickstart → Bun native scripts: indexes
- Quickstart → C# scripts: indexes
- Quickstart → Deno scripts: indexes
- Quickstart → DuckDB scripts: indexes
- Quickstart → Go scripts: indexes
- Quickstart → GraphQL scripts: indexes
- Quickstart → Java scripts: indexes
- Quickstart → SQL Server scripts: indexes
- Quickstart → MySQL scripts: indexes
- Quickstart → PHP scripts: indexes
- Quickstart → PostgreSQL scripts: indexes
- Quickstart → PowerShell scripts: indexes
- Quickstart → Python scripts: indexes
- Quickstart → R scripts: indexes
- Quickstart → Rust scripts: indexes
- Quickstart → Snowflake scripts: indexes