wllama
WebAssembly binding for llama.cpp - Enabling on-browser LLM inference
File Explorer
Download Latest Version (.zip)- build-hf-space.yml
- ci.yml
- generate-docs.yml
- verify-generated-code.yml
- screenshot_0.png
- wllama.js
- .npmignore
- index.js
- package.json
- README.md
- generate_glue_prototype.js
- glue.hpp
- test_glue.cpp
- wllama-context.h
- wllama-fs.h
- wllama.cpp
- wllama.h
- .gitignore
- CMakeLists.txt
- main.cpp
- README.md
- index.html
- index.html
- favicon.ico
- wllama.png
- ChatScreen.tsx
- GuideScreen.tsx
- LogScreen.tsx
- MarkdownMessage.tsx
- ModelScreen.tsx
- Navbar.tsx
- ScreenWrapper.tsx
- Sidebar.tsx
- benchmark.ts
- custom-models.tsx
- displayed-model.tsx
- messages.context.tsx
- nl2br.tsx
- types.ts
- use-interval-when.ts
- utils.ts
- wllama.context.tsx
- App.tsx
- config.ts
- index.css
- main.tsx
- vite-env.d.ts
- .eslintrc.cjs
- .gitignore
- index.html
- package-lock.json
- package.json
- postcss.config.js
- README.md
- tailwind.config.cjs
- tsconfig.app.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- bliss.png
- index.html
- index.html
- index.html
- intro-v2.md
- intro-v3.1.md
- intro-v3.md
- bisect_test.sh
- build_hf_space.sh
- build_source_map.js
- build_wasm.sh
- build_worker.sh
- check_debug_build.js
- check_package_size.js
- docker-compose.yml
- generate_wasm_from_cdn.js
- http_server.js
- post_build.sh
- glue.ts
- messages.ts
- cos.test.ts
- cos.ts
- index.ts
- opfs.ts
- oai-compat.ts
- types.ts
- source-map.ts
- wllama.js
- wllama.wasm
- generated.ts
- llama-cpp.js
- opfs-utils.js
- cache-manager.ts
- debug.ts
- huggingface.ts
- index.ts
- mjs.test.ts
- model-manager.test.ts
- model-manager.ts
- utils.test.ts
- utils.ts
- wasm-from-cdn.ts
- wllama.test.ts
- wllama.ts
- wllama.wgpu.test.ts
- worker.ts
- .gitignore
- .gitmodules
- .npmignore
- .prettierignore
- AGENTS.md
- CMakeLists.txt
- index.ts
- LICENCE
- llama.cpp
- package-lock.json
- package.json
- README-dev.md
- README.md
- README_banner.png
- tsconfig.build.json
- tsup.config.ts
- vitest.config.ts
# Installation Guide
1. Get the code
git clone https://github.com/ngxson/wllama
Downloads the entire project code from GitHub to your computer.
cd wllama
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f scripts/docker-compose.yml up -d --build
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. CMake
MediumPrerequisites
mkdir build && cd build
Creates a folder to hold the build output and moves into it.
cmake ..
Analyzes the source code and generates build configuration files (must be run inside the build folder).
make
Compiles the code based on the generated build configuration to produce an executable.
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
4. Node.js
EasyPrerequisites
npm i @wllama/wllama
Type this command into your terminal and run it.
npm i
Type this command into your terminal and run it.
npm run build:wasm
Builds optimized production files.
npm run build
Builds optimized production files.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)