-
Notifications
You must be signed in to change notification settings - Fork 63.5k
Update default Copilot CLI config directory path #40561
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR corrects documentation about the default configuration directory path for GitHub Copilot CLI. The documentation incorrectly stated that the CLI configuration is located in ~/.config
by default, when it's actually located in ~/.copilot
on macOS systems.
Key Changes
- Updated the default configuration directory path from
~/.config
to~/.copilot
in the trusted directories section
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
@Nao-Mk2 Thanks for opening a PR! I'm trying to figure out how to validate this one. I feel like I should be able to install it and check, but I'll probably end up reaching out to our SMEs. |
@Nao-Mk2 I haven't heard back, but someone else just opened the exact same PR, so I'm going to take that as confirmation and go ahead and accept it. |
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes:
The documentation stated that the CLI configuration is "located, by default, in the ~/.config directory." However, after installing and using GitHub Copilot CLI on macOS, the actual configuration directory created was ~/.copilot (for example: ~/.copilot/config.json).
This PR updates the wording to reflect the default location observed on macOS, and to reduce confusion for users who look for the file in ~/.config and cannot find it.
What's being changed (if available, include any code snippets, screenshots, or gifs):
Updated the sentence in the "Trusted directories" section to correct the default configuration directory from
~/.config
to~/.copilot
.Check off the following: