Installation

npm / yarn / pnpm

npm install -g axiom-wiki

yarn global add axiom-wiki

pnpm add -g axiom-wiki

Run without installing:

npx axiom-wiki init

Both axiom-wiki and the shorthand axwiki are available after install.

From source

git clone https://github.com/abubakarsiddik31/axiom-wiki.git
cd axiom-wiki
pnpm install && pnpm build
pnpm link --global
axiom-wiki init

Docker

docker run -it -v $(pwd):/wiki axiomwiki/axiom-wiki init

See the Docker section below for Compose examples.

Docker Compose

Cloud provider:

services:
  axiom-wiki:
    image: axiomwiki/axiom-wiki
    volumes:
      - ./my-wiki:/wiki
    environment:
      - GOOGLE_GENERATIVE_AI_API_KEY=${GOOGLE_GENERATIVE_AI_API_KEY}

With Ollama (fully offline):

services:
  axiom-wiki:
    image: axiomwiki/axiom-wiki
    volumes:
      - ./wiki:/app/wiki
      - ./raw:/app/raw
    environment:
      - OLLAMA_BASE_URL=http://ollama:11434/api
  ollama:
    image: ollama/ollama
    volumes:
      - ollama_data:/root/.ollama
volumes:
  ollama_data: