koffi

KO | EN

gitlite — search

#ai #typescript #llm #go #linux #awesome #kubernetes #awesome-list #vue #pytorch #security #mcp #ios #openai

(★ 413)

Fast and easy-to-use C FFI module for Node.js

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
LICENSE.txt
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

You can find more information and documentation on the [official web page](https://koffi.dev).

If you like this project, consider supporting me:

# Overview

Koffi is a fast and easy-to-use dynamic C FFI module for Node.js, featuring:

* Low-overhead compared to a static Node-API implementation (see [benchmarks](https://koffi.dev/benchmarks))
* Support for primitive and aggregate data types (structs and fixed-size arrays), both by reference (pointer) and by value
* Support for synchronous and asynchronous calls
* Javascript functions can be used as C callbacks
* Well-tested code base for popular OS/architecture combinations

The following combinations of OS and architectures __are officially supported and tested__ at the moment:

ISA / OS           | Windows     | Linux    | macOS       | FreeBSD     | OpenBSD
------------------ | ----------- | -------- | ----------- | ----------- | --------
x86 (IA32) [^1]    | ✅ Yes      | ✅ Yes   | ⬜️ *N/A*    | ✅ Yes      | ✅ Yes
x86_64 (AMD64)     | ✅ Yes      | ✅ Yes   | ✅ Yes      | ✅ Yes      | ✅ Yes
ARM64 (AArch64) LE | ✅ Yes      | ✅ Yes   | ✅ Yes      | ✅ Yes      | 🟨 Probably
RISC-V 64 [^2]     | ⬜️ *N/A*    | ✅ Yes   | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably

[^1]: The following call conventions are supported: cdecl, stdcall, MS fastcall, thiscall.
[^2]: The prebuilt binary uses the LP64D (double-precision float) ABI. The LP64 ABI is supported in theory if you build Koffi from source but this is untested. The LP64F ABI is not supported.

Use the following links for more information:

- Documentation: https://koffi.dev/
- Changelog: https://koffi.dev/changelog
- Source code: https://codeberg.org/Koromix/rygel/ (see below for an explanation)

# Source code

This repository does not contain the code of Koffi but only exists as a front. For pratical reasons, I've started using a single repository for all my projects in 2018 because it is easier to manage.

The source code is available here: https://codeberg.org/Koromix/rygel/ (in the *src/koffi* subdirectory).

Monorepositories have two killer features for me:

* Cross-project refactoring
* Simplified dependency management

You can find a more detailed rationale here: https://danluu.com/monorepo/

# Build manually

Koffi is built with a custom CMake-wrapper called CNoke, which also lives in the monorepository. Don't try to run CMake manually because it will fail.

Follow the [documented build instructions](https://koffi.dev/contribute#build-from-source) to build Koffi from source.

# License

This program is free software: you can redistribute it and/or modify it under the terms of the **MIT License**.

Find more information here: https://choosealicense.com/licenses/mit/

koffi

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

koffi

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README