Skip to content

Latest commit

 

History

History
476 lines (394 loc) · 31.1 KB

File metadata and controls

476 lines (394 loc) · 31.1 KB
title shortTitle intro versions category contentType
GitHub Copilot CLI command reference
CLI command reference
Find commands and keyboard shortcuts to help you use {% data variables.copilot.copilot_cli_short %} effectively.
feature
copilot
Author and optimize with Copilot
Build with Copilot CLI
reference

Command-line commands

Command Purpose
copilot Launch the interactive user interface.
copilot help [topic] Display help information. Help topics include: config, commands, environment, logging, and permissions.
copilot init Initialize {% data variables.product.prodname_copilot_short %} custom instructions for this repository.
copilot update Download and install the latest version.
copilot version Display version information and check for updates.
copilot login Authenticate with {% data variables.product.prodname_copilot_short %} via the OAuth device flow. Accepts --host HOST to specify the {% data variables.product.github %} host URL (default: https://github.com).
copilot logout Sign out of {% data variables.product.github %} and remove stored credentials.
copilot plugin Manage plugins and plugin marketplaces.

Global shortcuts in the interactive interface

Shortcut Purpose
@ FILENAME Include file contents in the context.
Ctrl+X then / After you have started typing a prompt, this allows you to run a slash command—for example, if you want to change the model without having to retype your prompt.
Esc Cancel the current operation.
! COMMAND Execute a command in your local shell, bypassing {% data variables.product.prodname_copilot_short %}.
Ctrl+C Cancel operation / clear input. Press twice to exit.
Ctrl+D Shutdown.
Ctrl+L Clear the screen.
Shift+Tab Cycle between standard, plan, and autopilot mode.

Timeline shortcuts in the interactive interface

Shortcut Purpose
ctrl+o While there is nothing in the prompt input, this expands recent items in {% data variables.product.prodname_copilot_short %}'s response timeline to show more details.
ctrl+e While there is nothing in the prompt input, this expands all items in {% data variables.product.prodname_copilot_short %}'s response timeline.
ctrl+t Expand/collapse display of reasoning in responses.

Navigation shortcuts in the interactive interface

Shortcut Purpose
Ctrl+A Move to beginning of the line (when typing).
Ctrl+B Move to the previous character.
Ctrl+E Move to end of the line (when typing).
Ctrl+F Move to the next character.
Ctrl+G Edit the prompt in an external editor.
Ctrl+H Delete the previous character.
Ctrl+K Delete from cursor to end of the line.
Ctrl+U Delete from cursor to beginning of the line.
Ctrl+W Delete the previous word.
Home Move to the start of the current line.
End Move to the end of the current line.
Ctrl+Home Move to the start of the text.
Ctrl+End Move to the end of the text.
Meta+/ Move the cursor by a word.
/ Navigate the command history.

Slash commands in the interactive interface

Command Purpose
/add-dir PATH Add a directory to the allowed list for file access.
/agent Browse and select from available agents (if any).
/allow-all, /yolo Enable all permissions (tools, paths, and URLs).
/clear, /new Clear the conversation history.
/compact Summarize the conversation history to reduce context window usage.
/context Show the context window token usage and visualization.
/cwd, /cd [PATH] Change the working directory or display the current directory.
/delegate [PROMPT] Delegate changes to a remote repository with an AI-generated pull request.
/diff Review the changes made in the current directory.
/exit, /quit Exit the CLI.
/experimental [on|off] Toggle or turn on/off experimental features.
/feedback Provide feedback about the CLI.
/fleet [PROMPT] Enable parallel subagent execution of parts of a task. See AUTOTITLE.
/help Show the help for interactive commands.
/ide Connect to an IDE workspace.
/init Initialize {% data variables.product.prodname_copilot_short %} custom instructions and agentic features for this repository.
/list-dirs Display all of the directories for which file access has been allowed.
/login Log in to {% data variables.product.prodname_copilot_short %}.
/logout Log out of {% data variables.product.prodname_copilot_short %}.
/lsp [show|test|reload|help] [SERVER-NAME] Manage the language server configuration.
/mcp [show|add|edit|delete|disable|enable] [SERVER-NAME] Manage the MCP server configuration.
/model, /models [MODEL] Select the AI model you want to use.
/plan [PROMPT] Create an implementation plan before coding.
/plugin [marketplace|install|uninstall|update|list] [ARGS...] Manage plugins and plugin marketplaces.
/rename NAME Rename the current session (alias for /session rename).
/reset-allowed-tools Reset the list of allowed tools.
/resume [SESSION-ID] Switch to a different session by choosing from a list (optionally specify a session ID).
/review [PROMPT] Run the code review agent to analyze changes.
/session [checkpoints [n]|files|plan|rename NAME] Show session information and a workspace summary. Use the subcommands for details.
/share [file|gist] [PATH] Share the session to a Markdown file or GitHub gist.
/skills [list|info|add|remove|reload] [ARGS...] Manage skills for enhanced capabilities.
/terminal-setup Configure the terminal for multiline input support (Shift+Enter and Ctrl+Enter).
/theme [show|set|list] [auto|THEME-ID] View or configure the terminal theme.
/usage Display session usage metrics and statistics.
/user [show|list|switch] Manage the current {% data variables.product.github %} user.

For a complete list of available slash commands enter /help in the CLI's interactive interface.

Command-line options

Option Purpose
--acp Start the Agent Client Protocol server.
--add-dir PATH Add a directory to the allowed list for file access (can be used multiple times).
--add-github-mcp-tool TOOL Add a tool to enable for the {% data variables.product.github %} MCP server, instead of the default CLI subset (can be used multiple times). Use * for all tools.
--add-github-mcp-toolset TOOLSET Add a toolset to enable for the {% data variables.product.github %} MCP server, instead of the default CLI subset (can be used multiple times). Use all for all toolsets.
--additional-mcp-config JSON Add an MCP server for this session only. The server configuration can be supplied as a JSON string or a file path (prefix with @). Augments the configuration from ~/.copilot/mcp-config.json. Overrides any installed MCP server configuration with the same name.
--agent AGENT Specify a {% data variables.copilot.copilot_custom_agent_short %} to use.
--allow-all Enable all permissions (equivalent to --allow-all-tools --allow-all-paths --allow-all-urls).
--allow-all-paths Disable file path verification and allow access to any path.
--allow-all-tools Allow all tools to run automatically without confirmation. Required when using the CLI programmatically (env: COPILOT_ALLOW_ALL).
--allow-all-urls Allow access to all URLs without confirmation.
--allow-tool [TOOLS...] Tools the CLI has permission to use. Will not prompt for permission.
--allow-url [URLS...] Allow access to specific URLs or domains.
--alt-screen [VALUE] Use the terminal alternate screen buffer (on or off).
--autopilot Enable autopilot continuation in prompt mode. See AUTOTITLE.
--available-tools [TOOLS...] Only these tools will be available to the model.
--banner Show the startup banner.
--bash-env [VALUE] Enable BASH_ENV support for bash shells (on or off).
--config-dir PATH Set the configuration directory (default: ~/.copilot).
--continue Resume the most recent session.
--deny-tool [TOOLS...] Tools the CLI does not have permission to use. Will not prompt for permission.
--deny-url [URLS...] Deny access to specific URLs or domains, takes precedence over --allow-url.
--disable-builtin-mcps Disable all built-in MCP servers (currently: github-mcp-server).
--disable-mcp-server SERVER-NAME Disable a specific MCP server (can be used multiple times).
--disable-parallel-tools-execution Disable parallel execution of tools (LLM can still make parallel tool calls, but they will be executed sequentially).
--disallow-temp-dir Prevent automatic access to the system temporary directory.
--enable-all-github-mcp-tools Enable all {% data variables.product.github %} MCP server tools, instead of the default CLI subset. Overrides the --add-github-mcp-toolset and --add-github-mcp-tool options.
--excluded-tools [TOOLS...] These tools will not be available to the model.
--experimental Enable experimental features (use --no-experimental to disable).
-h, --help Display help.
-i PROMPT, --interactive PROMPT Start an interactive session and automatically execute this prompt.
--log-dir DIRECTORY Set the log file directory (default: ~/.copilot/logs/).
--log-level LEVEL Set the log level (choices: none, error, warning, info, debug, all, default).
--max-autopilot-continues COUNT Maximum number of continuation messages in autopilot mode (default: unlimited). See AUTOTITLE.
--model MODEL Set the AI model you want to use.
--no-alt-screen Disable the terminal alternate screen buffer.
--no-ask-user Disable the ask_user tool (the agent works autonomously without asking questions).
--no-auto-update Disable downloading CLI updates automatically.
--no-bash-env Disable BASH_ENV support for bash shells.
--no-color Disable all color output.
--no-custom-instructions Disable loading of custom instructions from AGENTS.md and related files.
--no-experimental Disable experimental features.
-p PROMPT, --prompt PROMPT Execute a prompt programmatically (exits after completion).
--plain-diff Disable rich diff rendering (syntax highlighting via the diff tool specified by your git config).
--resume [SESSION-ID] Resume a previous interactive session by choosing from a list (optionally specify a session ID).
-s, --silent Output only the agent response (without usage statistics), useful for scripting with -p.
--screen-reader Enable screen reader optimizations.
--share [PATH] Share a session to a Markdown file after completion of a programmatic session (default path: ./copilot-session-<ID>.md).
--share-gist Share a session to a secret {% data variables.product.github %} gist after completion of a programmatic session.
--stream MODE Enable or disable streaming mode (mode choices: on or off).
-v, --version Show version information.
--yolo Enable all permissions (equivalent to --allow-all).

For a complete list of commands and options, run copilot help.

Tool permission patterns

The --allow-tool and --deny-tool options accept permission patterns in the format Kind(argument). The argument is optional—omitting it matches all tools of that kind.

Kind Description Example patterns
shell Shell command execution shell(git push), shell(git:*), shell
write File creation or modification write, write(src/*.ts)
read File or directory reads read, read(.env)
SERVER-NAME MCP server tool invocation MyMCP(create_issue), MyMCP
url URL access via web-fetch or shell url(github.com), url(https://*.api.com)
memory Storing facts to agent memory memory

For shell rules, the :* suffix matches the command stem followed by a space, preventing partial matches. For example, shell(git:*) matches git push and git pull but does not match gitea.

Deny rules always take precedence over allow rules, even when --allow-all is set.

# Allow all git commands except git push
copilot --allow-tool 'shell(git:*)' --deny-tool 'shell(git push)'

# Allow a specific MCP server tool
copilot --allow-tool 'MyMCP(create_issue)'

# Allow all tools from a server
copilot --allow-tool 'MyMCP'

Environment variables

Variable Description
COPILOT_MODEL Set the AI model.
COPILOT_ALLOW_ALL Set to true to allow all permissions automatically (equivalent to --allow-all).
COPILOT_AUTO_UPDATE Set to false to disable automatic updates.
COPILOT_CUSTOM_INSTRUCTIONS_DIRS Comma-separated list of additional directories for custom instructions.
COPILOT_SKILLS_DIRS Comma-separated list of additional directories for skills.
COPILOT_EDITOR Editor command for interactive editing (checked after $VISUAL and $EDITOR). Defaults to vi if none are set.
COPILOT_GITHUB_TOKEN Authentication token. Takes precedence over GH_TOKEN and GITHUB_TOKEN.
GH_TOKEN Authentication token. Takes precedence over GITHUB_TOKEN.
GITHUB_TOKEN Authentication token.
XDG_CONFIG_HOME Override the configuration directory. Default: $HOME/.copilot.
XDG_STATE_HOME Override the state directory. Default: $HOME/.copilot.
USE_BUILTIN_RIPGREP Set to false to use the system ripgrep instead of the bundled version.
PLAIN_DIFF Set to true to disable rich diff rendering.
COLORFGBG Fallback for dark/light terminal background detection.
COPILOT_CLI_ENABLED_FEATURE_FLAGS Comma-separated list of feature flags to enable (for example, "SOME_FEATURE,SOME_OTHER_FEATURE").

Configuration file settings

User settings are stored in ~/.copilot/config.json. Project-level settings can be placed in .copilot/settings.json (committed to the repository) or .copilot/settings.local.json (personal overrides—add to .gitignore). Settings cascade from user to project to local, with more specific scopes overriding more general ones. Command-line flags and environment variables always take the highest precedence.

Key Type Default Description
allowed_urls string[] [] URLs or domains allowed without prompting.
alt_screen boolean false Use the terminal alternate screen buffer.
auto_update boolean true Automatically download CLI updates.
banner "always" | "once" | "never" "once" Animated banner display frequency.
bash_env boolean false Enable BASH_ENV support for bash shells.
beep boolean true Play an audible beep when attention is required.
compact_paste boolean true Collapse large pastes into compact tokens.
custom_agents.default_local_only boolean false Only use local custom agents.
denied_urls string[] [] URLs or domains blocked (takes precedence over allowed_urls).
experimental boolean false Enable experimental features.
include_coauthor boolean true Add a Co-authored-by trailer to git commits made by the agent.
launch_messages string[] [] Custom messages shown randomly on startup.
log_level "none" | "error" | "warning" | "info" | "debug" | "all" | "default" "default" Logging verbosity.
model string varies AI model to use (see the /model command).
reasoning_effort "low" | "medium" | "high" | "xhigh" "medium" Reasoning effort level for extended thinking. Higher levels use more compute.
render_markdown boolean true Render Markdown in terminal output.
screen_reader boolean false Enable screen reader optimizations.
stream boolean true Enable streaming responses.
store_token_plaintext boolean false Store authentication tokens in plaintext in the config file when no system keychain is available.
streamer_mode boolean false Hide preview model names and quota details (useful when recording).
theme "auto" | "dark" | "light" "auto" Terminal color theme.
trusted_folders string[] [] Folders with pre-granted file access.
update_terminal_title boolean true Show the current intent in the terminal title.

Hooks reference

Hooks are external commands that execute at specific lifecycle points during a session, enabling custom automation, security controls, and integrations. Hook configuration files are loaded automatically from .github/hooks/*.json in your repository.

Hook configuration format

Hook configuration files use JSON format with version 1:

{
  "version": 1,
  "hooks": {
    "preToolUse": [
      {
        "type": "command",
        "bash": "your-bash-command",
        "powershell": "your-powershell-command",
        "cwd": "optional/working/directory",
        "env": { "VAR": "value" },
        "timeoutSec": 30
      }
    ]
  }
}
Field Type Required Description
type "command" Yes Must be "command".
bash string One of bash/powershell Shell command for Unix.
powershell string One of bash/powershell Shell command for Windows.
cwd string No Working directory for the command (relative to repository root or absolute).
env object No Environment variables to set (supports variable expansion).
timeoutSec number No Timeout in seconds. Default: 30.

Hook events

Event Fires when Output processed
sessionStart A new or resumed session begins. No
sessionEnd The session terminates. No
userPromptSubmitted The user submits a prompt. No
preToolUse Before each tool executes. Yes — can allow, deny, or modify.
postToolUse After each tool completes. No
agentStop The main agent finishes a turn. Yes — can block and force continuation.
subagentStop A subagent completes. Yes — can block and force continuation.
errorOccurred An error occurs during execution. No

preToolUse decision control

The preToolUse hook can control tool execution by writing a JSON object to stdout.

Field Values Description
permissionDecision "allow", "deny", "ask" Whether the tool executes. Empty output uses default behavior.
permissionDecisionReason string Reason shown to the agent. Required when decision is "deny".
modifiedArgs object Substitute tool arguments to use instead of the originals.

agentStop / subagentStop decision control

Field Values Description
decision "block", "allow" "block" forces another agent turn using reason as the prompt.
reason string Prompt for the next turn when decision is "block".

Tool names for hook matching

Tool name Description
bash Execute shell commands (Unix).
powershell Execute shell commands (Windows).
view Read file contents.
edit Modify file contents.
create Create new files.
glob Find files by pattern.
grep Search file contents.
web_fetch Fetch web pages.
task Run subagent tasks.

If multiple hooks of the same type are configured, they execute in order. For preToolUse, if any hook returns "deny", the tool is blocked. Hook failures (non-zero exit codes or timeouts) are logged and skipped—they never block agent execution.

MCP server configuration

MCP servers provide additional tools to the CLI agent. Configure persistent servers in ~/.copilot/mcp-config.json. Use --additional-mcp-config to add servers for a single session.

Transport types

Type Description Required fields
local / stdio Local process communicating via stdin/stdout. command, args
http Remote server using streamable HTTP transport. url
sse Remote server using Server-Sent Events transport. url

Local server configuration fields

Field Required Description
command Yes Command to start the server.
args Yes Command arguments (array).
tools Yes Tools to enable: ["*"] for all, or a list of specific tool names.
env No Environment variables. Supports $VAR, ${VAR}, and ${VAR:-default} expansion.
cwd No Working directory for the server.
timeout No Tool call timeout in milliseconds.
type No "local" or "stdio". Default: "local".

Remote server configuration fields

Field Required Description
type Yes "http" or "sse".
url Yes Server URL.
tools Yes Tools to enable.
headers No HTTP headers. Supports variable expansion.
oauthClientId No Static OAuth client ID (skips dynamic registration).
oauthPublicClient No Whether the OAuth client is public. Default: true.
timeout No Tool call timeout in milliseconds.

Filter mapping

Control how MCP tool output is processed using the filterMapping field in a server's configuration.

Mode Description
none No filtering.
markdown Format output as Markdown.
hidden_characters Remove hidden or control characters. Default.

Built-in MCP servers

The CLI includes built-in MCP servers that are available without additional setup.

Server Description
github-mcp-server {% data variables.product.github %} API integration: issues, pull requests, commits, code search, and {% data variables.product.prodname_actions %}.
playwright Browser automation: navigate, click, type, screenshot, and form handling.
fetch HTTP requests via the fetch tool.
time Time utilities: get_current_time and convert_time.

Use --disable-builtin-mcps to disable all built-in servers, or --disable-mcp-server SERVER-NAME to disable a specific one.

Skills reference

Skills are Markdown files that extend what the CLI can do. Each skill lives in its own directory containing a SKILL.md file. When invoked (via /SKILL-NAME or automatically by the agent), the skill's content is injected into the conversation.

Skill frontmatter fields

Field Type Required Description
name string Yes Unique identifier for the skill. Letters, numbers, and hyphens only. Max 64 characters.
description string Yes What the skill does and when to use it. Max 1024 characters.
allowed-tools string or string[] No Comma-separated list or YAML array of tools that are automatically allowed when the skill is active. Use "*" for all tools.
user-invocable boolean No Whether users can invoke the skill with /SKILL-NAME. Default: true.
disable-model-invocation boolean No Prevent the agent from automatically invoking this skill. Default: false.

Skill locations

Skills are loaded from these locations in priority order (first found wins for duplicate names).

Location Scope Description
.github/skills/ Project Project-specific skills.
.agents/skills/ Project Alternative project location.
.claude/skills/ Project Claude-compatible location.
Parent .github/skills/ Inherited Monorepo parent directory support.
~/.copilot/skills/ Personal Personal skills for all projects.
~/.claude/skills/ Personal Claude-compatible personal location.
Plugin directories Plugin Skills from installed plugins.
COPILOT_SKILLS_DIRS Custom Additional directories (comma-separated).

Commands (alternative skill format)

Commands are an alternative to skills stored as individual .md files in .claude/commands/. The command name is derived from the filename. Command files use a simplified format (no name field required) and support description, allowed-tools, and disable-model-invocation. Commands have lower priority than skills with the same name.

Custom agents reference

Custom agents are specialized AI agents defined in Markdown files. The filename (minus extension) becomes the agent ID. Use .agent.md or .md as the file extension.

Built-in agents

Agent Default model Description
code-review claude-sonnet-4.5 High signal-to-noise code review. Analyzes diffs for bugs, security issues, and logic errors.
explore claude-haiku-4.5 Fast codebase exploration. Searches files, reads code, and answers questions. Returns focused answers under 300 words. Safe to run in parallel.
general-purpose claude-sonnet-4.5 Full-capability agent for complex multi-step tasks. Runs in a separate context window.
research claude-sonnet-4.6 Deep research agent. Generates a report based on information in your codebase, in relevant repositories, and on the web.
task claude-haiku-4.5 Command execution (tests, builds, lints). Returns brief summary on success, full output on failure.

Custom agent frontmatter fields

Field Type Required Description
description string Yes Description shown in the agent list and task tool.
infer boolean No Allow auto-delegation by the main agent. Default: true.
mcp-servers object No MCP servers to connect. Uses the same schema as ~/.copilot/mcp-config.json.
model string No AI model for this agent. When unset, inherits the outer agent's model.
name string No Display name. Defaults to the filename.
tools string[] No Tools available to the agent. Default: ["*"] (all tools).

Custom agent locations

Scope Location
Project .github/agents/ or .claude/agents/
User ~/.copilot/agents/ or ~/.claude/agents/
Plugin <plugin>/agents/

Project-level agents take precedence over user-level agents. Plugin agents have the lowest priority.

Permission approval responses

When the CLI prompts for permission to execute an operation, you can respond with the following keys.

Key Effect
y Allow this specific request once.
n Deny this specific request once.
! Allow all similar requests for the rest of the session.
# Deny all similar requests for the rest of the session.
? Show detailed information about the request.

Session approvals reset when you run /clear or start a new session.

Flag Tier Description
AUTOPILOT_MODE experimental Autonomous operation mode.
BACKGROUND_AGENTS staff Run agents in the background.
QUEUED_COMMANDS staff Queue commands while the agent is running.
LSP_TOOLS on Language Server Protocol tools.
PLAN_COMMAND on Interactive planning mode.
AGENTIC_MEMORY on Persistent memory across sessions.
CUSTOM_AGENTS on Custom agent definitions.