Skip to content

docs: update startup stages to include sourcing of autoload directories #2158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fdncred merged 1 commit into from
Apr 21, 2026
+17 −1
Merged

docs: update startup stages to include sourcing of autoload directories #2158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion book/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ✅ Sources user's `config.nu` file if it exists if it exists in the config directory
- ❌ Does not read `personal login.nu` file
- ✅ Enters the REPL
- ✅ Sources the files in `vendor-autoload-dirs`
- ✅ Sources the files in `user-autoload-dirs`

- `nu -c "ls"`:

Expand All @@ -630,7 +632,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the user's `login.nu` file
- ✅ Runs the `ls` command and exits
- ❌ Does not enter the REPL

- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`
- `nu -l -c "ls"`:

- ✅ Makes the Standard Library available
Expand All @@ -642,6 +645,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ✅ Sources the user's `login.nu` file if it exists in the config directory
- ✅ Runs the `ls` command and exits
- ❌ Does not enter the REPL
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`

- `nu -l -c "ls" --config foo_config.nu`

Expand All @@ -658,6 +663,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the user's `login.nu` file
- ✅ Runs the `ls` command and exits
- ❌ Does not enter the REPL
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`

- `nu test.nu`:

Expand All @@ -670,6 +677,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the user's `login.nu` file
- ✅ Runs `test.nu` file as a script
- ❌ Does not enter the REPL
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`

- `nu --config foo_config.nu test.nu`

Expand All @@ -682,6 +691,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the user's `login.nu` file
- ✅ Runs `test.nu` file as a script
- ❌ Does not enter the REPL
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`

- `nu -n --no-std-lib` (fastest REPL startup):

Expand All @@ -692,6 +703,8 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the internal `default_config.nu` file
- ❌ Does not read the user's `config.nu` file
- ❌ Does not read the user's `login.nu` file
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`
- ✅ Enters the REPL

- `nu -n --no-std-lib -c "ls"` (fastest command-string invocation):
Expand All @@ -705,3 +718,6 @@ The following stages and their steps _may_ occur during startup, based on the fl
- ❌ Does not read the user's `login.nu` file
- ✅ Runs the `ls` command and exits
- ❌ Does not enter the REPL
- ❌ Does not source the files in `vendor-autoload-dirs`
- ❌ Does not source the files in `user-autoload-dirs`