Skip to main content

​
Prerequisites

Before installing know, ensure you have:
  • Python 3.13 or higher - Check your version with python --version
  • uv (recommended) - Fast Python package installer
uv is the recommended installer. Install it from astral.sh/uv

​
Installation Methods

​
Verify Installation

Confirm that know is installed correctly: 
know --help
You should see the help message with available commands: 
Usage: know [OPTIONS] COMMAND [ARGS]...

know - semantic search CLI

Commands:
  add     Add a directory to the watch list.
  remove  Remove a directory from the watch list.
  index   Index all watched directories.
  search  Search indexed documents.
  dirs    List watched directories.
  reset   Clear the entire index.
  prune   Remove orphaned chunks from deleted files.

​
What Gets Installed

know installs with these key dependencies:
  • ChromaDB - Local vector database for storing embeddings
  • LlamaIndex - Document loading and chunking
  • BM25s - Lexical search support
  • Typer - CLI framework
All data is stored locally on your machine. know creates a ./know_index directory in your current working directory and tracks watched directories in ~/.know_dirs.

​
Next Steps

Quickstart

Get started with know in under 2 minutes

Supported Files

See which file types know can index

Build docs developers (and LLMs) love

Get started for freeTalk to us