kimi-dev-workflow 0.1.0__py3-none-any.whl

kimi_dev_workflow/__init__.py

@@ -0,0 +1,3 @@
+"""Kimi Dev Workflow — 让 Kimi CLI 像 Cursor 一样理解你的代码库."""
+
+__version__ = "0.1.0"

kimi_dev_workflow/cli.py

@@ -0,0 +1,45 @@
+"""Kimi Dev Workflow — Unified CLI entry point."""
+
+from __future__ import annotations
+
+import click
+
+from .commands import doctor, index, init, memory, wiki
+from .config import __version__
+
+
+@click.group(
+    context_settings={"help_option_names": ["-h", "--help"]},
+    invoke_without_command=True,
+)
+@click.version_option(version=__version__, prog_name="kimi-dev")
+@click.pass_context
+def main(ctx: click.Context) -> None:
+    """Kimi Dev Workflow — 让 Kimi CLI 像 Cursor 一样理解你的代码库.
+
+    \b
+    快速开始:
+        cd your-project
+        kimi-dev init
+        kimi-dev index start
+    """
+    if ctx.invoked_subcommand is None:
+        click.echo(ctx.get_help())
+
+
+# Register commands
+main.add_command(init.init)
+main.add_command(index.index)
+main.add_command(wiki.wiki)
+main.add_command(memory.memory)
+main.add_command(doctor.doctor)
+
+# Add version as a top-level command too
+@main.command("version")
+def version_cmd() -> None:
+    """显示版本号."""
+    click.echo(f"kimi-dev {__version__}")
+
+
+if __name__ == "__main__":
+    main()

kimi_dev_workflow/commands/__init__.py

@@ -0,0 +1 @@
+"""Kimi Dev Workflow CLI commands."""

kimi_dev_workflow/commands/doctor.py

@@ -0,0 +1,119 @@
+"""kimi-dev doctor — Environment diagnostics."""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+from urllib.request import urlopen
+
+import click
+from rich.console import Console
+from rich.table import Table
+
+from ..config import OLLAMA_HOST
+
+console = Console()
+
+
+def _check_cmd(name: str) -> tuple[bool, str]:
+    """Check if a command exists and get its version."""
+    path = shutil.which(name)
+    if not path:
+        return False, "未安装"
+
+    version = "未知版本"
+    for flag in ["--version", "-v", "version"]:
+        try:
+            result = subprocess.run(
+                [name, flag],
+                capture_output=True,
+                text=True,
+                timeout=5,
+            )
+            if result.returncode == 0:
+                output = (result.stdout + result.stderr).strip().splitlines()[0]
+                version = output[:60]
+                break
+        except (subprocess.TimeoutExpired, Exception):
+            continue
+
+    return True, version
+
+
+def _check_ollama() -> tuple[bool, str]:
+    """Check if Ollama is running."""
+    try:
+        with urlopen(f"{OLLAMA_HOST}/api/tags", timeout=3) as resp:
+            if resp.status == 200:
+                return True, "运行中"
+    except Exception:
+        pass
+    return False, "未运行"
+
+
+@click.command()
+def doctor() -> None:
+    """诊断环境依赖状态.
+
+    检查 kimi、grepai、ollama 等必要依赖是否安装并正常运行。
+    """
+    console.print("")
+    console.print("[bold blue]🔍 环境诊断[/bold blue]")
+    console.print("")
+
+    table = Table(show_header=True, header_style="bold")
+    table.add_column("依赖")
+    table.add_column("状态")
+    table.add_column("版本/信息")
+
+    # Kimi CLI
+    ok, info = _check_cmd("kimi")
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("Kimi CLI", status, info)
+
+    # grepai
+    ok, info = _check_cmd("grepai")
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("grepai", status, info)
+
+    # Ollama service
+    ok, info = _check_ollama()
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("Ollama", status, info)
+
+    # ollama binary
+    ok, info = _check_cmd("ollama")
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("ollama CLI", status, info)
+
+    # git
+    ok, info = _check_cmd("git")
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("git", status, info)
+
+    # Python
+    ok, info = _check_cmd("python3")
+    if not ok:
+        ok, info = _check_cmd("python")
+    status = "[green]✓[/green]" if ok else "[red]✗[/red]"
+    table.add_row("Python", status, info)
+
+    console.print(table)
+    console.print("")
+
+    # Recommendations
+    has_issues = False
+    if not shutil.which("kimi"):
+        console.print("[yellow]💡 Kimi CLI 未安装:[/yellow] curl -fsSL https://cli.moonshot.cn/install.sh | sh")
+        has_issues = True
+    if not shutil.which("grepai"):
+        console.print("[yellow]💡 grepai 未安装:[/yellow] curl -fsSL https://raw.githubusercontent.com/yoanbernabeu/grepai/main/install.sh | INSTALL_DIR=$HOME/.local/bin sh")
+        has_issues = True
+    if not _check_ollama()[0]:
+        console.print("[yellow]💡 Ollama 未运行:[/yellow] https://ollama.com/download")
+        has_issues = True
+
+    if not has_issues:
+        console.print("[bold green]✅ 所有依赖已就绪！[/bold green]")
+
+    console.print("")

kimi_dev_workflow/commands/index.py

@@ -0,0 +1,84 @@
+"""kimi-dev index — Code index management commands."""
+
+from __future__ import annotations
+
+import subprocess
+
+import click
+from rich.console import Console
+
+from ..config import GREPAI_BIN
+from ..utils import find_script
+
+console = Console()
+
+
+def _run_kimi_index_cmd(args: list[str]) -> None:
+    """Run kimi-index script, finding it in various locations."""
+    script = find_script("kimi-index")
+    if script:
+        subprocess.run([script] + args, check=False)
+    else:
+        console.print("[red]✗[/red] kimi-index 未找到。请确保 kimi-dev-workflow 正确安装。")
+
+
+@click.group("index", help="代码索引管理")
+def index() -> None:
+    """管理本地代码语义索引."""
+    pass
+
+
+@index.command("start")
+def start() -> None:
+    """启动索引监听（后台运行）."""
+    console.print("[blue]ℹ[/blue] 启动代码索引...")
+    _run_kimi_index_cmd(["start"])
+
+
+@index.command("stop")
+def stop() -> None:
+    """停止索引监听."""
+    _run_kimi_index_cmd(["stop"])
+
+
+@index.command("status")
+def status() -> None:
+    """查看索引状态."""
+    _run_kimi_index_cmd(["status"])
+
+
+@index.command("search")
+@click.argument("query", nargs=-1, required=True)
+def search(query: tuple[str, ...]) -> None:
+    """语义搜索代码库.
+
+    \b
+    示例:
+        kimi-dev index search "用户认证逻辑"
+        kimi-dev index search "JWT token 刷新"
+    """
+    q = " ".join(query)
+    script = find_script("kimi-index")
+    if script:
+        subprocess.run([script, "search", q], check=False)
+    else:
+        # Fallback to direct grepai
+        try:
+            subprocess.run([GREPAI_BIN, "search", q], check=False)
+        except FileNotFoundError:
+            console.print("[red]✗[/red] grepai 未安装。")
+
+
+@index.command("reindex")
+def reindex() -> None:
+    """重置并重新索引."""
+    if not click.confirm("确定要重置并重新索引吗? 这将删除现有索引数据。", default=False):
+        console.print("[yellow]已取消[/yellow]")
+        return
+    _run_kimi_index_cmd(["reindex"])
+
+
+@index.command("logs")
+def logs() -> None:
+    """查看索引日志."""
+    _run_kimi_index_cmd(["logs"])

kimi_dev_workflow/commands/init.py

@@ -0,0 +1,242 @@
+"""kimi-dev init — Initialize a project with kimi-dev-workflow templates."""
+
+from __future__ import annotations
+
+import importlib.resources as pkg_resources
+import shutil
+import subprocess
+from pathlib import Path
+
+import click
+from rich.console import Console
+
+from ..config import (
+    AGENTS_FILE,
+    GREPAIIGNORE_FILE,
+    INDEX_DIR,
+    KIMI_DIR,
+    MEMORY_FILE,
+    PACKAGE_NAME,
+    WIKI_DIR,
+)
+from ..detector import detect_project, detect_project_name
+from ..renderer import write_agents
+
+console = Console()
+
+
+def _get_resource_path(module: str, filename: str) -> Path:
+    """Get a resource file path from the package."""
+    try:
+        return Path(str(pkg_resources.files(module).joinpath(filename)))
+    except (AttributeError, TypeError):
+        with pkg_resources.path(module, filename) as p:
+            return Path(str(p))
+
+
+def _copy_template(src_module: str, src_name: str, dst: Path) -> None:
+    """Copy a template file from package resources to destination."""
+    src = _get_resource_path(src_module, src_name)
+    dst.parent.mkdir(parents=True, exist_ok=True)
+    shutil.copy2(src, dst)
+
+
+def _copy_directory(src_module: str, dst: Path) -> None:
+    """Copy all files from a package resource directory."""
+    try:
+        files = pkg_resources.files(src_module)
+        for item in files.iterdir():
+            if item.is_file():
+                dst.parent.mkdir(parents=True, exist_ok=True)
+                shutil.copy2(str(item), dst.parent / item.name)
+            elif item.is_dir():
+                sub_dst = dst / item.name
+                sub_dst.mkdir(parents=True, exist_ok=True)
+                _copy_directory(f"{src_module}.{item.name}", sub_dst)
+    except (AttributeError, TypeError):
+        # Fallback: try to use path directly
+        with pkg_resources.path(src_module, "") as p:
+            src_path = Path(str(p))
+            if src_path.exists():
+                for item in src_path.iterdir():
+                    if item.is_file():
+                        dst.parent.mkdir(parents=True, exist_ok=True)
+                        shutil.copy2(item, dst.parent / item.name)
+                    elif item.is_dir() and not item.name.startswith("__"):
+                        sub_dst = dst / item.name
+                        shutil.copytree(item, sub_dst, dirs_exist_ok=True)
+
+
+@click.command()
+@click.option(
+    "--wiki-url",
+    help="从远程克隆 Wiki 仓库地址",
+)
+@click.option(
+    "--project-type",
+    type=click.Choice(["react", "vue", "go", "python", "rust", "node", "unknown"]),
+    help="强制指定项目类型（自动检测失败时使用）",
+)
+@click.option(
+    "--yes / -y",
+    "non_interactive",
+    default=False,
+    help="跳过交互确认，自动填充默认值",
+)
+@click.option(
+    "--no-wiki",
+    is_flag=True,
+    default=False,
+    help="不初始化 Wiki 目录",
+)
+@click.pass_context
+def init(
+    ctx: click.Context,
+    wiki_url: str | None,
+    project_type: str | None,
+    non_interactive: bool,
+    no_wiki: bool,
+) -> None:
+    """初始化当前项目，自动复制模板并配置环境.
+
+    \b
+    示例:
+        kimi-dev init
+        kimi-dev init --wiki-url https://github.com/user/repo.wiki.git
+        kimi-dev init --yes
+    """
+    cwd = Path.cwd()
+
+    console.print("")
+    console.print("[bold blue]🚀 Kimi Dev Workflow 项目初始化[/bold blue]")
+    console.print("")
+
+    # 1. Detect project type
+    info = detect_project(cwd)
+    if project_type:
+        # Override if explicitly specified
+        from ..detector import ProjectInfo
+        info = ProjectInfo(project_type, info.framework, info.language, info.build_tool)
+
+    project_name = detect_project_name(cwd)
+
+    type_display = f"{info.framework} + {info.language}" if info.framework != info.language else info.framework
+    console.print(f"[blue]ℹ[/blue] 检测到项目类型: [bold]{type_display}[/bold]")
+    console.print(f"[blue]ℹ[/blue] 项目名称: [bold]{project_name}[/bold]")
+    console.print("")
+
+    if not non_interactive:
+        if not click.confirm("是否继续初始化?", default=True):
+            console.print("[yellow]已取消[/yellow]")
+            return
+
+    # 2. Generate AGENTS.md
+    agents_path = cwd / AGENTS_FILE
+    if agents_path.exists():
+        backup = agents_path.with_suffix(".md.backup")
+        shutil.copy2(agents_path, backup)
+        console.print(f"[yellow]⚠[/yellow] AGENTS.md 已存在，已备份到 {backup.name}")
+
+    write_agents(cwd, info, project_name)
+    console.print(f"[green]✓[/green] 已生成 {AGENTS_FILE}")
+
+    if not non_interactive:
+        console.print("[yellow]⚠[/yellow] 请检查 AGENTS.md 中的内容并根据项目实际情况修改")
+
+    # 3. Copy .kimi/ directory
+    kimi_dst = cwd / KIMI_DIR
+    kimi_src_module = f"{PACKAGE_NAME}.templates.kimi_dir"
+
+    # Copy memory.md.template
+    memory_template = _get_resource_path(kimi_src_module, "memory.md.template")
+    memory_dst = cwd / MEMORY_FILE
+    memory_dst.parent.mkdir(parents=True, exist_ok=True)
+    shutil.copy2(memory_template, memory_dst)
+    console.print(f"[green]✓[/green] 已创建 {MEMORY_FILE}")
+
+    # Copy prompts
+    prompts_src = f"{kimi_src_module}.prompts"
+    prompts_dst = cwd / KIMI_DIR / "prompts"
+    try:
+        pkg = pkg_resources.files(prompts_src)
+        prompts_dst.mkdir(parents=True, exist_ok=True)
+        for item in pkg.iterdir():
+            if item.is_file() and item.name.endswith(".md"):
+                shutil.copy2(str(item), prompts_dst / item.name)
+    except (AttributeError, TypeError):
+        with pkg_resources.path(prompts_src, "") as p:
+            src_path = Path(str(p))
+            if src_path.exists():
+                prompts_dst.mkdir(parents=True, exist_ok=True)
+                for f in src_path.glob("*.md"):
+                    shutil.copy2(f, prompts_dst / f.name)
+
+    # Copy .kimi/README.md
+    readme_src = _get_resource_path(kimi_src_module, "README.md")
+    readme_dst = cwd / KIMI_DIR / "README.md"
+    shutil.copy2(readme_src, readme_dst)
+    console.print(f"[green]✓[/green] 已复制 prompt 模板到 {KIMI_DIR}/prompts/")
+
+    # 4. Copy .grepaiignore
+    grepaiignore_src = _get_resource_path(f"{PACKAGE_NAME}.templates", GREPAIIGNORE_FILE + ".template")
+    grepaiignore_dst = cwd / GREPAIIGNORE_FILE
+    shutil.copy2(grepaiignore_src, grepaiignore_dst)
+    console.print(f"[green]✓[/green] 已创建 {GREPAIIGNORE_FILE}")
+
+    # 5. Initialize wiki
+    if not no_wiki:
+        wiki_path = cwd / WIKI_DIR
+        if not wiki_path.exists():
+            wiki_path.mkdir(parents=True, exist_ok=True)
+            # Create example pages
+            (wiki_path / "01-getting-started.md").write_text(
+                "# 项目入门指南\n\n## 环境搭建\n\n## 快速开始\n\n## 常用命令\n",
+                encoding="utf-8",
+            )
+            (wiki_path / "02-architecture.md").write_text(
+                "# 架构说明\n\n## 系统架构图\n\n## 模块划分\n\n## 技术选型理由\n",
+                encoding="utf-8",
+            )
+            console.print(f"[green]✓[/green] 已创建 {WIKI_DIR}/ 目录及示例页面")
+
+        if wiki_url:
+            console.print(f"[blue]ℹ[/blue] 正在克隆远程 Wiki: {wiki_url}")
+            try:
+                if wiki_path.exists() and any(wiki_path.iterdir()):
+                    backup = cwd / f"{WIKI_DIR}.backup"
+                    shutil.move(str(wiki_path), str(backup))
+                    console.print(f"[yellow]⚠[/yellow] 已备份旧 wiki 到 {backup.name}")
+                subprocess.run(["git", "clone", wiki_url, str(wiki_path)], check=True, capture_output=True)
+                (wiki_path / ".wiki-origin").write_text(wiki_url + "\n", encoding="utf-8")
+                console.print(f"[green]✓[/green] Wiki 克隆成功")
+            except subprocess.CalledProcessError:
+                console.print(f"[red]✗[/red] Wiki 克隆失败，请检查仓库地址")
+
+    # 6. Initialize grepai
+    if not (cwd / INDEX_DIR).exists():
+        try:
+            result = subprocess.run(
+                ["grepai", "init"],
+                capture_output=True,
+                text=True,
+                cwd=cwd,
+            )
+            if result.returncode == 0:
+                console.print(f"[green]✓[/green] 已初始化 {INDEX_DIR}/")
+            else:
+                console.print(f"[yellow]⚠[/yellow] grepai init 输出: {result.stderr.strip() or result.stdout.strip()}")
+        except FileNotFoundError:
+            console.print(f"[yellow]⚠[/yellow] grepai 未安装，跳过索引初始化")
+            console.print("  安装: curl -fsSL https://raw.githubusercontent.com/yoanbernabeu/grepai/main/install.sh | INSTALL_DIR=$HOME/.local/bin sh")
+    else:
+        console.print(f"[blue]ℹ[/blue] {INDEX_DIR}/ 已存在，跳过初始化")
+
+    # 7. Summary
+    console.print("")
+    console.print("[bold green]✅ 初始化完成！[/bold green]")
+    console.print("")
+    console.print("[bold]下一步:[/bold]")
+    console.print("  1. 编辑 AGENTS.md 完善项目信息")
+    console.print("  2. 运行 [bold]kimi-dev index start[/bold] 启动索引")
+    console.print("  3. 运行 [bold]kimi[/bold] 开始开发")
+    console.print("")

kimi_dev_workflow/commands/memory.py

@@ -0,0 +1,47 @@
+"""kimi-dev memory — Agent memory commands."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+from rich.console import Console
+
+from ..config import MEMORY_FILE
+
+console = Console()
+
+
+@click.group("memory", help="Agent 记忆管理")
+def memory() -> None:
+    """查看和管理 Agent 记忆文件."""
+    pass
+
+
+@memory.command("show")
+def show() -> None:
+    """查看记忆文件内容."""
+    path = Path.cwd() / MEMORY_FILE
+    if not path.exists():
+        console.print(f"[yellow]⚠[/yellow] 记忆文件不存在: {MEMORY_FILE}")
+        console.print("  运行 [bold]kimi-dev init[/bold] 创建")
+        return
+
+    content = path.read_text(encoding="utf-8")
+    console.print(f"[bold blue]{MEMORY_FILE}[/bold blue]")
+    console.print("")
+    console.print(content)
+
+
+@memory.command("edit")
+def edit() -> None:
+    """用默认编辑器打开记忆文件."""
+    path = Path.cwd() / MEMORY_FILE
+    if not path.exists():
+        console.print(f"[yellow]⚠[/yellow] 记忆文件不存在: {MEMORY_FILE}")
+        return
+
+    import os
+
+    editor = os.environ.get("EDITOR", "vim")
+    click.launch(str(path), wait=True, locate=False)

kimi_dev_workflow/commands/wiki.py

@@ -0,0 +1,75 @@
+"""kimi-dev wiki — Repo Wiki management commands."""
+
+from __future__ import annotations
+
+import subprocess
+
+import click
+from rich.console import Console
+
+from ..utils import find_script
+
+console = Console()
+
+
+def _run_kimi_wiki_cmd(args: list[str]) -> None:
+    """Run kimi-wiki script, finding it in various locations."""
+    script = find_script("kimi-wiki")
+    if script:
+        subprocess.run([script] + args, check=False)
+    else:
+        console.print("[red]✗[/red] kimi-wiki 未找到。请确保 kimi-dev-workflow 正确安装。")
+
+
+@click.group("wiki", help="Repo Wiki 管理")
+def wiki() -> None:
+    """管理项目 Wiki 知识库."""
+    pass
+
+
+@wiki.command("init")
+@click.argument("url", required=False)
+def wiki_init(url: str | None) -> None:
+    """初始化 Wiki（本地或从远程克隆）.
+
+    \b
+    示例:
+        kimi-dev wiki init
+        kimi-dev wiki init https://github.com/user/repo.wiki.git
+    """
+    args = ["init"]
+    if url:
+        args.append(url)
+    _run_kimi_wiki_cmd(args)
+
+
+@wiki.command("sync")
+def wiki_sync() -> None:
+    """同步远程 Wiki 更新."""
+    _run_kimi_wiki_cmd(["sync"])
+
+
+@wiki.command("list")
+def wiki_list() -> None:
+    """列出所有 Wiki 页面."""
+    _run_kimi_wiki_cmd(["list"])
+
+
+@wiki.command("search")
+@click.argument("query", nargs=-1, required=True)
+def wiki_search(query: tuple[str, ...]) -> None:
+    """语义搜索 Wiki 内容.
+
+    \b
+    示例:
+        kimi-dev wiki search "订单状态机"
+        kimi-dev wiki search "API 约定"
+    """
+    q = " ".join(query)
+    _run_kimi_wiki_cmd(["search", q])
+
+
+@wiki.command("status")
+def wiki_status() -> None:
+    """查看 Wiki 状态."""
+    _run_kimi_wiki_cmd(["status"])

kimi_dev_workflow/config.py

@@ -0,0 +1,52 @@
+"""Configuration constants for kimi-dev-workflow."""
+
+import importlib.resources as pkg_resources
+from pathlib import Path
+
+__version__ = "0.1.0"
+
+PACKAGE_NAME = "kimi_dev_workflow"
+
+# Template paths (using importlib.resources for package-relative access)
+TEMPLATES_MODULE = f"{PACKAGE_NAME}.templates"
+KIMI_TEMPLATES_MODULE = f"{PACKAGE_NAME}.templates.kimi"
+
+# Project-level paths
+INDEX_DIR = ".grepai"
+WIKI_DIR = "wiki"
+MEMORY_FILE = ".kimi/memory.md"
+AGENTS_FILE = "AGENTS.md"
+GREPAIIGNORE_FILE = ".grepaiignore"
+KIMI_DIR = ".kimi"
+
+# External dependencies
+OLLAMA_HOST = "http://localhost:11434"
+GREPAI_BIN = "grepai"
+
+# Supported project types
+PROJECT_TYPES = ["react", "vue", "go", "python", "rust", "node", "unknown"]
+
+# AGENTS.md template placeholders
+AGENTS_PLACEHOLDERS = [
+    "{项目名}",
+    "{React/Vue/Svelte}",
+    "{版本}",
+    "{TypeScript/JavaScript}",
+    "{Vite/Webpack/Rollup}",
+    "{Zustand/Redux/Pinia}",
+    "{React Router/Vue Router/TanStack Router}",
+    "{Tailwind/Styled Components/SCSS/Less}",
+    "{Axios/Fetch/TanStack Query}",
+    "{Zod/Yup/Joi}",
+    "{react-hook-form/VeeValidate}",
+    "{store}",
+    "{Context/useState}",
+    "{ErrorClass}",
+    "{校验库}",
+    "{路由文件路径}",
+    "{store 目录路径}",
+    "{API 封装路径}",
+    "{认证相关文件}",
+    "{布局组件路径}",
+    "{路由文件}",
+]