Installation
Install Knowns through package managers or from source.
On this page
Install the knowns CLI first. Installation only makes the command available; you still need to run knowns init inside each repository where you want Knowns-managed project context.
Requirements
- a supported terminal environment on macOS, Linux, or Windows
- Git if you want repository-aware init/setup behavior
- optional local model downloads if you plan to use semantic search
Platform support
| Platform | CLI artifact | Bundled local ONNX |
|---|---|---|
| macOS Apple Silicon | darwin-arm64 | Yes |
| macOS Intel (x86_64) | darwin-x64 | No |
| Linux x64 | linux-x64 | Yes |
| Linux ARM64 | linux-arm64 | Yes |
| Windows x64 | win32-x64 | Yes |
On macOS Intel, the full CLI and keyword/BM25 search remain available. Local ONNX controls are disabled because ONNX Runtime no longer provides a compatible prebuilt macOS x86_64 library. For semantic search, use Ollama or an OpenAI-compatible API provider.
Advanced users can explicitly set KNOWN_ORT_LIB to a compatible x86_64 libonnxruntime.dylib; Knowns will then enable the local ONNX provider.
Homebrew
brew install knowns-dev/tap/knowns
Recommended on macOS and Linux when you want a packaged install.
npm
npm install -g knowns
Useful when your environment already uses Node tooling.
Shell installer (macOS/Linux)
curl -fsSL https://knowns.sh/script/install | sh
PowerShell installer (Windows)
irm https://knowns.sh/script/install.ps1 | iex
Build from source
go build -o ./bin/knowns ./cmd/knowns
Best option when developing Knowns itself.
Verify
knowns --version
If the command prints a version, the CLI is installed. Next, move into the repository you want to manage and run the quick start.
No-global-install option
If you do not want a global install, you can still run Knowns through npm:
npx knowns init
Uninstall
See Uninstall for Homebrew, npm, shell installer, PowerShell, Go install, runtime adapter cleanup, and what project files are intentionally left behind.
Next step
Cài knowns CLI trước. Việc cài đặt chỉ làm cho command khả dụng; bạn vẫn cần chạy knowns init trong từng repository muốn quản lý bằng Knowns.
Yêu cầu
- Terminal trên macOS, Linux, hoặc Windows
- Git (nếu muốn
knowns initnhận diện repo) - Tùy chọn: local model cho semantic search
Nền tảng được hỗ trợ
| Nền tảng | Gói CLI | Local ONNX đi kèm |
|---|---|---|
| macOS Apple Silicon | darwin-arm64 | Có |
| macOS Intel (x86_64) | darwin-x64 | Không |
| Linux x64 | linux-x64 | Có |
| Linux ARM64 | linux-arm64 | Có |
| Windows x64 | win32-x64 | Có |
Trên macOS Intel, toàn bộ CLI và tìm kiếm từ khóa/BM25 vẫn hoạt động. Các thiết lập Local ONNX được tắt vì ONNX Runtime không còn cung cấp thư viện macOS x86_64 dựng sẵn tương thích. Để dùng semantic search, hãy chọn Ollama hoặc API tương thích OpenAI.
Người dùng nâng cao có thể chủ động đặt KNOWN_ORT_LIB trỏ đến libonnxruntime.dylib x86_64 tương thích; khi đó Knowns sẽ bật lại provider Local ONNX.
Homebrew
brew install knowns-dev/tap/knowns
Cách nên dùng trên macOS/Linux.
npm
npm install -g knowns
Phù hợp nếu đã dùng Node tooling sẵn.
Shell installer (macOS/Linux)
curl -fsSL https://knowns.sh/script/install | sh
PowerShell installer (Windows)
irm https://knowns.sh/script/install.ps1 | iex
Build từ source
go build -o ./bin/knowns ./cmd/knowns
Dùng khi đang dev chính Knowns.
Kiểm tra
knowns --version
Nếu command in ra version, CLI đã cài xong. Tiếp theo, vào repository bạn muốn quản lý và chạy quick start.
Không muốn cài global?
Chạy qua npx:
npx knowns init
Gỡ cài đặt
Xem Gỡ cài đặt cho Homebrew, npm, shell installer, PowerShell, Go install, cleanup runtime adapter, và các project files được giữ lại có chủ ý.