Skip to content

how to create package

hanzala-Databrain edited this page Aug 29, 2025 · 1 revision

Welcome to the duckdb-node-neo wiki!

  1. Fork the duckdb-node-neo
  2. Clone the fork repo in local
  3. Update all .npmrc with
@${YOUR_USERNAME}: registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=${NPM_AUTH_TOKEN}
  1. Update the workflow file DuckDBNodeBindingsAndAPI
  2. Replace all the places in code files duckdb -> username eg. databrainhq (make sure in scripts folder there are binary links so don't replace that)
  3. Replace all the folder name from @duckdb -> @username
  4. Generate 2 tokens from TOKENs copy and save them for later
  • write_package -> permissions - read:public_key, write:packages, repo
  • read_package -> permissions - read:public_key, read:packages
  1. Create 2 secret variable - in the repo
  • YOUR_USERNAME=databrainhq
  • NPM_AUTH_TOKEN=ghp_xxxxxx_xxxxxxxxxxxxx (here use write_package token which you created in step 7)

How to use this package:

  1. In bash terminal
export NPM_AUTH_TOKEN=read_package token step 7
export YOUR_USERNAME=databrainhq
  1. npm login --scope=@databrainhq --registry=https://npm.pkg.github.com/
username: databrainhq
password: read_package token step 7
  1. now you can install this package
npm install @databrainhq/node-api@1.3.2-alpha.26.5
Clone this wiki locally