-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathCopilotClientMode.java.html
More file actions
46 lines (42 loc) · 3.14 KB
/
Copy pathCopilotClientMode.java.html
File metadata and controls
46 lines (42 loc) · 3.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>CopilotClientMode.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">GitHub Copilot SDK :: Java</a> > <a href="index.source.html" class="el_package">com.github.copilot.rpc</a> > <span class="el_source">CopilotClientMode.java</span></div><h1>CopilotClientMode.java</h1><pre class="source lang-java linenums">/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
*--------------------------------------------------------------------------------------------*/
package com.github.copilot.rpc;
/**
* Selects the defaulting strategy used by
* {@link com.github.copilot.CopilotClient}.
*
* @since 1.3.0
*/
<span class="nc" id="L13">public enum CopilotClientMode {</span>
/**
* Disables optional features by default. The app must explicitly opt into
* anything it needs. Required for any scenario where CLI-like ambient behavior
* is unsafe (e.g., multi-user servers).
* <p>
* When this mode is selected:
* <ul>
* <li>The client constructor requires
* {@link CopilotClientOptions#getCopilotHome()} or
* {@link CopilotClientOptions#getCliUrl()} to be set.</li>
* <li>{@link SessionConfig#getAvailableTools()} must be supplied on every
* session — no tools are exposed by default.</li>
* <li>{@code session.create} always sets
* {@code toolFilterPrecedence: "excluded"} so the allowlist and denylist
* compose naturally.</li>
* <li>The SDK injects safe defaults for ambient session features (telemetry,
* custom instructions, plugins, environment context, etc.).</li>
* </ul>
*/
<span class="nc" id="L34"> EMPTY,</span>
/**
* Uses defaults equivalent to GitHub Copilot CLI. The default. Useful when
* building a coding agent that shares sessions with Copilot CLI.
* <p>
* <b>Do not use this mode for server-based multi-user applications</b> — the
* default coding agent has tools and capabilities that operate across sessions
* and can access the host OS environment.
*/
<span class="nc" id="L44"> COPILOT_CLI</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.14.202510111229</span></div></body></html>