Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@alexjh/knowz) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Knowz CLI

A powerful personal knowledge management system with AI-powered semantic search capabilities.

Quick Start

npx knowz-cli --help

Installation

Global Installation

npm install -g knowz-cli
knowz --help

Local Installation

npm install knowz-cli
npx knowz --help

Features

🧠 AI-Powered Search: Semantic search using OpenAI embeddings
🔍 Vector Similarity: Find related content using vector search
📚 Knowledge Organization: Organize information by topics and tags
🌐 Multi-Mode Support: Works offline, online, or in hybrid mode
🔒 Encryption Support: Optional database encryption
🎯 Smart Chunking: Intelligent content chunking for better search
🤖 AI Chat Interface: Interactive chat with your knowledge base

Configuration

Create a configuration file at ~/.knowz/appsettings.json:

{
  "VectorStore": {
    "Provider": "AzureAISearch",
    "AzureAISearch": {
      "Endpoint": "https://your-search.search.windows.net",
      "ApiKey": "your-api-key",
      "IndexName": "knowledge-items"
    }
  },
  "EmbeddingService": {
    "Provider": "OpenAI",
    "OpenAI": {
      "ApiKey": "your-openai-api-key",
      "Model": "text-embedding-3-small"
    }
  }
}

Usage

Add Knowledge

knowz add

Search

knowz search "your query"

Interactive Chat

knowz chat

Browse Knowledge

knowz browse

Supported Platforms

macOS (x64, ARM64)
Linux (x64, ARM64)
Windows (x64, ARM64)

Documentation

For full documentation, visit the GitHub repository.

License

MIT