detect_agent 0.1.0__py3-none-any.whl

detect_agent/__init__.py

@@ -0,0 +1,121 @@
+import os
+from pathlib import Path
+from typing import Literal, TypedDict, Union
+
+DEVIN_LOCAL_PATH = "/opt/.devin"
+
+CURSOR: Literal["cursor"] = "cursor"
+CURSOR_CLI: Literal["cursor-cli"] = "cursor-cli"
+CLAUDE: Literal["claude"] = "claude"
+COWORK: Literal["cowork"] = "cowork"
+DEVIN: Literal["devin"] = "devin"
+REPLIT: Literal["replit"] = "replit"
+GEMINI: Literal["gemini"] = "gemini"
+CODEX: Literal["codex"] = "codex"
+ANTIGRAVITY: Literal["antigravity"] = "antigravity"
+AUGMENT_CLI: Literal["augment-cli"] = "augment-cli"
+OPENCODE: Literal["opencode"] = "opencode"
+GITHUB_COPILOT: Literal["github-copilot"] = "github-copilot"
+GITHUB_COPILOT_CLI: Literal["github-copilot-cli"] = "github-copilot-cli"
+
+KnownAgentNames = Literal[
+    "cursor",
+    "cursor-cli",
+    "claude",
+    "cowork",
+    "devin",
+    "replit",
+    "gemini",
+    "codex",
+    "antigravity",
+    "augment-cli",
+    "opencode",
+    "github-copilot",
+]
+
+
+class KnownAgentDetails(TypedDict):
+    name: KnownAgentNames
+
+
+class AgentResultAgent(TypedDict):
+    is_agent: Literal[True]
+    agent: KnownAgentDetails
+
+
+class AgentResultNone(TypedDict):
+    is_agent: Literal[False]
+    agent: None
+
+
+AgentResult = Union[AgentResultAgent, AgentResultNone]
+
+KNOWN_AGENTS = {
+    "CURSOR": CURSOR,
+    "CURSOR_CLI": CURSOR_CLI,
+    "CLAUDE": CLAUDE,
+    "COWORK": COWORK,
+    "DEVIN": DEVIN,
+    "REPLIT": REPLIT,
+    "GEMINI": GEMINI,
+    "CODEX": CODEX,
+    "ANTIGRAVITY": ANTIGRAVITY,
+    "AUGMENT_CLI": AUGMENT_CLI,
+    "OPENCODE": OPENCODE,
+    "GITHUB_COPILOT": GITHUB_COPILOT,
+}
+
+
+def determine_agent() -> AgentResult:
+    ai_agent = os.environ.get("AI_AGENT")
+    if ai_agent:
+        name = ai_agent.strip()
+        if name:
+            if name in (GITHUB_COPILOT, GITHUB_COPILOT_CLI):
+                return {"is_agent": True, "agent": {"name": GITHUB_COPILOT}}
+            return {"is_agent": True, "agent": {"name": name}}  # type: ignore[return-value]
+
+    if os.environ.get("CURSOR_TRACE_ID"):
+        return {"is_agent": True, "agent": {"name": CURSOR}}
+
+    if os.environ.get("CURSOR_AGENT"):
+        return {"is_agent": True, "agent": {"name": CURSOR_CLI}}
+
+    if os.environ.get("GEMINI_CLI"):
+        return {"is_agent": True, "agent": {"name": GEMINI}}
+
+    if (
+        os.environ.get("CODEX_SANDBOX")
+        or os.environ.get("CODEX_CI")
+        or os.environ.get("CODEX_THREAD_ID")
+    ):
+        return {"is_agent": True, "agent": {"name": CODEX}}
+
+    if os.environ.get("ANTIGRAVITY_AGENT"):
+        return {"is_agent": True, "agent": {"name": ANTIGRAVITY}}
+
+    if os.environ.get("AUGMENT_AGENT"):
+        return {"is_agent": True, "agent": {"name": AUGMENT_CLI}}
+
+    if os.environ.get("OPENCODE_CLIENT"):
+        return {"is_agent": True, "agent": {"name": OPENCODE}}
+
+    if os.environ.get("CLAUDECODE") or os.environ.get("CLAUDE_CODE"):
+        if os.environ.get("CLAUDE_CODE_IS_COWORK"):
+            return {"is_agent": True, "agent": {"name": COWORK}}
+        return {"is_agent": True, "agent": {"name": CLAUDE}}
+
+    if os.environ.get("REPL_ID"):
+        return {"is_agent": True, "agent": {"name": REPLIT}}
+
+    if (
+        os.environ.get("COPILOT_MODEL")
+        or os.environ.get("COPILOT_ALLOW_ALL")
+        or os.environ.get("COPILOT_GITHUB_TOKEN")
+    ):
+        return {"is_agent": True, "agent": {"name": GITHUB_COPILOT}}
+
+    if Path(DEVIN_LOCAL_PATH).exists():
+        return {"is_agent": True, "agent": {"name": DEVIN}}
+
+    return {"is_agent": False, "agent": None}

detect_agent-0.1.0.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: detect_agent
+Version: 0.1.0
+Summary: Detect if code is running in an AI agent or automated development environment
+Project-URL: Homepage, https://github.com/togethercomputer/detect_agent
+Project-URL: Repository, https://github.com/togethercomputer/detect_agent
+Project-URL: Changelog, https://github.com/togethercomputer/detect_agent/blob/main/CHANGELOG.md
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# detect_agent
+
+> This is a Python Port of Vercels NPM package
+
+A lightweight utility for detecting if code is being executed by an AI agent or automated development environment.
+
+## Installation
+
+```bash
+uv add detect_agent
+```
+
+## Usage
+
+```python
+from detect_agent import determine_agent
+
+result = determine_agent()
+
+if result["is_agent"]:
+  print(f"Running in {result["agent"]["name"]} environment");
+```
+
+## Supported Agents
+
+This package can detect the following AI agents and development environments:
+
+- **Custom agents** via `AI_AGENT` environment variable
+- **Cursor** (cursor editor and cursor-cli)
+- **Claude Code** (Anthropic's Claude)
+- **Devin** (Cognition Labs)
+- **Gemini CLI** (Google)
+- **Codex** (OpenAI)
+- **Antigravity** (Google DeepMind)
+- **GitHub Copilot** (via `AI_AGENT=github-copilot|github-copilot-cli`, `COPILOT_MODEL`, `COPILOT_ALLOW_ALL`, or `COPILOT_GITHUB_TOKEN`)
+- **Replit** (online IDE)
+
+## The AI_AGENT Standard
+
+We're promoting `AI_AGENT` as a universal environment variable standard for AI development tools. This allows any tool or library to easily detect when it's running in an AI-driven environment.
+
+### For AI Tool Developers
+
+Set the `AI_AGENT` environment variable to identify your tool:
+
+```bash
+export AI_AGENT="your-tool-name"
+# or
+AI_AGENT="your-tool-name" your-command
+```
+
+### Recommended Naming Convention
+
+- Use lowercase with hyphens for multi-word names
+- Include version information if needed, separated by an `@` symbol
+- Examples: `claude-code`, `cursor-cli`, `devin@1`, `custom-agent@2.0`
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+# Lint and format check (CI)
+uv run ruff check . && uv run ruff format --check .
+# Fix and format
+uv run ruff check . --fix && uv run ruff format .
+```
+
+## Use Cases
+
+### Adaptive Behavior
+
+```python
+from detect_agent import determine_agent
+import os
+
+def setup_environment():
+  result = determine_agent()
+
+  if (result["is_agent"]) {
+    # Running in AI environment - adjust behavior
+    os.environ.setdefault("TOGETHER_LOG", "debug")
+    print(f"🤖 Detected AI agent: {result["agent"]["name"]}");
+```
+
+### Telemetry and Analytics
+
+```python
+from detect_agent import determine_agent
+
+def track_usage(event: string):
+  result = determine_agent();
+
+  analytics.track(event, {
+    "agent": result["agent"]["name"] if result["is_agent"] else "human",
+  })
+```
+### Adding New Agent Support
+
+To add support for a new AI agent:
+
+1. Add detection logic to `main.py`
+2. Add comprehensive test cases in `test.py`
+3. Update this README with the new agent information
+4. Follow the existing priority order pattern

detect_agent-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+detect_agent/__init__.py,sha256=jFCeNQyMjXSqwYRbQx3-IpeV1aKTX72pwjM_Tcy3TpM,3469
+detect_agent/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+detect_agent-0.1.0.dist-info/METADATA,sha256=ZIF5W8J0e-slmiQuWOb3ndXGiaY2DbWysxf8Grv3bf8,3170
+detect_agent-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+detect_agent-0.1.0.dist-info/RECORD,,

detect_agent-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any