You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ By default, the CLI stores your OAuth token in your operating system's keychain
67
67
| Windows | Credential Manager |
68
68
| Linux | libsecret (GNOME Keyring, KWallet) |
69
69
70
-
If the system keychain is unavailable—for example, on a headless Linux server without `libsecret` installed—the CLI prompts you to store the token in a plaintext configuration file at `~/.copilot/settings.json`.
70
+
If the system keychain is unavailable—for example, on a headless Linux server without `libsecret` installed—the CLI prompts you to store the token in a plaintext configuration file at `~/.copilot/config.json`.
71
71
72
72
When you run a command, {% data variables.copilot.copilot_cli_short %} checks for credentials in the following order:
73
73
@@ -176,8 +176,8 @@ If you have {% data variables.product.prodname_cli %} installed and authenticate
176
176
177
177
## Switching between accounts
178
178
179
-
{% data variables.copilot.copilot_cli_short %} supports multiple accounts. You can list available accounts and switch between them from within the CLI.
180
-
To list available accounts, run `/user list` from the {% data variables.copilot.copilot_cli_short %} prompt.
179
+
{% data variables.copilot.copilot_cli_short %} supports multiple accounts. You can list available accounts and switch between them from within the CLI.
180
+
To list available accounts, run `/user list` from the {% data variables.copilot.copilot_cli_short %} prompt.
181
181
To switch to a different account, type`/user switch` on the prompt.
182
182
183
183
To add another account, run `copilot login` from a new terminal session, or run the login command from within the CLI and authorize with the other account.
@@ -190,7 +190,7 @@ To revoke the OAuth app authorization on {% data variables.product.github %} and
190
190
191
191
1. Navigate to **Settings**>**Applications**>**Authorized OAuth Apps**.
192
192
1. Navigate to your settings page:
193
-
1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile picture.
193
+
1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile picture.
194
194
1. Click **Settings**.
195
195
1. In the left sidebar, click **Applications**.
196
196
1. Under **Authorized OAuth Apps**, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} next to **GitHub CLI** to expand the menu and select**Revoke**.
Copy file name to clipboardExpand all lines: content/copilot/how-tos/copilot-cli/set-up-copilot-cli/configure-copilot-cli.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,16 +39,16 @@ If you choose to trust the directory for future sessions, the trusted directory
39
39
40
40
### Editing trusted directories
41
41
42
-
You can edit the list of permanently trusted directories.
42
+
You can edit the list of permanently trusted directories. Trusted directories are stored in the automatically managed `config.json` file.
43
43
44
-
1. Open the CLI’s `settings.json` file. By default, it’s stored in a `.copilot` folder under your home directory:
44
+
1. Open the CLI's `config.json` file. By default, it's stored in a `.copilot` folder under your home directory:
45
45
46
-
***macOS/Linux**: `~/.copilot/settings.json`
47
-
***Windows**: `$HOME\.copilot\settings.json`
46
+
***macOS/Linux**: `~/.copilot/config.json`
47
+
***Windows**: `$HOME\.copilot\config.json`
48
48
49
-
You can change the config location by setting the `COPILOT_HOME` environment variable.
49
+
You can change the config location by setting the `COPILOT_HOME` environment variable. This would change `~/.copilot/` and `$HOME\.copilot\` in the above paths.
50
50
51
-
1. Edit the contents of the `trusted_folders` array.
51
+
1. Edit the contents of the `trustedFolders` array.
Copy file name to clipboardExpand all lines: content/copilot/reference/copilot-cli-reference/cli-command-reference.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -363,7 +363,7 @@ copilot --allow-tool='MyMCP'
363
363
For detailed information about configuration file settings—including the full list of user settings, repository settings, local settings, and how they cascade—see [AUTOTITLE](/copilot/reference/copilot-cli-reference/cli-config-dir-reference#configuration-file-settings).
364
364
365
365
> [!NOTE]
366
-
> User settings were previously stored in `~/.copilot/config.json`. Existing settings in that location are automatically migrated to `~/.copilot/settings.json` on startup.
366
+
> User settings were previously stored in `~/.copilot/config.json`. Existing user-editable settings in that location are automatically migrated to `~/.copilot/settings.json` on startup.
367
367
368
368
## Project initialization for {% data variables.product.prodname_copilot_short %}
|`plugin-data/`| Directory | Persistent data for installed plugins |
40
-
|`ide/`| Directory | IDE integration state |
40
+
|`settings.json`| File | Your personal configuration settings |
41
+
|`skills/`| Directory | Personal custom skill definitions |
41
42
42
43
> [!NOTE]
43
44
> Not all of these items appear immediately. Some are created on demand the first time you use a particular feature—for example, `installed-plugins/` appears only after you install your first plugin.
@@ -51,7 +52,7 @@ The following files are designed to be edited by you directly, or managed throug
51
52
This is the primary configuration file for {% data variables.copilot.copilot_cli_short %}. You can edit it directly in a text editor, or use interactive commands like `/model` and `/theme` to change specific values from within a session. The file supports JSON with comments (JSONC).
52
53
53
54
> [!NOTE]
54
-
> The configuration file was renamed from`config.json`to `settings.json`. Existing settings are automatically migrated from `~/.copilot/config.json` on startup.
55
+
> User-editable settings were originally stored in`config.json`. They have been moved to `settings.json`. Any user settings present in `config.json` on startup are automatically migrated to `settings.json`.
55
56
56
57
For the full list of settings and how they interact with repository-level configuration, see [Configuration file settings](#configuration-file-settings) later in this article.
57
58
@@ -102,6 +103,13 @@ For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-cop
102
103
103
104
The following items are managed by the CLI. You generally should not edit them manually.
104
105
106
+
### `config.json`
107
+
108
+
Stores internal application state that is managed automatically by the CLI, including authentication data, installed plugin metadata, and other runtime information. You should not normally need to edit this file.
109
+
110
+
> [!NOTE]
111
+
> Earlier versions of {% data variables.copilot.copilot_cli_short %} stored both user settings and application state in `config.json`. User-editable settings are now located in `settings.json`. Any user settings in `config.json` at startup are automatically migrated to `settings.json`. Application state fields—such as `loggedInUsers`, `installedPlugins`, `firstLaunchAt`, and `staff`—remain in `config.json` and are not migrated.
112
+
105
113
### `permissions-config.json`
106
114
107
115
Stores your saved tool and directory permission decisions, organized by project location. When you approve a tool or grant access to a directory, the CLI records the decision here so you aren't prompted again in the same project.
@@ -162,16 +170,17 @@ To override the default `~/.copilot` location, set the `COPILOT_HOME` environmen
162
170
| Item | Safe to delete? | Effect |
163
171
|------|-----------------|--------|
164
172
|`agents/`, `skills/`, `hooks/`| Not recommended | You will lose your personal customizations. Back up first. |
173
+
|`config.json`| With caution | Resets application state including authentication. You will need to re-authenticate and the CLI will re-detect internal state on next launch. |
165
174
|`copilot-instructions.md`, `instructions/`| Not recommended | You will lose your personal custom instructions. Back up first. |
166
-
|`installed-plugins/`| Not recommended | Use `copilot plugin uninstall` instead, to ensure plugin metadata in `settings.json`stays consistent. |
175
+
|`installed-plugins/`| Not recommended | Use `copilot plugin uninstall` instead, to ensure plugin metadata in `config.json`remains accurate. |
167
176
|`logs/`| Yes | Log files are re-created each session. Deleting them has no functional impact. |
168
177
|`lsp-config.json`| Not recommended | You will lose your user-level LSP server definitions. Back up first. |
169
178
|`mcp-config.json`| Not recommended | You will lose your user-level MCP server definitions. Back up first. |
170
179
|`permissions-config.json`| With caution | Resets all saved permissions. The CLI will prompt you again for tool and directory approvals. |
171
180
|`plugin-data/`| Yes | Plugin persistent data is re-created as needed. |
172
181
|`session-state/`| With caution | Deleting removes session history. You will no longer be able to resume past sessions. |
173
182
|`session-store.db`| With caution | Deleting removes cross-session data. The file is re-created automatically. |
174
-
|`settings.json`| With caution | Resets all configuration to defaults. You will need to reconfigure your preferences and re-authenticate. |
183
+
|`settings.json`| With caution | Resets all user preferences to defaults. You will need to reconfigure your settings. |
175
184
176
185
## Configuration file settings
177
186
@@ -226,7 +235,7 @@ These settings apply across all your sessions and repositories. You can edit thi
|`skillDirectories`|`string[]`|`[]`| Additional directories to search for custom skill definitions (in addition to `~/.copilot/skills/`). |
228
237
|`statusLine`|`object`| — | Custom status line display. `type`: must be `"command"`. `command`: path to an executable script that receives session JSON on stdin and prints status content to stdout. `padding`: optional number of left-padding spaces. |
229
-
|`storeTokenPlaintext`|`boolean`|`false`|Store authentication tokens in plain text in the configuration file when no system keychain is available. |
238
+
|`storeTokenPlaintext`|`boolean`|`false`|Allow authentication tokens to be stored in plain text in `config.json` when no system keychain is available. |
|`streamerMode`|`boolean`|`false`| Hide preview model names and quota details. Useful when demonstrating {% data variables.copilot.copilot_cli_short %} or screen sharing. |
232
241
|`theme`|`"auto"`\|`"dark"`\|`"light"`|`"auto"`| Terminal color theme. `"auto"` detects the terminal background and chooses accordingly. |
0 commit comments