Add Nu lang docs + changelog (windmill-labs#852)

pyranota · hcourdent · web-flow · commit 21509dcf8a52 · 2025-03-31T15:39:29.000+02:00
* docs: nu

* remove leftovers

* update sidebars.js

* update docs

* update according to parser rewrite

* update changelog

---------

Co-authored-by: Henri Courdent &lt;122811744+hcourdent@users.noreply.github.com&gt;
diff --git a/changelog/2025-03-27-nu-lang-support/index.md b/changelog/2025-03-27-nu-lang-support/index.md
@@ -0,0 +1,14 @@
+---
+slug: nu-lang-support
+version: v1.479.0
+title: Nushell
+tags: ['Nushell', 'Nu', 'Code editor']
+description: Nu is cross-platform and statically typed shell written in Rust. Now shipped to windmill
+features:
+  [
+    'Write your Windmill script in Nu.',
+    'Run your Nu scripts locally or in the cloud.',
+  ]
+image: ./nu-lang.png
+docs: docs/getting_started/scripts_quickstart/bash/#nu
+---
diff --git a/changelog/2025-03-27-nu-lang-support/nu-lang.png b/changelog/2025-03-27-nu-lang-support/nu-lang.png
diff --git a/docs/advanced/4_local_development/index.mdx b/docs/advanced/4_local_development/index.mdx
@@ -209,6 +209,7 @@ But what if you want to create a new script from scratch? It's also easy, just c
 | MS SQL Server       | `.ms.sql`                   |
 | GraphQL             | `.gql`                      |
 | PowerShell          | `.ps1`                      |
+| Nu                  | `.nu`                       |
 
 </details>
 
@@ -315,4 +316,4 @@ To [run scripts locally](../4_local_development/run_locally.mdx), you will need
 		description="Run scripts locally that interact with a Windmill instance."
 		href="/docs/advanced/local_development/run_locally"
 	/>
-</div>
+</div>
diff --git a/docs/advanced/6_imports/index.mdx b/docs/advanced/6_imports/index.mdx
@@ -123,6 +123,15 @@ e.g.:
 ```powershell
 Import-Module -Name MyModule
 ```
+## Imports in Nu
+
+For [Nu](../../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx#nu) you can import stdlib.
+
+e.g.:
+
+```python
+use std
+```
 
 ## Dependencies on Local development
 
diff --git a/docs/core_concepts/2_variables_and_secrets/index.mdx b/docs/core_concepts/2_variables_and_secrets/index.mdx
@@ -184,7 +184,13 @@ $Headers = @{
 Invoke-RestMethod -Headers $Headers -Uri "$Env:BASE_INTERNAL_URL/api/w/$Env:WM_WORKSPACE/variables/get/u/user/foo"
 ```
 
-The last examples in bash and PowerShell showcase well how it works under the hood: It fetches the secret from the API using the job's permissions through the ephemeral token passed as an environment variable to the job.
+Nu:
+
+```python
+get_variable u/user/foo
+```
+
+Examples in bash and PowerShell showcase well how it works under the hood: It fetches the secret from the API using the job's permissions through the ephemeral token passed as an environment variable to the job.
 
 ## Mocked API files
 
@@ -196,4 +202,4 @@ Simulate API interactions locally by using a JSON file to store and retrieve var
 		description="Simulate API interactions locally by using a JSON file to store and retrieve variables and resources."
 		href="/docs/advanced/local_development/#mocked-api-files"
 	/>
-</div>
+</div>
diff --git a/docs/core_concepts/3_resources_and_types/index.mdx b/docs/core_concepts/3_resources_and_types/index.mdx
@@ -399,6 +399,12 @@ $Headers = @{
 Invoke-RestMethod -Headers $Headers -Uri "$Env:BASE_INTERNAL_URL/api/w/$Env:WM_WORKSPACE/resources/get/u/user/foo"
 ```
 
+Nu:
+
+```python
+get_resource u/user/foo
+```
+
 ![Fetch resource](./fetch_resource.png.webp)
 
 ### Resources in Apps
@@ -451,4 +457,4 @@ Simulate API interactions locally by using a JSON file to store and retrieve var
 		description="Simulate API interactions locally by using a JSON file to store and retrieve variables and resources."
 		href="/docs/advanced/local_development/#mocked-api-files"
 	/>
-</div>
+</div>
diff --git a/docs/core_concepts/9_worker_groups/index.mdx b/docs/core_concepts/9_worker_groups/index.mdx
@@ -129,6 +129,7 @@ The tags of _default_ worker group are:
 - `rust`: The default worker group for [Rust](../../getting_started/0_scripts_quickstart/9_rust_quickstart/index.mdx) scripts.
 - `ansible`: The default worker group for [Ansible](../../getting_started/0_scripts_quickstart/10_ansible_quickstart/index.mdx) scripts.
 - `csharp`: The default worker group for [C#](../../getting_started/0_scripts_quickstart/11_csharp_quickstart/index.mdx) scripts.
+- `nu`: The default worker group for [Nu scripts](../../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx#nu).
 - `other`: Everything else (other than the [native](#native-worker-group) tags).
 
 #### Native worker group
diff --git a/docs/core_concepts/index.mdx b/docs/core_concepts/index.mdx
@@ -646,7 +646,7 @@ All details & features on [Pricing page](/pricing).
 	/>
 	<DocCard
 		title="Windows workers"
-		description="Windows Native Workers are a Self-Hosted Enterprise Feature. You can use the Windows worker natively if you do not want to run Docker or WSL on Windows (e.g., for policy or security reasons). This feature supports the **Python**, **Bun**, and **PowerShell** executors."
+		description="Windows Native Workers are a Self-Hosted Enterprise Feature. You can use the Windows worker natively if you do not want to run Docker or WSL on Windows (e.g., for policy or security reasons). This feature supports the **Python**, **Bun**, **PowerShell** and **Nu** executors."
 		href="/docs/misc/windows_workers"
 	/>
 	<DocCard
diff --git a/docs/flows/3_editor_components.mdx b/docs/flows/3_editor_components.mdx
@@ -307,6 +307,7 @@ You can either create a new action script in:
 - [TypeScript](../getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx): Windmill uses Deno as the TypeScript runtime.
 - [Go](../getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx).
 - [Bash](../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx).
+- [Nu](../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx).
 - Any language [running any docker container](../advanced/7_docker/index.mdx) through Windmill's bash support.
 
 There are special kinds of scripts, [SQL and query languages](../getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx):
@@ -438,4 +439,4 @@ The result and logs are displayed on the left-hand side.
 		href="/docs/core_concepts/instant_preview"
 		color="teal"
 	/>
-</div>
+</div>
diff --git a/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx
@@ -7,9 +7,9 @@ import DocCard from '@site/src/components/DocCard';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Bash / PowerShell quickstart
+# Bash / PowerShell / Nu quickstart
 
-In this quick start guide, we will write our first script in Bash and PowerShell.
+In this quick start guide, we will write our first script in Bash, PowerShell or Nu.
 
 <video
 	className="border-2 rounded-lg object-cover w-full h-full dark:border-gray-800"
@@ -53,7 +53,7 @@ Scripts consist of 2 parts:
 
 When stored in a code repository, those 2 parts are stored separately at `<path>.sh` and `<path>.script.yaml`.
 
-Below is a simple example of a script built in Bash/Powershell with Windmill:
+Below is a simple example of a script built in Bash/Powershell/Nu with Windmill:
 
 <Tabs className="unique-tabs">
 <TabItem value="bash" label="Bash" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
@@ -86,6 +86,22 @@ if ($status_code -like "2*" -or $status_code -like "3*") {
     Write-Host "The URL is not reachable."
 }
 ```
+</TabItem>
+<TabItem value="nu" label="Nu" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
+
+```python
+def main [
+  url: string = "default value"
+] {
+  try {
+    # Nu will throw an error automatically if request fails
+    http get $url
+    echo "The URL is reachable!"
+  } catch {
+    echo "The URL is not reachable."
+  }
+}
+```
 
 </TabItem>
 </Tabs>
@@ -184,6 +200,76 @@ Default arguments can be specified using the syntax above: `$argument_name = "It
 
 The last line of the output, here `Write-Output "Hello $Msg"`, is the return value, which might be useful if the script is used in a [flow](../../../flows/1_flow_editor.mdx) or [app](../../../apps/0_app_editor/index.mdx) to pass its result on.
 
+### Nu
+
+Unlike `Bash` and `PowerShell`, `Nu` requires main function and all arguments should defined in signature.
+It supports typed, optional and default arguments.
+
+<Tabs className="unique-tabs">
+<TabItem value="simple" label="Simple" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
+
+```python
+def main [ msg, dflt = "default value", nb: number = 3 ] {
+	echo $"Hello ($msg)"
+}
+```
+</TabItem>
+<TabItem value="complete" label="Complete" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
+
+```python
+use std assert
+# Nushell
+# A new type of shell
+def main [
+    no_default: string,
+    name = "Nicolas Bourbaki",
+    age: int = 42,
+    date_of_birth?: datetime,
+    obj: record = {"records": "included"},
+    l: list<string> = ["or", "lists!"],
+    tables?: table,
+    enable_kill_mode?: bool = true,
+] {
+    # Test
+    # https://www.nushell.sh/book/testing.html
+		assert ($age == 42)
+
+    print $"Hello World and a warm welcome especially to ($name)"
+    print "and its acolytes.." $age $obj $l
+    print $tables
+
+    let secret = try { 
+      get_variable f/examples/secret
+    } catch { 
+      'No secret yet at f/examples/secret !' 
+    };
+
+    print $"The variable at \`f/examples/secret\`: ($secret)"
+    # fetch context variables
+    let user = $env.WM_USERNAME
+
+    # Nu pipelines
+    ls | where size > 1kb | sort-by modified | print "ls:" $in
+
+    # Nu works with existing data
+    # Nu speaks JSON, YAML, SQLite, Excel, and more out of the box. 
+    # It's easy to bring data into a Nu pipeline whether it's in a file, a database, or a web API:
+    let nu_license = http get https://api.github.com/repos/nushell/nushell | get license
+
+    return { splitted: ($name | split words), user: $user, nu_license: $nu_license}
+    # Interested in learning more?
+    # https://www.nushell.sh/book/getting_started.html
+
+```
+
+</TabItem>
+</Tabs>
+
+One of the strong sides of `Nu` is that it is cross-platform. If you have linux workers and [windows workers](../../../misc/17_windows_workers/index.mdx)
+Nushell scripts will be able to run on both!
+
+If you are interested in `Nu` you can read their [official documentation](https://www.nushell.sh/book/getting_started.html)
+
 ## Instant preview & testing
 
 Look at the UI preview on the right: it was updated to match the input
@@ -215,6 +301,13 @@ argument_name="${1:-Its default value}"
 $argument_name = "Its default value"
 ```
 
+</TabItem>
+<TabItem value="nu" label="Nu" attributes={{className: "text-xs p-4 !mt-0 !ml-0"}}>
+
+```python
+def main [ argument_name = "Its default value" ] { }
+```
+
 </TabItem>
 </Tabs>
 
@@ -277,6 +370,8 @@ You can also choose to [run the script from the CLI](../../../advanced/3_cli/ind
 
 The last line returned by the script will be the string result. To use a json result instead, output your result in `./result.json` and it will be automatically picked-up and considered as the JSON result for Bash and Powershell scripts.
 
+For Nu first returned data from main function will be used as a result.
+
 ## Run Docker containers
 
 In some cases where your task requires a complex set of dependencies or is implemented in a non-supported language, you can still include it as a flow step or individual script.
diff --git a/docs/getting_started/0_scripts_quickstart/index.mdx b/docs/getting_started/0_scripts_quickstart/index.mdx
@@ -31,8 +31,8 @@ Windmill supports scripts in TypeScript, Python, Go, PHP, Bash, C#, SQL and Rust
 		Icon={SiPython}
 	/>
 	<DocCard
-		title="Bash / Powershell"
-		description="Write your first Windmill script in Bash / Powershell."
+		title="Bash / Powershell / Nu"
+		description="Write your first Windmill script in Bash / Powershell / Nu."
 		href="/docs/getting_started/scripts_quickstart/bash"
 		Icon={SiGnubash}
 	/>
diff --git a/docs/misc/17_windows_workers/index.mdx b/docs/misc/17_windows_workers/index.mdx
@@ -5,7 +5,7 @@ import DocCard from '@site/src/components/DocCard';
 Windows Native Workers are a [Self-Hosted Enterprise](/pricing) Feature.
 
 You can use the Windows worker natively if you do not want to run Docker or WSL on Windows (e.g., for policy or security reasons).
-This feature supports the **Python**, **Bun**, and **PowerShell** executors.
+This feature supports the **Python**, **Bun**, **PowerShell** and **Nu** executors.
 
 You can connect Windows workers to your existing Dockerized or cloud self-hosted PostgreSQL database and Windmill server.
 
@@ -62,9 +62,7 @@ You can also check other installation methods in uv`s [official documentation](h
      # Replace these variables with your specific configuration
      $env:BUN_PATH="C:\Users\Alex\.bun\bin\bun.exe"
      ```
-
 ### PowerShell executor
-
 1. **Install PowerShell 7+ (stable)**: Ensure you have the latest stable release of PowerShell by following the [official documentation](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows).
    - Start PowerShell 7 and verify you're running PowerShell 7 by checking `$PSVersionTable`:
      ```powershell
@@ -88,3 +86,23 @@ You can also check other installation methods in uv`s [official documentation](h
      # Replace these variables with your specific configuration
      $env:POWERSHELL_PATH="C:\Program Files\PowerShell\7\pwsh.exe"
      ```
+### Nu executor
+
+1. **Nu**: Ensure you have installed Nu by following the [official documentation](https://www.nushell.sh/book/installation.html#package-managers).
+   - Start PowerShell and verify you can enter Nushell:
+     ```powershell
+     nu
+     ```
+
+2. **Locate Nu installation**:
+   - Find where Nu is installed by running:
+     ```powershell
+     where.exe nu.exe 
+     ```
+
+3. **Set environment variables**:
+   - Add the following environment variables (replace the placeholders with your specific values):
+     ```powershell
+     # Replace these variables with your specific configuration
+     $env:NU_PATH="C:\..\..\nu.exe"
+     ```
diff --git a/docs/script_editor/settings.mdx b/docs/script_editor/settings.mdx
@@ -50,7 +50,7 @@ Language of the script. Windmill supports:
 - [TypeScript](../getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx) (Bun & Deno)
 - [Python](../getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx)
 - [Go](../getting_started/0_scripts_quickstart/3_go_quickstart/index.mdx)
-- [Bash & Powershell](../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx)
+- [Bash & Powershell & Nu](../getting_started/0_scripts_quickstart/4_bash_quickstart/index.mdx)
 - [SQL](../getting_started/0_scripts_quickstart/5_sql_quickstart/index.mdx) (PostgreSQL, MySQL, MS SQL, BigQuery, Snowflake)
 - [Rest & GraphQL](../getting_started/0_scripts_quickstart/6_rest_grapqhql_quickstart/index.mdx)
 - [Docker](../getting_started/0_scripts_quickstart/7_docker_quickstart/index.mdx)
diff --git a/sidebars.js b/sidebars.js
@@ -38,7 +38,7 @@ const sidebars = {
 								{
 									type: 'doc',
 									id: 'getting_started/scripts_quickstart/bash_quickstart/index',
-									label: 'Bash / PowerShell'
+									label: 'Bash / PowerShell / Nu'
 								},
 								{
 									type: 'doc',
@@ -79,7 +79,7 @@ const sidebars = {
 									type: 'doc',
 									id: 'getting_started/scripts_quickstart/csharp_quickstart/index',
 									label: 'C#'
-								}
+								},
 							]
 						},
 						{

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ const sidebars = {`
`38`	`38`	`{`
`39`	`39`	`type: 'doc',`
`40`	`40`	`id: 'getting_started/scripts_quickstart/bash_quickstart/index',`
`41`		`- label: 'Bash / PowerShell'`
	`41`	`+ label: 'Bash / PowerShell / Nu'`
`42`	`42`	`},`
`43`	`43`	`{`
`44`	`44`	`type: 'doc',`
`@@ -79,7 +79,7 @@ const sidebars = {`
`79`	`79`	`type: 'doc',`
`80`	`80`	`id: 'getting_started/scripts_quickstart/csharp_quickstart/index',`
`81`	`81`	`label: 'C#'`
`82`		`- }`
	`82`	`+ },`
`83`	`83`	`]`
`84`	`84`	`},`
`85`	`85`	`{`