Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Evincere/klisk/llms.txt

Use this file to discover all available pages before exploring further.

Klisk is a Python package that can be installed via pip. This guide covers installation, requirements, and verification.

​
Requirements

1

Python Version

Klisk requires Python 3.10 or higher. Check your Python version:
python --version
If you need to upgrade Python, download the latest version from python.org.
2

API Keys

You’ll need an API key for at least one LLM provider:
OpenAI is the default provider, but Klisk supports any LiteLLM-compatible provider.
3

Operating System

Klisk works on:
  • macOS (recommended for development)
  • Linux (Ubuntu, Debian, CentOS, etc.)
  • Windows (via WSL or native)
Windows users should use WSL (Windows Subsystem for Linux) for the best experience.

​
Install Klisk

Install Klisk using pip: 
pip install klisk
This installs:
  • The klisk CLI command
  • The Klisk Python library
  • All required dependencies (OpenAI Agents SDK, FastAPI, LiteLLM, etc.)
It’s best practice to install Klisk in a virtual environment: 
# Create a virtual environment
python -m venv venv

# Activate it (macOS/Linux)
source venv/bin/activate

# Activate it (Windows)
venv\Scripts\activate

# Install Klisk
pip install klisk

​
Install Development Dependencies

If you plan to contribute to Klisk or run tests, install the development dependencies: 
pip install klisk[dev]
This includes:
  • pytest — Testing framework
  • pytest-asyncio — Async test support
  • httpx — HTTP client for testing

​
Verify Installation

Confirm that Klisk is installed correctly: 
klisk --version
You should see output like: 
klisk version 0.1.3

​
View Available Commands

List all available CLI commands: 
klisk --help
You should see: 
Usage: klisk [OPTIONS] COMMAND [ARGS]...

  Klisk - Build AI agents programmatically

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  create   Scaffold a new agent project
  dev      Start Studio with hot reload
  run      Run agent from terminal
  check    Validate project configuration
  list     List workspace projects
  serve    Start production server
  deploy   Deploy to Google Cloud Run

​
Configure API Keys

After installation, you’ll need to configure your API keys. There are two ways to do this: When you create a new project with klisk create, a .env file is automatically generated. Add your API keys there:
.env
OPENAI_API_KEY=sk-your-key-here

# Uncomment and fill in the API key for your chosen provider:
# ANTHROPIC_API_KEY=sk-ant-your-key-here
# GEMINI_API_KEY=your-key-here
# MISTRAL_API_KEY=your-key-here
Never commit your .env file to version control. Klisk projects include .env in .gitignore by default.

​
Option 2: System Environment Variables

You can also set environment variables globally: 
# Add to ~/.bashrc or ~/.zshrc
export OPENAI_API_KEY="sk-your-key-here"
export ANTHROPIC_API_KEY="sk-ant-your-key-here"

# Reload your shell
source ~/.bashrc  # or source ~/.zshrc

​
Troubleshooting

If you get a “command not found” error after installation:
  1. Check if pip installed to the correct location: 
    pip show klisk
  2. Ensure pip’s bin directory is in your PATH: 
    # macOS/Linux
export PATH="$HOME/.local/bin:$PATH"

# Add this to ~/.bashrc or ~/.zshrc to make it permanent
  3. Try using python -m klisk instead: 
    python -m klisk --version
This usually means Klisk wasn’t installed in your current Python environment:
  1. Verify your Python environment: 
    which python
which pip
  2. Reinstall Klisk: 
    pip uninstall klisk
pip install klisk
  3. If using a virtual environment, make sure it’s activated: 
    source venv/bin/activate  # macOS/Linux
venv\Scripts\activate      # Windows
If you see an error about LiteLLM when using non-OpenAI models:
pip install litellm
Or reinstall Klisk with LiteLLM support:
pip install 'openai-agents[litellm]'
Klisk requires Python 3.10 or higher. If you have an older version:
  1. Install a newer Python version from python.org
  2. Create a virtual environment with the new version: 
    python3.11 -m venv venv
source venv/bin/activate
pip install klisk
  3. Or use pyenv to manage multiple Python versions: 
    pyenv install 3.11.0
pyenv local 3.11.0
pip install klisk

​
Upgrade Klisk

To upgrade to the latest version: 
pip install --upgrade klisk
Check your current version: 
klisk --version

​
Uninstall Klisk

To uninstall Klisk: 
pip uninstall klisk
This removes the klisk command and Python package, but preserves your agent projects.

​
Next Steps

Now that Klisk is installed, you’re ready to build your first agent:

Quickstart

Build your first agent in 5 minutes

Introduction

Learn about Klisk’s features and capabilities

Build docs developers (and LLMs) love

Get started for freeTalk to us