Configure and use Gemini Code Assist code customization

This document describes how to set up Gemini Code Assist code customization by connecting Gemini Code Assist to your private code repositories. This feature lets you receive code recommendations, which draw from the internal libraries, private APIs, and coding style of your organization.

Before you begin

• Contact your sales representative to gain access to Gemini Code Assist code customization.
• Ensure that you have a Google Cloud administrator account to make changes to your project.
• Set up Gemini Code Assist.
• Create or configure end user accounts. Every developer in your organization who is using Gemini Code Assist must have a user identity in Google Cloud that has permission to access your Google Cloud project. For more information, see Grant roles in the Google Cloud console. Ensure each user has the following roles:
  • Gemini for Google Cloud API User
  • Gemini for Google Cloud API Code Repository Groups User

• Configure Developer Connect, and then connect to your GitHub.com or GitLab.com repository:

  • Connect to GitHub.
  • Connect to GitLab.

  Additionally, note that code customization only supports Developer Connect connections in the us-central1 and europe-west1 locations (regions).

• In a shell environment, run the gcloud components update command to ensure that you have updated all installed components of the Google Cloud CLI to the latest version.

Choose which private repositories are connected

As a best practice, ensure you connect repositories which:

• Have code that's of a similar style or structure to what you want your developers to write.
• Have private libraries or APIs that you would like to call from your current codebase.

(Optional) Choose which files are not indexed

In many scenarios, you might have specific files or subtrees that you don't want indexed. For example:

• Highly sensitive information with limited access inside your organization
• Old or deprecated code
• Auto-generated or temporary code

To prevent exposure of code that you don't want to index, you can use branch patterns to control access to your index and use a stable branch, such as main.

Alternatively, you can also exclude files from the index by creating an .aiexclude file.

Create an index

Code customization relies on an index to analyze and parse your repository for quicker code generation suggestions and lookups.

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

2. To create the index, use the gemini code-repository-indexes create command:

   gcloud gemini code-repository-indexes create INDEX_NAME \
       --project=PROJECT_ID \
       --location=REGION
   

   Replace the following:

   • INDEX_NAME: your index name.
   • PROJECT_ID: your Google Cloud project ID.
   • REGION: a supported region, either us-central1 or europe-west1, that you have configured in Developer Connect in your Google Cloud project.

Index creation generally takes 30 minutes to complete, but it might take up to an hour.

Google limits the number of code repository indexes to one for each project and organization. If you need more code repository indexes, you can request a higher quota.

Control access to your index using repository groups

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

2. To create a repository group, use the gemini code-repository-indexes repository-groups create command:

   gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
       --project=PROJECT_ID \
       --location=REGION \
       --code-repository-index=INDEX_NAME \
       --repositories='[{"resource": "projects/PROJECT_ID/locations/REGION/connections/INDEX_CONNECTION/gitRepositoryLinks/REPOSITORY"}]'
   

   Replace the following:

   • REPOSITORY_GROUP: name of the repository group, such as default.
   • PROJECT_ID: your Google Cloud project ID.
   • INDEX_NAME: name of the index you created in a preceding step to create an index.
   • REGION: a supported region, either us-central1 or europe-west1, that you have configured in Developer Connect in your Google Cloud project.
   • INDEX_CONNECTION: connection of the index you created in a preceding step to create an index.
   • BRANCH_NAMES: name of the branches you want to index, such as main|dev.
   • REPOSITORY: the repository you want to index. You must specify at least one repository, and you can specify multiple repositories as needed.

You also can create a repository group with repositories defined in a JSON (or YAML) file, formatted as follows:

[
  {
      "resource": "projects/PROJECT_ID/locations/REGION/connections/INDEX_CONNECTION/gitRepositoryLinks/REPOSITORY", "branchPattern": "main|dev"
  },
  {
      "resource": "projects/PROJECT_ID/locations/REGION/connections/INDEX_CONNECTION/gitRepositoryLinks/REPOSITORY", "branchPattern": "dev"
  }
]

- resource: projects/PROJECT_ID/locations/REGION/connections/INDEX_CONNECTION/gitRepositoryLinks/REPOSITORY
branchPattern: main|dev
- resource: projects/PROJECT_ID/locations/REGION/connections/INDEX_CONNECTION/gitRepositoryLinks/REPOSITORY
branchPattern: dev

To create a repository group based on a JSON or YAML file, use the gemini code-repository-indexes repository-groups create command:

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.json

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.yaml

Grant IAM role to the repository group on a project

You only receive suggestions from repositories in the index. Each repository belongs to one or multiple repository groups. To access suggestions, you must grant the Cloud AI Companion Repository Groups User IAM role (roles/cloudaicompanion.repositoryGroupsUser)—which contains the required cloudaicompanion.repositoryGroups.user IAM permission—to the repository group by one of the following ways:

• Grant principals permission to access the entire index.
• Grant principals access to a subset of the index.

Grant principals permission to access the entire index

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

2. To bind an IAM policy for a project, use the projects add-iam-policy-binding command:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member='PRINCIPAL' \
       --role='roles/cloudaicompanion.repositoryGroupsUser'
   

   Replace the following:

   • PROJECT_ID: the project ID where the repository group is located.
   • PRINCIPAL: the email address of the principal that needs access—for example, user:test-user@gmail.com for an individual, or group:admins@example.com for a group.

3. When prompted to specify a condition, enter None.

Grant principals access to a subset of the index

You can create multiple repository groups and assign IAM roles to different IAM principals.

In order to set up an IAM policy you must prepare the IAM policy JSON or YAML file, which will contain a list of IAM groups and assigned roles. For example:

bindings:
- members:
  - group:my-group@example.com
  - user:test-user@example.com
  role: roles/cloudaicompanion.repositoryGroupsUser

For additional details and syntax, see Understanding allow policies.

To set the IAM policy, use the gemini code-repository-indexes repository-groups set-iam-policy command:

gcloud gemini code-repository-indexes repository-groups set-iam-policy GROUP_NAME` `POLICY_FILE \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME

Replace the following:

• GROUP_NAME: the IAM group name.
• POLICY_FILE: the IAM policy.
• REGION: a supported region, either us-central1 or europe-west1, that you have configured in Developer Connect in your Google Cloud project.
• INDEX_NAME: name of the index you created in a preceding step to create an index.

Check indexing status

Depending on the number of repositories you want to index and their size, indexing content can take up to 24 hours. Indexing occurs once every 24 hours, picking up any changes that were made in the repository.

1. In the Google Cloud console, go to the Logs Explorer.

   Go to Logs Explorer

2. Use the log names filter to view indexing logs, or search for the indexing logs with the following command:

   gcloud logging read "logName="projects/PROJECT_ID/logs/indexing""
   

   Replace PROJECT_ID with the project ID where the repository group is located.

   For example, to view errors in the indexing logs, run the following command:

   gcloud logging read "logName="projects/PROJECT_ID/logs/indexing" AND severity>=ERROR"
   

   For more information, see Logging query language.

3. Review the associated indexing statuses, such as the following:

   • Start of repository indexing-for example, Indexing repository REPOSITORY_GROUP. Total number of repositories: 10, succeeded: 6, failed: 0.
   • End of individual repository indexing-for example:
     • Success: Successfully finished indexing repository REPOSITORY_GROUP. Total number of repositories: 10, succeeded: 7, failed: 0.
     • Failure: Failed to index repository REPOSITORY_GROUP. Error: [<error message>]. Total number of repositories: 10, succeeded: 7, failed: 1.
   • End of repository indexing-for example:
     • Success: Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 0.
     • Failure: Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 1. Repositories that were not successfully fetched will be retried in the next run.

   In the index statuses, REPOSITORY_GROUP is the repository group you want to review.

4. Review the associated indexing errors, such as the following:

   • Failed to fetch repository.
   • Failed to list repository files.
   • Failed to retrieve repository information from the index.
   • Failed to retrieve files from the index.
   • Internal error.

Use code customization

Once you have set up code customization, users will begin to see code completion and code generation suggestions which may be based on private code you have indexed in addition to results from full codebase awareness.

Turn off code customization

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

2. To list all repository groups for the current index, use the gemini code-repository-indexes repository-groups list command:

   gcloud gemini code-repository-indexes repository-groups list --location=REGION \
       --project=PROJECT_ID \
       --code-repository-index=INDEX_NAME --uri
   

   Replace the following:

   • REGION: a supported region, either us-central1 or europe-west1, that you have configured in Developer Connect in your Google Cloud project
   • PROJECT_ID: your Google Cloud project ID.
   • INDEX_NAME: name of the index you created in a preceding step to create an index.

3. To delete a repository group from the current index, use the gemini code-repository-indexes repository-groups delete command:

   gcloud gemini code-repository-indexes repository-groups delete REPOSITORY_GROUP \
       --location=REGION \
       --project=PROJECT_ID \
       --code-repository-index=INDEX_NAME
   

4. Repeat step 3 for each repository group until you delete all repository groups from the index.

5. Optional: To delete the index, use the gemini code-repository-indexes delete command:

   gcloud gemini code-repository-indexes delete INDEX_NAME \
       --location=REGION \
       --project=PROJECT_ID
   

What's next

• Start using Gemini Code Assist:
  • VS Code: Code with Gemini Code Assist
  • IntelliJ: Code with Gemini Code Assist
  • Cloud Shell Editor: Code with Gemini Code Assist
  • Cloud Workstations: Code with Gemini Code Assist
• Learn more about Developer Connect.
• Learn how and when Gemini for Google Cloud uses your data.