Skip to content

Commit 945fd33

Browse files
committed
chore: add build script help
1 parent 11c4eba commit 945fd33

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,33 @@ npm install mongodb-client-encryption
2727

2828
#### Setup
2929

30-
Run the following command to build libmongocrypt and setup the node bindings for development:
30+
31+
Run the following command to build libmongocrypt and you are setup to develop the node bindings:
3132

3233
```shell
33-
bash ./etc/build-static.sh
34+
npm run install:libmongocrypt
35+
```
36+
37+
#### `libmongocrypt.mjs`
38+
39+
```
40+
node libmongocrypt.mjs [--gitURL=string] [--libVersion=string] [--clean] [--build] [--no-crypto] [--fastDownload]
41+
42+
By default attempts to download and compile the bindings with the crypto prebuilds of libmongocrypt.
43+
Can be configured to clone and build without crypto.
44+
45+
--gitURL=string A custom remote git repository to clone libmongocrypt from. You must also set --build to use this.
46+
--libVersion=string A custom version reference to either download or checkout after cloning.
47+
You may use "latest" to get current libmongocrypt `HEAD`.
48+
--clean Combined with --build, the script will not skip cloning and rebuilding libmongocrypt.
49+
--build Instead of downloading, clone and build libmongocrypt along with the bindings.
50+
--no-crypto Use libmongocrypt prebuild or build libmongocrypt without OpenSSL symbols.
51+
Requires the bindings to provide cryptoCallbacks.
52+
53+
Only suitable for local development:
54+
55+
--fastDownload If you are improving this script or otherwise repeatedly downloading libmongocrypt,
56+
this flag will interrupt the un-tar operation as early as possible. It should work, most of the time.
3457
```
3558

3659
#### Prebuild Platforms

0 commit comments

Comments
 (0)