You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Install all global dependencies from ~/.config/nuance/config.toml
56
-
nuance install -g
63
+
# Install all global dependencies from ~/.config/quiver/config.toml
64
+
qv install -g
57
65
58
66
# Re-resolve everything (ignore lockfile)
59
-
nuance update
67
+
qv update
60
68
61
69
# Remove a dependency
62
-
nuance remove nu-some-module
70
+
qv remove nu-some-module
63
71
64
72
# Remove a script dependency
65
-
nuance remove-script quickfix
73
+
qv remove-script quickfix
66
74
67
-
# List installed dependencies (project-local if mod.toml exists, otherwise global)
68
-
nuance list
75
+
# List installed dependencies (project-local if nupackage.toml exists, otherwise global)
76
+
qv list
69
77
```
70
78
71
79
## How It Works
72
80
73
-
A nuance project is a directory containing:
81
+
A quiver project is a directory containing:
74
82
75
-
-**`mod.toml`** — declares package metadata and dependencies
83
+
-**`nupackage.toml`** — declares package metadata and dependencies
76
84
-**`<project-dir-name>/mod.nu`** — the Nushell module entry point
77
-
-**`mod.lock`** — auto-generated lockfile pinning exact commits (commit this to version control)
85
+
-**`quiver.lock`** — auto-generated lockfile pinning exact commits (commit this to version control)
78
86
79
-
Running `nuance install` fetches module dependencies into `.nu_modules/` and script dependencies into `.nu_scripts/`.
87
+
Running `qv install` fetches module dependencies into `.nu_modules/` and script dependencies into `.nu_scripts/`.
80
88
81
89
## Activation
82
90
83
91
To make installed modules/scripts available to `use` in Nushell without full paths, add the project's dependency directories to `$env.NU_LIB_DIRS`.
84
92
85
-
Nuance provides two ways to do this:
93
+
Quiver provides two ways to do this:
86
94
87
95
### 1. Manual Activation (Recommended)
88
-
`nuance install` and `nuance init` generate activation scripts for both dependency kinds:
96
+
`qv install` and `qv init` generate activation scripts for both dependency kinds:
89
97
90
98
-`.nu_modules/activate.nu` (module overlay): updates `$env.NU_LIB_DIRS` and imports module dependencies with `export use <name> *`
91
99
-`.nu_scripts/activate.nu` (sourceable script loader): sources script dependencies with `source <name>.nu`
@@ -106,18 +114,18 @@ When you're done, run `deactivate` (or `overlay hide activate`) to unload the mo
106
114
107
115
### 2. Auto-activation Hook
108
116
109
-
If you want nuance projects to automatically update your module path when you `cd` into their directory (and remove it when you leave), add the following to your `config.nu` or `env.nu`:
117
+
If you want quiver projects to automatically update your module path when you `cd` into their directory (and remove it when you leave), add the following to your `config.nu` or `env.nu`:
You can also simply run these commands without adding them to your config or env file. You just won't receive any modifications of the hook until you run the commands again, but your shell startup time will be faster.
117
125
118
126
> **Note**: Due to Nushell's static scoping rules, the auto-activation hook only updates `$env.NU_LIB_DIRS`. It cannot auto-import module/script commands. For automatic loading, use the manual activation approach above.
119
127
120
-
## mod.toml
128
+
## nupackage.toml
121
129
122
130
```toml
123
131
[package]
@@ -142,35 +150,35 @@ Script dependencies must include `path` and exactly one of `tag`, `branch`, or `
142
150
143
151
| Command | Description |
144
152
|---------|-------------|
145
-
|`nuance init`| Create a new `mod.toml` and scaffold `<project-dir-name>/mod.nu` in the current directory |
146
-
|`nuance add <source>`| Add a module dependency from a URL or owner/repo shorthand (auto-detects latest tag) |
147
-
|`nuance add-script [-g] [--autoload] <source> [path]`| Add a script dependency locally (`mod.toml`) or globally (`config.toml`) |
148
-
|`nuance install`| Install dependencies from `mod.toml`|
149
-
|`nuance install -g`| Install global dependencies from `~/.config/nuance/config.toml`|
150
-
|`nuance install --frozen`| Install from lockfile only (CI-friendly) |
0 commit comments