kimi-cli 0.35__py3-none-any.whl

kimi_cli/CHANGELOG.md

@@ -0,0 +1,304 @@
+# Changelog
+
+<!--
+Release notes will be parsed and available as /release-notes
+The parser extracts for each version:
+  - a short description (first paragraph after the version header)
+  - bullet entries beginning with "- " under that version (across any subsections)
+Internal builds may append content to the Unreleased section.
+Only write entries that are worth mentioning to users.
+-->
+
+## [0.35] - 2025-10-22
+
+### Changed
+
+- Minor UI improvements
+- Auto download ripgrep if not found in the system
+- Always approve tool calls in `--print` mode
+- Add `/feedback` meta command
+
+## [0.34] - 2025-10-21
+
+### Added
+
+- Add `/update` meta command to check for updates and auto-update in background
+- Support running interactive shell commands in raw shell mode
+- Add `/setup` meta command to setup LLM provider and model
+- Add `/reload` meta command to reload configuration
+
+## [0.33] - 2025-10-18
+
+### Added
+
+- Add `/version` meta command
+- Add raw shell mode, which can be switched to by Ctrl-K
+- Show shortcuts in bottom status line
+
+### Fixed
+
+- Fix logging redirection
+- Merge duplicated input histories
+
+## [0.32] - 2025-10-16
+
+### Added
+
+- Add bottom status line
+- Support file path auto-completion (`@filepath`)
+
+### Fixed
+
+- Do not auto-complete meta command in the middle of user input
+
+## [0.31] - 2025-10-14
+
+### Fixed
+
+- Fix step interrupting by Ctrl-C, for real
+
+## [0.30] - 2025-10-14
+
+### Added
+
+- Add `/compact` meta command to allow manually compacting context
+
+### Fixed
+
+- Fix `/clear` meta command when context is empty
+
+## [0.29] - 2025-10-14
+
+### Added
+
+- Support Enter key to accept completion in shell mode
+- Remember user input history across sessions in shell mode
+- Add `/reset` meta command as an alias for `/clear`
+
+### Fixed
+
+- Fix step interrupting by Ctrl-C
+
+### Changed
+
+- Disable `SendDMail` tool in Kimi Koder agent
+
+## [0.28] - 2025-10-13
+
+### Added
+
+- Add `/init` meta command to analyze the codebase and generate an `AGENTS.md` file
+- Add `/clear` meta command to clear the context
+
+### Fixed
+
+- Fix `ReadFile` output
+
+## [0.27] - 2025-10-11
+
+### Added
+
+- Add `--mcp-config-file` and `--mcp-config` options to load MCP configs
+
+### Changed
+
+- Rename `--agent` option to `--agent-file`
+
+## [0.26] - 2025-10-11
+
+### Fixed
+
+- Fix possible encoding error in `--output-format stream-json` mode
+
+## [0.25] - 2025-10-11
+
+### Changed
+
+- Rename package name `ensoul` to `kimi-cli`
+- Rename `ENSOUL_*` builtin system prompt arguments to `KIMI_*`
+- Further decouple `App` with `Soul`
+- Split `Soul` protocol and `KimiSoul` implementation for better modularity
+
+## [0.24] - 2025-10-10
+
+### Fixed
+
+- Fix ACP `cancel` method
+
+## [0.23] - 2025-10-09
+
+### Added
+
+- Add `extend` field to agent file to support agent file extension
+- Add `exclude_tools` field to agent file to support excluding tools
+- Add `subagents` field to agent file to support defining subagents
+
+## [0.22] - 2025-10-09
+
+### Changed
+
+- Improve `SearchWeb` and `FetchURL` tool call visualization
+- Improve search result output format
+
+## [0.21] - 2025-10-09
+
+### Added
+
+- Add `--print` option as a shortcut for `--ui print`, `--acp` option as a shortcut for `--ui acp`
+- Support `--output-format stream-json` to print output in JSON format
+- Add `SearchWeb` tool with `services.moonshot_search` configuration. You need to configure it with `"services": {"moonshot_search": {"api_key": "your-search-api-key"}}` in your config file.
+- Add `FetchURL` tool
+- Add `Think` tool
+- Add `PatchFile` tool, not enabled in Kimi Koder agent
+- Enable `SendDMail` and `Task` tool in Kimi Koder agent with better tool prompts
+- Add `ENSOUL_NOW` builtin system prompt argument
+
+### Changed
+
+- Better-looking `/release-notes`
+- Improve tool descriptions
+- Improve tool output truncation
+
+## [0.20] - 2025-09-30
+
+### Added
+
+- Add `--ui acp` option to start Agent Client Protocol (ACP) server
+
+## [0.19] - 2025-09-29
+
+### Added
+
+- Support piped stdin for print UI
+- Support `--input-format=stream-json` for piped JSON input
+
+### Fixed
+
+- Do not include `CHECKPOINT` messages in the context when `SendDMail` is not enabled
+
+## [0.18] - 2025-09-29
+
+### Added
+
+- Support `max_context_size` in LLM model configurations to configure the maximum context size (in tokens)
+
+### Improved
+
+- Improve `ReadFile` tool description
+
+## [0.17] - 2025-09-29
+
+### Fixed
+
+- Fix step count in error message when exceeded max steps
+- Fix history file assertion error in `kimi_run`
+- Fix error handling in print mode and single command shell mode
+- Add retry for LLM API connection errors and timeout errors
+
+### Changed
+
+- Increase default max-steps-per-run to 100
+
+## [0.16.0] - 2025-09-26
+
+### Tools
+
+- Add `SendDMail` tool (disabled in Kimi Koder, can be enabled in custom agent)
+
+### SDK
+
+- Session history file can be specified via `_history_file` parameter when creating a new session
+
+## [0.15.0] - 2025-09-26
+
+- Improve tool robustness
+
+## [0.14.0] - 2025-09-25
+
+### Added
+
+- Add `StrReplaceFile` tool
+
+### Improved
+
+- Emphasize the use of the same language as the user
+
+## [0.13.0] - 2025-09-25
+
+### Added
+
+- Add `SetTodoList` tool
+- Add `User-Agent` in LLM API calls
+
+### Improved
+
+- Better system prompt and tool description
+- Better error messages for LLM
+
+## [0.12.0] - 2025-09-24
+
+### Added
+
+- Add `print` UI mode, which can be used via `--ui print` option
+- Add logging and `--debug` option
+
+### Changed
+
+- Catch EOF error for better experience
+
+## [0.11.1] - 2025-09-22
+
+### Changed
+
+- Rename `max_retry_per_step` to `max_retries_per_step`
+
+## [0.11.0] - 2025-09-22
+
+### Added
+
+- Add `/release-notes` command
+- Add retry for LLM API errors
+- Add loop control configuration, e.g. `{"loop_control": {"max_steps_per_run": 50, "max_retry_per_step": 3}}`
+
+### Changed
+
+- Better extreme cases handling in `read_file` tool
+- Prevent Ctrl-C from exiting the CLI, force the use of Ctrl-D or `exit` instead
+
+## [0.10.1] - 2025-09-18
+
+- Make slash commands look slightly better
+- Improve `glob` tool
+
+## [0.10.0] - 2025-09-17
+
+### Added
+
+- Add `read_file` tool
+- Add `write_file` tool
+- Add `glob` tool
+- Add `task` tool
+
+### Changed
+
+- Improve tool call visualization
+- Improve session management
+- Restore context usage when `--continue` a session
+
+## [0.9.0] - 2025-09-15
+
+- Remove `--session` and `--continue` options
+
+## [0.8.1] - 2025-09-14
+
+- Fix config model dumping
+
+## [0.8.0] - 2025-09-14
+
+- Add `shell` tool and basic system prompt
+- Add tool call visualization
+- Add context usage count
+- Support interrupting the agent loop
+- Support project-level `AGENTS.md`
+- Support custom agent defined with YAML
+- Support oneshot task via `kimi -c`

kimi_cli/__init__.py

@@ -0,0 +1,374 @@
+import asyncio
+import contextlib
+import importlib.metadata
+import json
+import os
+import subprocess
+import sys
+import textwrap
+import warnings
+from datetime import datetime
+from pathlib import Path
+from typing import Any, Literal
+
+import click
+from pydantic import SecretStr
+
+from kimi_cli.agent import (
+    DEFAULT_AGENT_FILE,
+    AgentGlobals,
+    BuiltinSystemPromptArgs,
+    load_agent_with_mcp,
+    load_agents_md,
+)
+from kimi_cli.config import (
+    Config,
+    ConfigError,
+    LLMModel,
+    LLMProvider,
+    load_config,
+)
+from kimi_cli.metadata import Session, continue_session, new_session
+from kimi_cli.share import get_share_dir
+from kimi_cli.soul.approval import Approval
+from kimi_cli.soul.context import Context
+from kimi_cli.soul.denwarenji import DenwaRenji
+from kimi_cli.soul.kimisoul import KimiSoul
+from kimi_cli.ui.acp import ACPServer
+from kimi_cli.ui.print import InputFormat, OutputFormat, PrintApp
+from kimi_cli.ui.shell import Reload, ShellApp
+from kimi_cli.utils.logging import StreamToLogger, logger
+from kimi_cli.utils.provider import augment_provider_with_env_vars, create_llm
+
+__version__ = importlib.metadata.version("kimi-cli")
+USER_AGENT = f"KimiCLI/{__version__}"
+
+UIMode = Literal["shell", "print", "acp"]
+
+
+@click.command(context_settings=dict(help_option_names=["-h", "--help"]))
+@click.version_option(__version__)
+@click.option(
+    "--verbose",
+    is_flag=True,
+    default=False,
+    help="Print verbose information. Default: no.",
+)
+@click.option(
+    "--debug",
+    is_flag=True,
+    default=False,
+    help="Log debug information. Default: no.",
+)
+@click.option(
+    "--agent-file",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+    default=DEFAULT_AGENT_FILE,
+    help="Custom agent specification file. Default: builtin Kimi Koder.",
+)
+@click.option(
+    "--model",
+    "-m",
+    "model_name",
+    type=str,
+    default=None,
+    help="LLM model to use. Default: default model set in config file.",
+)
+@click.option(
+    "--work-dir",
+    "-w",
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path),
+    default=Path.cwd(),
+    help="Working directory for the agent. Default: current directory.",
+)
+@click.option(
+    "--continue",
+    "-C",
+    "continue_",
+    is_flag=True,
+    default=False,
+    help="Continue the previous session for the working directory. Default: no.",
+)
+@click.option(
+    "--command",
+    "-c",
+    "--query",
+    "-q",
+    "command",
+    type=str,
+    default=None,
+    help="User query to the agent. Default: prompt interactively.",
+)
+@click.option(
+    "--ui",
+    "ui",
+    type=click.Choice(["shell", "print", "acp"]),
+    default="shell",
+    help="UI mode to use. Default: shell.",
+)
+@click.option(
+    "--print",
+    "ui",
+    flag_value="print",
+    help="Run in print mode. Shortcut for `--ui print`.",
+)
+@click.option(
+    "--acp",
+    "ui",
+    flag_value="acp",
+    help="Start ACP server. Shortcut for `--ui acp`.",
+)
+@click.option(
+    "--input-format",
+    type=click.Choice(["text", "stream-json"]),
+    default=None,
+    help=(
+        "Input format to use. Must be used with `--print` "
+        "and the input must be piped in via stdin. "
+        "Default: text."
+    ),
+)
+@click.option(
+    "--output-format",
+    type=click.Choice(["text", "stream-json"]),
+    default=None,
+    help="Output format to use. Must be used with `--print`. Default: text.",
+)
+@click.option(
+    "--mcp-config-file",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=Path),
+    multiple=True,
+    help=(
+        "MCP config file to load. Add this option multiple times to specify multiple MCP configs. "
+        "Default: none."
+    ),
+)
+@click.option(
+    "--mcp-config",
+    type=str,
+    multiple=True,
+    help=(
+        "MCP config JSON to load. Add this option multiple times to specify multiple MCP configs. "
+        "Default: none."
+    ),
+)
+def kimi(
+    verbose: bool,
+    debug: bool,
+    agent_file: Path,
+    model_name: str | None,
+    work_dir: Path,
+    continue_: bool,
+    command: str | None,
+    ui: UIMode,
+    input_format: InputFormat | None,
+    output_format: OutputFormat | None,
+    mcp_config_file: list[Path],
+    mcp_config: list[str],
+):
+    """Kimi, your next CLI agent."""
+    echo = click.echo if verbose else lambda *args, **kwargs: None
+
+    logger.add(
+        get_share_dir() / "logs" / "kimi.log",
+        level="DEBUG" if debug else "INFO",
+        rotation="06:00",
+        retention="10 days",
+    )
+
+    work_dir = work_dir.absolute()
+
+    if continue_:
+        session = continue_session(work_dir)
+        if session is None:
+            raise click.BadOptionUsage(
+                "--continue", "No previous session found for the working directory"
+            )
+        echo(f"✓ Continuing previous session: {session.id}")
+    else:
+        session = new_session(work_dir)
+        echo(f"✓ Created new session: {session.id}")
+    echo(f"✓ Session history file: {session.history_file}")
+
+    if input_format is not None and ui != "print":
+        raise click.BadOptionUsage(
+            "--input-format",
+            "Input format is only supported for print UI",
+        )
+    if output_format is not None and ui != "print":
+        raise click.BadOptionUsage(
+            "--output-format",
+            "Output format is only supported for print UI",
+        )
+
+    try:
+        mcp_configs = [json.loads(conf.read_text()) for conf in mcp_config_file]
+    except json.JSONDecodeError as e:
+        raise click.BadOptionUsage("--mcp-config-file", f"Invalid JSON: {e}") from e
+
+    try:
+        mcp_configs += [json.loads(conf) for conf in mcp_config]
+    except json.JSONDecodeError as e:
+        raise click.BadOptionUsage("--mcp-config", f"Invalid JSON: {e}") from e
+
+    while True:
+        try:
+            try:
+                config = load_config()
+            except ConfigError as e:
+                raise click.ClickException(f"Failed to load config: {e}") from e
+            echo(f"✓ Loaded config: {config}")
+
+            succeeded = asyncio.run(
+                kimi_run(
+                    config=config,
+                    model_name=model_name,
+                    work_dir=work_dir,
+                    session=session,
+                    command=command,
+                    agent_file=agent_file,
+                    verbose=verbose,
+                    ui=ui,
+                    input_format=input_format,
+                    output_format=output_format,
+                    mcp_configs=mcp_configs,
+                )
+            )
+            if not succeeded:
+                sys.exit(1)
+            break
+        except Reload:
+            continue
+
+
+async def kimi_run(
+    *,
+    config: Config,
+    model_name: str | None,
+    work_dir: Path,
+    session: Session,
+    command: str | None = None,
+    agent_file: Path = DEFAULT_AGENT_FILE,
+    verbose: bool = True,
+    ui: UIMode = "shell",
+    input_format: InputFormat | None = None,
+    output_format: OutputFormat | None = None,
+    mcp_configs: list[dict[str, Any]] | None = None,
+) -> bool:
+    """Run Kimi CLI."""
+    echo = click.echo if verbose else lambda *args, **kwargs: None
+
+    model: LLMModel | None = None
+    provider: LLMProvider | None = None
+
+    # try to use config file
+    if not model_name and config.default_model:
+        # no --model specified && default model is set in config
+        model = config.models[config.default_model]
+        provider = config.providers[model.provider]
+    if model_name and model_name in config.models:
+        # --model specified && model is set in config
+        model = config.models[model_name]
+        provider = config.providers[model.provider]
+
+    if not model:
+        model = LLMModel(provider="", model="", max_context_size=100_000)
+        provider = LLMProvider(type="kimi", base_url="", api_key=SecretStr(""))
+
+    # try overwrite with environment variables
+    assert provider is not None
+    assert model is not None
+    augment_provider_with_env_vars(provider, model)
+
+    if not provider.base_url or not model.model:
+        llm = None
+    else:
+        echo(f"✓ Using LLM provider: {provider}")
+        echo(f"✓ Using LLM model: {model}")
+        stream = ui != "print"  # use non-streaming mode only for print UI
+        llm = create_llm(provider, model, stream=stream)
+
+    # TODO: support Windows
+    ls = subprocess.run(["ls", "-la"], capture_output=True, text=True)
+    agents_md = load_agents_md(work_dir) or ""
+    if agents_md:
+        echo(f"✓ Loaded agents.md: {textwrap.shorten(agents_md, width=100)}")
+
+    agent_globals = AgentGlobals(
+        config=config,
+        llm=llm,
+        builtin_args=BuiltinSystemPromptArgs(
+            KIMI_NOW=datetime.now().astimezone().isoformat(),
+            KIMI_WORK_DIR=work_dir,
+            KIMI_WORK_DIR_LS=ls.stdout,
+            KIMI_AGENTS_MD=agents_md,
+        ),
+        denwa_renji=DenwaRenji(),
+        session=session,
+        approval=Approval(),
+    )
+    try:
+        agent = await load_agent_with_mcp(agent_file, agent_globals, mcp_configs or [])
+    except ValueError as e:
+        raise click.BadParameter(f"Failed to load agent: {e}") from e
+    echo(f"✓ Loaded agent: {agent.name}")
+    echo(f"✓ Loaded system prompt: {textwrap.shorten(agent.system_prompt, width=100)}")
+    echo(f"✓ Loaded tools: {[tool.name for tool in agent.toolset.tools]}")
+
+    if command is not None:
+        command = command.strip()
+        if not command:
+            raise click.BadParameter("Command cannot be empty")
+
+    context = Context(session.history_file)
+    restored = await context.restore()
+    if restored:
+        echo(f"✓ Restored history from {session.history_file}")
+
+    soul = KimiSoul(
+        agent,
+        agent_globals,
+        context=context,
+        loop_control=config.loop_control,
+    )
+
+    original_cwd = Path.cwd()
+    os.chdir(work_dir)
+
+    try:
+        if ui == "shell":
+            if command is None and not sys.stdin.isatty():
+                command = sys.stdin.read().strip()
+                echo(f"✓ Read command from stdin: {command}")
+
+            app = ShellApp(
+                soul,
+                welcome_info={
+                    "Directory": str(work_dir),
+                    "Session": session.id,
+                },
+            )
+            # to ignore possible warnings from dateparser
+            warnings.filterwarnings("ignore", category=DeprecationWarning)
+            with contextlib.redirect_stderr(StreamToLogger()):
+                return await app.run(command)
+        elif ui == "print":
+            app = PrintApp(soul, input_format or "text", output_format or "text")
+            return await app.run(command)
+        elif ui == "acp":
+            if command is not None:
+                logger.warning("ACP server ignores command argument")
+            app = ACPServer(soul)
+            return await app.run()
+        else:
+            raise click.BadParameter(f"Invalid UI mode: {ui}")
+    finally:
+        os.chdir(original_cwd)
+
+
+def main():
+    kimi()
+
+
+if __name__ == "__main__":
+    main()