Verified Commit b26eba34 authored by Uma Chandran (OOO Aug 28 - Sept 1)'s avatar Uma Chandran (OOO Aug 28 - Sept 1) 🌴 Committed by GitLab
Browse files

docs: update readme to simplify and reflect docs refactor

parent 5a2c52db
Loading
Loading
Loading
Loading
+23 −82
Original line number Diff line number Diff line
# GitLab for VS Code extension

This extension integrates GitLab into Visual Studio Code.
The GitLab for VS Code extension brings GitLab Duo and other GitLab features directly into Visual Studio Code:

If you face an issue, check out our [troubleshooting page](https://docs.gitlab.com/editor_extensions/visual_studio_code/troubleshooting/) and if it's not listed, please [report it](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/blob/main/CONTRIBUTING.md#reporting-issues).
- [Work with projects](https://docs.gitlab.com/editor_extensions/visual_studio_code/projects/):
  Plan and track work with issues, review and discuss changes with merge requests,
  and share code snippets. Use GitLab Duo for AI-native planning and coding.
- [Monitor and test CI/CD pipelines](https://docs.gitlab.com/editor_extensions/visual_studio_code/cicd/):
  Test your pipeline configuration. View pipeline status and job outputs.
- [Secure your application](https://docs.gitlab.com/editor_extensions/visual_studio_code/security_scanning/):
  Review security findings and perform SAST scanning for your project.

For detailed feature documentation, see [GitLab for VS Code](https://docs.gitlab.com/editor_extensions/visual_studio_code/).

## Minimum supported version

@@ -16,94 +24,25 @@ For GitLab.com and GitLab Dedicated, you automatically use a supported version.

Some features require specific GitLab versions, plans, or add-ons. For details, see the [GitLab extension documentation](https://docs.gitlab.com/editor_extensions/visual_studio_code/).

## Features

After you [set up the extension](#setup), this extension adds GitLab features to your preferred IDE:

### Manage projects and code

- [Clone a Git project](https://docs.gitlab.com/editor_extensions/visual_studio_code/remote_urls/#clone-a-git-project).
- [Browse a GitLab repository without cloning it](https://docs.gitlab.com/editor_extensions/visual_studio_code/remote_urls/#browse-a-repository-in-read-only-mode).

### Manage issues and merge requests

- [View GitLab issues and merge requests](https://docs.gitlab.com/editor_extensions/visual_studio_code/#view-issues-and-merge-requests).
  View issues, comments, merge requests, and changed files in the VS Code sidebar.
- Build [custom, saved searches](https://docs.gitlab.com/editor_extensions/visual_studio_code/custom_queries/)
  to meet your needs.
- [Create and review merge requests](https://docs.gitlab.com/editor_extensions/visual_studio_code/#review-a-merge-request).

### Manage CI/CD pipelines

- [Manage your pipelines](https://docs.gitlab.com/editor_extensions/visual_studio_code/cicd/).
  View your pipeline status and open the related merge request. Use advanced pipeline actions to create, retry, or cancel a pipeline.
- [View CI/CD job output](https://docs.gitlab.com/editor_extensions/visual_studio_code/cicd/#view-cicd-job-output).
  View the output of a running or finished job in an editor tab.
- [Test your GitLab CI/CD configuration](https://docs.gitlab.com/editor_extensions/visual_studio_code/cicd/#test-gitlab-cicd-configuration) locally.
- [Auto-complete GitLab CI/CD variables](https://docs.gitlab.com/editor_extensions/visual_studio_code/cicd/#cicd-variable-autocompletion)
  in your `.gitlab-ci.yml` pipeline file.

### AI-assisted features

- [GitLab Duo Chat](https://docs.gitlab.com/user/gitlab_duo_chat/#use-gitlab-duo-chat-in-vs-code):
  Interact with an AI assistant directly in VS Code.
- [GitLab Duo Code Suggestions](https://docs.gitlab.com/user/project/repository/code_suggestions/):
  Suggest completions to your current line of code, or write natural-language code comments to get
  more substantive suggestions.

### Other features

- [View security findings in your current branch](https://docs.gitlab.com/editor_extensions/visual_studio_code/#view-security-findings)
- [Manage snippets](https://docs.gitlab.com/editor_extensions/visual_studio_code/#create-a-snippet). Create and insert snippets, and create [snippet patches](https://docs.gitlab.com/editor_extensions/visual_studio_code/#create-a-patch-file).

## GitLab Duo Agent Platform: Chat and Flow

In the IDE, when you select GitLab Duo Agent Platform, two tabs are available for use:

- **[Chat](https://docs.gitlab.com/user/gitlab_duo_chat/agentic_chat/)**: Get help with code, planning, security, project management, and more. GitLab Duo Agentic Chat can answer questions or perform tasks for you.
- **[Flow](https://docs.gitlab.com/user/duo_agent_platform/flows/)**: Use the [Software Development Flow](https://docs.gitlab.com/user/duo_agent_platform/flows/foundational_flows/software_development/) to gather context, create a plan, and execute on it. The flow has access to your project and any additional context you provide.

Some functionality overlaps because GitLab Duo Chat can also invoke a flow when fulfilling a request.

## Setup

This extension requires you to create a GitLab personal access token, and assign it to the extension:

1. [Install the extension](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow) from the Visual Studio Marketplace and enable it. If you use an unofficial version of VS Code, install the extension from the [Open VSX Registry](https://open-vsx.org/extension/GitLab/gitlab-workflow).
1. To sign in to your GitLab instance, run the command **GitLab: Authenticate**.
   1. Open Visual Studio Code, then open the command palette by pressing <kbd>Command</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>.
   1. In the command palette, search for **GitLab: Authenticate** and press <kbd>Enter<kbd>.
   1. Select your GitLab instance URL from the offered options, or enter one manually.
      - When manually adding an instance to **URL to GitLab instance**, paste the full URL to your
        GitLab instance, including the `http://` or `https://`. Press <kbd>Enter</kbd> to confirm.
   1. For GitLab.com, you can use the OAuth authentication method.
   1. If you don't use OAuth, use a Personal Access Token to log in.
      - If you have an existing personal access token with `api` scope, select **Enter an existing token** to enter it.
      - If you don't, select **Create a token first**, and the extension opens the PAT settings page for you.
        If this method fails, follow the instructions [in the GitLab documentation](https://docs.gitlab.com/user/profile/personal_access_tokens/#create-a-personal-access-token).
   1. Copy the token. _For security reasons, this value is never displayed again, so you must copy this value now._
   1. Paste in your GitLab personal access token and press <kbd>Enter</kbd>. The token is not displayed, nor is it accessible to others.
For instructions, see [install and set up the GitLab for VS Code extension](https://docs.gitlab.com/editor_extensions/visual_studio_code/setup/).

The extension automatically matches your Git repository remote URL with the GitLab instance URL you specified for your token. If you have multiple accounts or projects, you can choose the one you want to use. For more information, see [Switch GitLab accounts in VS Code](https://docs.gitlab.com/editor_extensions/visual_studio_code/#switch-gitlab-accounts-in-vs-code).
## Browse a repository without cloning

The extension is ready to use. If your project has a pipeline for the last commit, and a merge request from your current branch, information about both is displayed in the Visual Studio Code status bar.
With this extension, you can browse a GitLab repository in read-only mode without cloning it.

### Commands and extension settings
For instructions, see [browse a repository in read-only mode](https://docs.gitlab.com/editor_extensions/visual_studio_code/remote_urls/#browse-a-repository-in-read-only-mode).

For a full list of GitLab commands you can run from the VS Code Command Palette, see:
## Troubleshooting

- [Command Palette commands](https://docs.gitlab.com/editor_extensions/visual_studio_code/settings/#command-palette-commands).
- [Extension settings you can configure](https://docs.gitlab.com/editor_extensions/visual_studio_code/settings/#extension-settings).
For support, review [troubleshooting the GitLab for VS Code extension](https://docs.gitlab.com/editor_extensions/visual_studio_code/troubleshooting/).

### Browse a repository without cloning

See [Browse a repository in read-only mode](https://docs.gitlab.com/editor_extensions/visual_studio_code/remote_urls/#browse-a-repository-in-read-only-mode) in the GitLab documentation.
If the documentation does not cover your issue, please [report the issue](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/blob/main/CONTRIBUTING.md#reporting-issues).

## Roadmap

To learn more about this project's team, processes, and plans, see
the [Create:Editor Extensions Group](https://handbook.gitlab.com/handbook/engineering/development/dev/create/editor-extensions/)
page in the GitLab handbook.
To learn more about this project's team, processes, and plans, see the [Editor Extensions: VS Code Group](https://handbook.gitlab.com/handbook/engineering/ai/editor-extensions-vscode/) page in the GitLab handbook.

For a list of all open issues in this project, see the
[issues page](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/issues/)
@@ -111,11 +50,13 @@ for this project.

## Data and Privacy

The GitLab for VS Code extension uses the telemetry settings in Visual Studio Code to send usage and error information to GitLab. See [this page](https://docs.gitlab.com/editor_extensions/visual_studio_code/#enable-telemetry) for instructions on how to enable or customize telemetry in Visual Studio Code. The processing of any personal data is in accordance with our [Privacy Statement](https://about.gitlab.com/privacy/).
The GitLab for VS Code extension uses the telemetry settings in Visual Studio Code to send usage and error information to GitLab.

Learn [how to enable or customize telemetry](https://docs.gitlab.com/editor_extensions/visual_studio_code/setup/#enable-telemetry) in Visual Studio Code.

---
The processing of any personal data is in accordance with our [Privacy Statement](https://about.gitlab.com/privacy/).

## Contribution
## Contributing

This extension is open source and [hosted on GitLab](https://gitlab.com/gitlab-org/gitlab-vscode-extension). Contributions are more than welcome. Feel free to fork and add new features or submit bug reports. See [CONTRIBUTING](CONTRIBUTING.md) for more information.