Installation & Setup

Oink ships on npm as oink0 and exposes the oink and olink binaries. Choose the path that fits your workflow.

Option A: Global install

pnpm install -g oink0

This mirrors the command in the public README and is the fastest way to use Oink across repositories. After installing, run oink --help to confirm the CLI is accessible.

Option B: Run from source

1. Install dependencies:

   pnpm install

2. Bundle the CLI:

   pnpm run transpile

   This uses esbuild to bundle index.ts into dist/ and normalises any node: protocol imports for broader Node support.

3. Launch the compiled CLI:

   node --enable-source-maps dist

Need a standalone executable? Run pnpm run predeploy, then pnpm run deploy:local to copy dist/run.js into /usr/local/bin/oink (requires sudo).

Tip

After installing, run oink learn inside a sample package and check for a new entry under ~/.config/oink/link/. That confirms Oink can read and write its registry.