@huggingface/tasks/dist/commonjs/agent-harnesses.d.ts

List of ML tasks for huggingface.co/tasks

/**
 * Registry of AI coding agents / harnesses known to use the Hugging Face Hub.
 *
 * To add your harness, append an entry below keyed by its `id` (the name used
 * when reporting Hub activity), and list the environment variable(s) that
 * identify it.
 */
export interface AgentHarness {
    /**
     * Human-readable name of the harness, e.g. displayed in a leaderboard.
     */
    prettyLabel: string;
    /**
     * URL to the harness's code repository (usually on GitHub).
     */
    repoUrl?: string;
    /**
     * URL to the harness's documentation or website.
     */
    docsUrl?: string;
    /**
     * Short description of the harness.
     */
    description?: string;
    /**
     * Environment variable(s) that identify this harness, mapped to the value
     * pattern they must match. Detection matches if ANY entry matches.
     *
     * The value pattern is one of:
     *  - `"*"`: the variable is set to any (non-empty) value
     *  - `"<value>"`: the variable equals this exact value
     *  - `"<prefix>*"`: the variable value starts with `<prefix>` (fuzzy match, resolved client-side)
     *
     * If not provided, the harness is detected through the standard AI_AGENT / AGENT variables only.
     */
    envVars?: Record<string, string>;
}
/**
 * Standard environment variables that any tool can set to identify itself.
 * When one of these is set, its value is used directly as the agent `id`
 * (matched against the keys of `AGENT_HARNESSES`); unrecognized values are
 * reported as `"unknown"`.
 */
export declare const STANDARD_AGENT_ENV_VARS: readonly ["AI_AGENT", "AGENT"];
/**
 * Add your new agent harness here.
 *
 * /!\ IMPORTANT
 *
 * Insertion order matters for detection priority: harnesses are checked from
 * top to bottom and the first match wins. In particular, `cowork` must stay
 * before `claude-code` so the more specific signal takes priority when both
 * `CLAUDE_CODE` and `CLAUDE_CODE_IS_COWORK` are set.
 */
export declare const AGENT_HARNESSES: {
    antigravity: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            ANTIGRAVITY_AGENT: string;
        };
    };
    "augment-cli": {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            AUGMENT_AGENT: string;
        };
    };
    cline: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            CLINE_ACTIVE: string;
        };
    };
    cowork: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            CLAUDE_CODE_IS_COWORK: string;
        };
    };
    "claude-code": {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            CLAUDECODE: string;
            CLAUDE_CODE: string;
        };
    };
    codex: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            CODEX_SANDBOX: string;
            CODEX_CI: string;
            CODEX_THREAD_ID: string;
        };
    };
    crush: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            CRUSH: string;
        };
    };
    "gemini-cli": {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            GEMINI_CLI: string;
        };
    };
    "github-copilot": {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            COPILOT_MODEL: string;
            COPILOT_ALLOW_ALL: string;
            COPILOT_GITHUB_TOKEN: string;
        };
    };
    goose: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            GOOSE_TERMINAL: string;
        };
    };
    "hermes-agent": {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            HERMES_SESSION_ID: string;
        };
    };
    hi: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
    };
    "kilo-code": {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            KILOCODE_FEATURE: string;
        };
    };
    kiro: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            AGENT_CONTEXT_OUT: string;
        };
    };
    openclaw: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            OPENCLAW_SHELL: string;
        };
    };
    opencode: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            OPENCODE_CLIENT: string;
        };
    };
    pi: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            PI_CODING_AGENT: string;
        };
    };
    replit: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            REPL_ID: string;
        };
    };
    trae: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            TRAE_AI_SHELL_ID: string;
        };
    };
    vtcode: {
        prettyLabel: string;
        repoUrl: string;
        description: string;
        envVars: {
            VTCODE: string;
        };
    };
    warp: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            TERM_PROGRAM: string;
        };
    };
    zed: {
        prettyLabel: string;
        repoUrl: string;
        docsUrl: string;
        description: string;
        envVars: {
            ZED_TERM: string;
        };
    };
    "cursor-cli": {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            CURSOR_AGENT: string;
        };
    };
    cursor: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
        envVars: {
            CURSOR_TRACE_ID: string;
        };
    };
    devin: {
        prettyLabel: string;
        docsUrl: string;
        description: string;
    };
};
export type AgentHarnessKey = keyof typeof AGENT_HARNESSES;
//# sourceMappingURL=agent-harnesses.d.ts.map