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
{{ message }}
This repository was archived by the owner on Feb 4, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ $ sqlpkg help
13
13
│ Commands: │
14
14
│ help Display help │
15
15
│ info Display package information │
16
-
│ init Create local repository │
16
+
│ init Init project scope │
17
17
│ install Install packages │
18
18
│ list List installed packages │
19
19
│ uninstall Uninstall package │
@@ -174,9 +174,9 @@ sqlpkg version
174
174
175
175
Displays `sqlpkg` version number.
176
176
177
-
## Using a local repository
177
+
## Project vs. global scope
178
178
179
-
By default, `sqlpkg` installs all extensions in the home folder. If you are writing a Python (JavaScript, Go, ...) application — you may prefer to put them in the project folder (like virtual environment in Python or `node_modules` in JavaScript).
179
+
By default, `sqlpkg` installs all extensions in the home folder (global scope). If you are writing a Python (JavaScript, Go, ...) application — you may prefer to put them in the project folder (project scope, like virtual environment in Python or `node_modules` in JavaScript).
180
180
181
181
To do that, run the `init` command:
182
182
@@ -194,7 +194,7 @@ If you _are_ a package author, who wants your package to be installable by `sqlp
194
194
195
195
## Lockfile
196
196
197
-
`sqlpkg` stores information about the installed packages in a special file (the _lockfile_) — `sqlpkg.lock`. If you're using a local repository, it's a good idea to commit `sqlpkg.lock` along with other code. This way, when you check out the code on another machine, you can install all the packages at once.
197
+
`sqlpkg` stores information about the installed packages in a special file (the _lockfile_) — `sqlpkg.lock`. If you're using a project scope, it's a good idea to commit `sqlpkg.lock` along with other code. This way, when you check out the code on another machine, you can install all the packages at once.
198
198
199
199
To install the packages listed in the lockfile, simply run `install` with no arguments:
0 commit comments