unsloth/studio/backend/utils/coding_agents.py
Michael Han 0b81fb88ba
Studio: list VS Code and Pi as coding agents and reorder the agent picker (#13547)
* Studio: list VS Code and Pi as coding agents and reorder the agent picker

* Studio: monochrome Pi icon and a smaller VS Code icon in the agent picker

* Studio: smaller Pi, Mistral Vibe, OpenCode and VS Code marks, no scroll arrows in the agent picker

* Studio: show the subagent setup for Pi

* Studio: drop Mistral Vibe from the Agents description

* Studio: VS Code config note, agent names in settings search, Pi in every locale's subagent list

* Studio: show the VS Code note on the API tab too

* Studio: trim comments
2026-10-13 03:09:52 -07:00

126 lines
4.4 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-only
# Copyright 2026-present the Unsloth AI Inc. team. All rights reserved. See /studio/LICENSE.AGPL-3.0
"""Detect which `unsloth start <agent>` coding-agent CLIs are on PATH.
The web UI only ever shows the user the "claude" flavor of the `unsloth start`
command (see agent-command.ts), leaving anyone using Codex, OpenCode, and the
other supported agents to manually edit the copied command. This module gives
the frontend a way to ask which of those CLIs are actually installed so it can
default to one the user can run immediately.
"""
import os
import shutil
import subprocess
from typing import Optional
_DEEPSEEK_HARNESS_HELP_MARKER = "DeepSeek Harness"
_DEEPSEEK_HARNESS_FILE_MARKERS = (
b"deepseek harness",
b"@deepseek-ai/dsh",
b"@deepseek-ai+dsh",
)
# Keep in sync with the `unsloth start <agent>` subcommands defined in
# unsloth_cli/commands/start.py, in the order the Settings pickers list them. Each
# entry is the executable that subcommand needs on PATH (see _EXECUTABLES).
CODING_AGENTS: tuple[str, ...] = (
"claude",
"codex",
"vscode",
"dsh",
"opencode",
"hermes",
"openclaw",
"pi",
"vibe",
)
# `unsloth start vscode` edits VS Code's settings; `code` is the launcher an install puts on PATH.
_EXECUTABLES = {"vscode": "code"}
def is_deepseek_harness_executable(executable: str, *, allow_execution: bool = True) -> bool:
"""Return whether ``executable`` identifies itself as DeepSeek Harness."""
try:
with open(executable, "rb") as launcher:
contents = launcher.read(256 * 1024).lower()
except OSError:
contents = b""
if any(marker in contents for marker in _DEEPSEEK_HARNESS_FILE_MARKERS):
return True
if not allow_execution:
return False
try:
result = subprocess.run(
[executable, "--help"],
check = False,
capture_output = True,
text = True,
encoding = "utf-8",
errors = "replace",
timeout = 5,
)
except (OSError, subprocess.TimeoutExpired):
return False
output = (result.stdout or "") + (result.stderr or "")
return result.returncode == 0 and _DEEPSEEK_HARNESS_HELP_MARKER in output
def deepseek_harness_executables_on_path(path: Optional[str] = None) -> list[str]:
"""Return every distinct ``dsh`` executable in PATH order."""
if path is None:
path = os.environ.get("PATH")
if path is None:
path = os.defpath
executables = []
seen = set()
for directory in path.split(os.pathsep):
try:
executable = shutil.which("dsh", path = directory)
except OSError:
continue
if executable is None:
continue
key = os.path.normcase(os.path.abspath(executable))
if key in seen:
continue
seen.add(key)
executables.append(executable)
return executables
def _is_on_path(agent: str) -> bool:
# shutil.which returns None on a miss but PATH lookups can still raise, and this is advisory, so a lookup failure
# reads as "not installed" rather than breaking the endpoint.
try:
executable = shutil.which(_EXECUTABLES.get(agent, agent))
if executable is None:
return False
if agent == "dsh":
# Detection runs when the settings panel opens, so it must not execute an
# arbitrary same-named program. Official npm/pnpm launchers contain one of
# the package or product markers above; explicit launches may additionally
# use the bounded --help probe for custom wrappers.
if is_deepseek_harness_executable(executable, allow_execution = False):
return True
return any(
is_deepseek_harness_executable(candidate, allow_execution = False)
for candidate in deepseek_harness_executables_on_path()
if os.path.normcase(os.path.abspath(candidate))
!= os.path.normcase(os.path.abspath(executable))
)
return True
except OSError:
return False
def detect_installed_coding_agents() -> list[str]:
"""Return the subset of CODING_AGENTS whose CLI binary is on PATH.
Order follows CODING_AGENTS, not discovery order, so callers can treat the
first entry as the preferred default among the installed agents.
"""
return [agent for agent in CODING_AGENTS if _is_on_path(agent)]