Where should I put completions to make them available in nu shell out of the box? about nu_scripts

[fdncred]

When I create scripts that I always want to be loaded, I put them in a folder that nushell can reach without changes. For nushell that means anywhere setup in NU_LIB_DIRS. Any file within that list of folders can be sourced without the need to specify the full path.

For me that means that I modify my env.nu with something like this.

# By default, <nushell-config-dir>/scripts is added
let-env NU_LIB_DIRS = [
    ($nu.config-path | path dirname | path join 'scripts')
    '/Users/fdncred/src/forks/nu_scripts'
]

Now, anything in nu_scripts can be sourced in my config.nu like this (because all of these are below the path I added above).

# external completions
use "custom-completions/cargo/cargo-completions.nu" *
use "custom-completions/git/git-completions.nu" *
use "custom-completions/winget/winget-completions.nu" *

# get_weather
use "weather/get-weather.nu" get_weather

[amtoine]

maybe in a new kde subdirectory inside ./custom-completions/? 😋

following the convention of the other subdirectories, you might want to put a README and a kde-completions.nu file 👍

[amtoine]

Are scripts from this repo automatically installed with Nushell or not? thinking I am not sure...

as @fdncred said, they are not 🤔
scripts need to be available in your NU_LIB_DIRS path, defined in env.nu 👍

if you add the path to your local copy of the nu_scripts to your NU_LIB_DIRS, they will be sourced when nushell starts 😉

[amtoine]

for instance, here is my NU_LIB_DIRS, because i define scripts inside ~/.config/nushell/lib/... which is not a standard location for that 😋

let-env NU_LIB_DIRS = [
    ($nu.config-path | path dirname | path join 'lib')
    ($nu.config-path | path dirname | path join 'lib' "core")
    ($nu.config-path | path dirname | path join 'lib' "scripts")
    ($nu.config-path | path dirname | path join 'lib' "personal")
]

hope that's clear 😌

[EmilyGraceSeville7cf]

Are scripts from this repo automatically installed with Nushell or not? 🤔 I am not sure...

[amtoine]

When I create scripts that I always want to be loaded, I put them in a folder that nushell can reach without changes. For nushell that means anywhere setup in NU_LIB_DIRS. Any file within that list of folders can be sourced without the need to specify the full path.

definitely something i did not mention, thanks 😌

@EmilySeville7cfg, it depends on whether you want to share your completion script with the community 😉

[EmilyGraceSeville7cf]

I guess I can close this issue as my question is solved. ;)