Skip to content

Environment Variables

TuskBot reads configuration from environment variables.

In normal usage, these values are stored in <TUSK_RUNTIME_PATH>/.env and loaded on startup.

Core Runtime

VariableRequiredDefaultDescription
TUSK_RUNTIME_PATHNo~/.tuskbotRuntime data directory.
TUSK_CHAT_CHANNELYes-Active transport (currently telegram).
TUSK_CONTEXT_WINDOW_SIZENo30Number of recent messages in short-term context.
TUSK_DEBUGNo0Set 1 to enable debug logging.

Model and Embeddings

VariableRequiredDescription
TUSK_MAIN_MODELYesMain model in provider/model format.
TUSK_EMBEDDING_MODELYesEmbedding model filename inside models/.

Provider Credentials

Set credentials for the provider used by TUSK_MAIN_MODEL.

VariableDescription
TUSK_ANTHROPIC_API_KEYAnthropic API key
TUSK_OPENAI_API_KEYOpenAI API key
TUSK_OPENROUTER_API_KEYOpenRouter API key
TUSK_OLLAMA_BASE_URLOllama base URL (default http://127.0.0.1:11434)
TUSK_OLLAMA_API_KEYOptional Ollama API key
TUSK_CUSTOM_OPENAI_BASE_URLOpenAI-compatible base URL
TUSK_CUSTOM_OPENAI_API_KEYOpenAI-compatible API key

Telegram

VariableRequiredDescription
TUSK_TELEGRAM_TOKENYesTelegram bot token from @BotFather
TUSK_TELEGRAM_OWNER_IDYesTelegram user ID allowed to use the bot

Service Mode

These variables affect tusk service ... commands.

VariableRequiredDefaultDescription
TUSK_SERVICE_NAMENotuskbotService name/unit label
TUSK_SERVICE_DISPLAY_NAMENoTuskBotHuman-readable service name
TUSK_SERVICE_DESCRIPTIONNoTuskBot background agent serviceService description
TUSK_SERVICE_USER_MODENotrueInstall service for current user by default
TUSK_SERVICE_LOG_DIRECTORYNo<TUSK_RUNTIME_PATH>/logsService stdout/stderr log directory
TUSK_SERVICE_PATHNoauto-builtPATH used by service processes

Notes

  • tusk install writes .env with file mode 0600.
  • Changing model via /model persists TUSK_MAIN_MODEL back to .env.

Released under the MIT License