Skip to content

CLI

Complete reference for Klisk CLI commands.

klisk

Initializes the workspace and shows the welcome message.

bash
klisk

Creates ~/klisk/ and ~/klisk/projects/ if they don't exist.

klisk create

Creates a new agent project.

bash
klisk create <name>

Generates the project structure in ~/klisk/projects/<name>/ with virtual environment, dependencies, and example files.

klisk studio

Starts the Studio and dev server in the background.

bash
klisk studio                  # Start Studio (workspace mode, loads all projects)
klisk studio --stop           # Stop the dev server

The server runs as a background daemon — it prints the URL and PID, then returns control to the terminal immediately. The server survives terminal closure.

If you run klisk studio while a server is already running, it detects the existing instance and shows its URL instead of launching a duplicate.

PID files are stored in ~/klisk/run/ and logs in ~/klisk/logs/.

Loads all projects from ~/klisk/projects/ into a single Studio session. Agents from different projects are prefixed with the project name if there are name conflicts.

Includes hot reload: file changes are reflected automatically.

klisk run

Runs the agent from the terminal.

bash
klisk run -p <name> "<message>"     # Direct message
klisk run -p <name> -i              # Interactive mode

Multimodal input:

bash
klisk run -p <name> "@image.jpg Describe this"
klisk run -p <name> "@document.pdf Summarize this"

klisk check

Validates the project's configuration, tools, and agents.

bash
klisk check <name>                  # Entire project
klisk check <name> -a <agent>       # A specific agent

Validates:

  • Project configuration
  • Entry point
  • Agent and tool discovery
  • Docstrings and type hints
  • Correct usage of temperature and reasoning_effort

klisk list

Lists all projects in the workspace.

bash
klisk list

klisk status

Shows a full workspace overview: location, project count, Studio status, and a table of all projects.

bash
klisk status

Example output:

  Klisk Status

  Workspace:   ~/klisk
  Projects:    3

  Studio

  Status:      Running (pid 12345)
  Studio + API: http://localhost:8321
  Uptime:      2h 15m
  Logs:        ~/klisk/logs/workspace.log

  Projects

  ┌──────────┬──────────┬─────────────────────┐
  │ Name     │ Entry    │ Path                │
  ├──────────┼──────────┼─────────────────────┤
  │ my-agent │ agent.py │ ~/klisk/projects/.. │
  └──────────┴──────────┴─────────────────────┘

klisk delete

Deletes a project.

bash
klisk delete <name>

klisk config

View or set global Klisk configuration.

bash
klisk config                          # Show current config
klisk config gcloud.project my-id     # Set a value
klisk config gcloud.region us-central1

Configuration is stored in ~/klisk/config.yaml.

klisk docker

Generates Docker deployment files for your project.

bash
klisk docker <name>

Creates a Dockerfile and .dockerignore, and updates requirements.txt with the correct dependencies. Automatically detects if the project uses LiteLLM models and includes the appropriate extras.

klisk start

Starts the production server.

bash
klisk start <name> --port 8080

Exposes: chat UI (/), REST API (/api/chat), WebSocket (/ws/chat), widget (/widget.js).

klisk assistant

Opens an AI-powered assistant that guides you through creating, configuring, and debugging agents interactively. Instead of writing code yourself, you describe what you want in natural language and the assistant builds it for you.

bash
klisk assistant [<name>]

If you pass a project name, the assistant opens in the context of that project. Without arguments, it starts a general session.

Prerequisites

  1. Install the assistant extra:
bash
pip install 'klisk[assistant]'
  1. You must have an active Claude Code session. The assistant runs on top of Claude Code, so you need to have it installed and logged in before running klisk assistant.

How it works

The assistant uses Claude Code under the hood with the Klisk skill pre-loaded. It has full knowledge of the Klisk framework and can:

  • Create new projects and scaffold tools
  • Edit agent instructions and configuration
  • Add and wire up new tools
  • Debug issues with klisk check
  • Open the Studio to test your agent
  • Deploy to production

Example

bash
klisk assistant my-agent

"Add a tool that searches for products in my Shopify store and wire it to the agent"

The assistant will create the tool file, add the necessary dependencies, update get_tools() in main.py, and run klisk check to validate everything — all without you writing a single line of code.

Klisk Documentation