Skip to content
NIKI

Installation

Requirements

  • Python 3.10+
  • A Telegram account (for notifications) and/or Slack workspace
  • An Anthropic API key (for AI summaries)

Install NIKI

Terminal window
# Basic install
pip install niki


# With all features (recommended)
pip install niki[all]


# With specific features
pip install niki[slack]      # Slack support
pip install niki[telegram]   # Telegram support
pip install niki[jupyter]    # Jupyter integration

Quick Setup

Run the interactive configuration wizard:

Terminal window
niki config init

This will prompt you for:

  1. Telegram bot token - from @BotFather
  2. Your Telegram chat ID - the wizard helps you find this
  3. Anthropic API key - for AI-powered summaries

Start the Daemon

Terminal window
niki daemon start

For production use, run in a tmux/screen session or as a systemd service.

Verify Installation

Terminal window
# Check everything is configured correctly
niki doctor


# Send a test notification
niki watch -- echo "Hello from NIKI"

You should receive a notification on Telegram/Slack!

Configuration File

NIKI stores configuration in ~/.niki/config.toml:

[general]
notification_mode = "active"


[notifications.telegram]
enabled = true
bot_token = "YOUR_BOT_TOKEN"
allowed_user_ids = [YOUR_CHAT_ID]


[ai]
api_key_env = "ANTHROPIC_API_KEY"
dry_run = false

Next Steps