forked from github/copilot-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
chore: improve code quality and documentation #1
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
Open
AungMyoKyaw
wants to merge
1
commit into
main
Choose a base branch
from
chore/improve-code-quality-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: 📚 Official Documentation | ||
| url: https://docs.github.com/copilot/concepts/agents/about-copilot-cli | ||
| about: Check the official documentation for usage guides and FAQs | ||
| - name: 💬 GitHub Discussions | ||
| url: https://github.com/github/copilot-cli/discussions | ||
| about: Join community discussions and ask questions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| name: Remove triage tab from closed issues | ||
| name: Remove triage label from closed issues | ||
| on: | ||
| issues: | ||
| types: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # macOS | ||
| .DS_Store | ||
| .AppleDouble | ||
| .LSOverride | ||
| ._* | ||
|
|
||
| # Editor/IDE | ||
| .idea/ | ||
| .vscode/ | ||
| *.swp | ||
| *.swo | ||
| *~ | ||
|
|
||
| # Logs | ||
| *.log | ||
| npm-debug.log* | ||
|
|
||
| # Dependencies (if any local development) | ||
| node_modules/ | ||
|
|
||
| # Environment files | ||
| .env | ||
| .env.local | ||
| .env.*.local | ||
|
|
||
| # Temporary files | ||
| *.tmp | ||
| *.temp | ||
| .tmp/ | ||
| .temp/ | ||
|
|
||
| # Build outputs (if any) | ||
| dist/ | ||
| build/ | ||
| out/ | ||
|
|
||
| # Test coverage | ||
| coverage/ | ||
|
|
||
| # OS generated files | ||
| Thumbs.db | ||
| ehthumbs.db | ||
| Desktop.ini |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,21 @@ See [our official documentation](https://docs.github.com/copilot/concepts/agents | |
|
|
||
|  | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Introduction and Overview](#-introduction-and-overview) | ||
| - [Getting Started](#-getting-started) | ||
| - [Supported Platforms](#supported-platforms) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Installation](#installation) | ||
| - [Launching the CLI](#launching-the-cli) | ||
| - [Authentication](#authenticate-with-a-personal-access-token-pat) | ||
| - [Using the CLI](#using-the-cli) | ||
| - [Security](#-security) | ||
| - [Feedback and Participation](#-feedback-and-participation) | ||
| - [Contributing](#-contributing) | ||
| - [License](#-license) | ||
|
|
||
| ## 🚀 Introduction and Overview | ||
|
|
||
| We're bringing the power of GitHub Copilot coding agent directly to your terminal. With GitHub Copilot CLI, you can work locally and synchronously with an AI agent that understands your code and GitHub context. | ||
|
|
@@ -24,9 +39,11 @@ We're still early in our journey, but with your feedback, we're rapidly iteratin | |
|
|
||
| ### Supported Platforms | ||
|
|
||
| - **Linux** | ||
| - **macOS** | ||
| - **Windows** (experimental) | ||
| | Platform | Support Level | | ||
| |----------|---------------| | ||
| | Linux | Full Support | | ||
| | macOS | Full Support | | ||
| | Windows | Experimental | | ||
|
|
||
| ### Prerequisites | ||
|
|
||
|
|
@@ -35,11 +52,12 @@ We're still early in our journey, but with your feedback, we're rapidly iteratin | |
| - (On Windows) **PowerShell** v6 or higher | ||
| - An **active Copilot subscription**. See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=install-copilot-cli&ref_page=docs). | ||
|
|
||
| If you have access to GitHub Copilot via your organization of enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](http://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information. | ||
| > **Note:** If you have access to GitHub Copilot via your organization or enterprise, you cannot use GitHub Copilot CLI if your organization owner or enterprise administrator has disabled it in the organization or enterprise settings. See [Managing policies and features for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization) for more information. | ||
|
|
||
| ### Installation | ||
|
|
||
| Install globally with npm: | ||
|
|
||
| ```bash | ||
| npm install -g @github/copilot | ||
| ``` | ||
|
|
@@ -50,7 +68,7 @@ npm install -g @github/copilot | |
| copilot | ||
| ``` | ||
|
|
||
| On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag. | ||
| On first launch, you'll be greeted with our adorable animated banner! If you'd like to see this banner again, launch `copilot` with the `--banner` flag. | ||
|
|
||
| If you're not currently logged in to GitHub, you'll be prompted to use the `/login` slash command. Enter this command and follow the on-screen instructions to authenticate. | ||
|
|
||
|
|
@@ -65,19 +83,50 @@ You can also authenticate using a fine-grained PAT with the "Copilot Requests" p | |
|
|
||
| ### Using the CLI | ||
|
|
||
| Launch `copilot` in a folder that contains code you want to work with. | ||
| Launch `copilot` in a folder that contains code you want to work with. | ||
|
|
||
| By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5 | ||
| By default, `copilot` utilizes Claude Sonnet 4.5. Run the `/model` slash command to choose from other available models, including Claude Sonnet 4 and GPT-5. | ||
|
|
||
| Each time you submit a prompt to GitHub Copilot CLI, your monthly quota of premium requests is reduced by one. For information about premium requests, see [About premium requests](https://docs.github.com/copilot/managing-copilot/monitoring-usage-and-entitlements/about-premium-requests). | ||
|
|
||
| For more information about how to use the GitHub Copilot CLI, see [our official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli). | ||
|
|
||
| ## 🔐 Security | ||
|
|
||
| ### Token Security | ||
|
|
||
| - **Never commit tokens to version control.** Always use environment variables for authentication tokens. | ||
| - Use fine-grained Personal Access Tokens (PATs) with minimal required permissions. | ||
| - The `GH_TOKEN` and `GITHUB_TOKEN` environment variables are read at runtime and should be stored securely. | ||
| - Consider using a credential manager or secret management solution for storing tokens. | ||
|
|
||
| ### Best Practices | ||
|
|
||
| - Review all proposed actions before approving them in the CLI. | ||
| - Be cautious when running Copilot CLI on sensitive or proprietary codebases. | ||
| - Regularly update to the latest version to receive security patches. | ||
| - Report security vulnerabilities through [GitHub Security](https://github.com/github/copilot-cli/security) rather than public issues. | ||
|
|
||
| ## 📢 Feedback and Participation | ||
|
|
||
| We're excited to have you join us early in the Copilot CLI journey. | ||
|
|
||
| This is an early-stage preview, and we're building quickly. Expect frequent updates--please keep your client up to date for the latest features and fixes! | ||
| This is an early-stage preview, and we're building quickly. Expect frequent updates—please keep your client up to date for the latest features and fixes! | ||
|
|
||
| Your insights are invaluable! You can contribute by: | ||
|
|
||
| - **Opening an issue:** Report bugs or request features using our [issue templates](/.github/ISSUE_TEMPLATE/) | ||
| - **Joining Discussions:** Participate in community conversations | ||
| - **Submitting feedback:** Run `/feedback` from the CLI to submit a confidential feedback survey | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| This repository primarily serves as a place for issue tracking and community feedback. For questions or support: | ||
|
|
||
| 1. Check the [official documentation](https://docs.github.com/copilot/concepts/agents/about-copilot-cli) | ||
| 2. Search existing [issues](https://github.com/github/copilot-cli/issues) to see if your question has been addressed | ||
| 3. Open a new issue using the appropriate [issue template](/.github/ISSUE_TEMPLATE/) | ||
|
|
||
|
Comment on lines
+127
to
+129
|
||
| ## 📄 License | ||
|
|
||
| Your insights are invaluable! Open issue in this repo, join Discussions, and run `/feedback` from the CLI to submit a confidential feedback survey! | ||
| Copyright (c) GitHub 2025. All rights reserved. Use is subject to GitHub's [Pre-release License Terms](https://docs.github.com/en/site-policy/github-terms/github-pre-release-license-terms). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The link to the issue templates uses an absolute path (
/.github/ISSUE_TEMPLATE/), which GitHub renders ashttps://github.com/.github/ISSUE_TEMPLATE/(not this repo). Use a repo-relative link (e.g.,./.github/ISSUE_TEMPLATE/) or link directly to the issue chooser page (https://github.com/github/copilot-cli/issues/new/choose).