Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

KT-CLI

⚠️ Note: This feature is currently under active development. Many functionalities are not yet complete and are being improved. Please stay tuned for updates.

Design Philosophy

KT-CLI is designed to minimize the burden of reading documentation. Instead of requiring users to read lengthy docs, the CLI provides:

  • Interactive Mode: Run commands without arguments to get step-by-step guided prompts
  • Direct Mode: Pass arguments directly for automation and scripting

    💡 Tip: The arguments are fully compatible with the previous SGLang + KTransformers approach, so you can migrate seamlessly.

Simply run a command, and the CLI will interactively guide you through the process!

Usage

You can check the usage by kt --help

kt [OPTIONS] COMMAND [ARGS]...

KTransformers CLI - A unified command-line interface for KTransformers.

Options

OptionDescription
--helpShow this message and exit.

Commands

CommandDescription
versionShow version information
chatInteractive chat with running model
quantQuantize model weights
benchRun full benchmark
microbenchRun micro-benchmark
doctorDiagnose environment issues
modelManage models and storage paths
configManage configuration
sftFine-tuning with LlamaFactory