Sourcegraph

https://sourcegraph.com/docs
Admin
Sourcegraph is a Code Intelligence platform that helps developers rapidly search, write, and...
Tokens:633,938
Snippets:10,430
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Sourcegraph Docker Deployment Startup Script

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/google-cloud.md

This bash script automates the setup of Sourcegraph on a Google Cloud VM. It clones the deployment repository, formats and mounts a persistent disk for Docker data, and installs Docker. Ensure you replace the placeholder for DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION with your desired version.

```bash
#!/usr/bin/env bash
set -euxo pipefail
###############################################################################
# ACTION REQUIRED: REPLACE THE URL AND REVISION WITH YOUR DEPLOYMENT REPO INFO
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION={CURRENT_VERSION}
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
# IMPORTANT: DO NOT MAKE ANY CHANGES FROM THIS POINT ONWARD
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
DOCKER_COMPOSE_VERSION='1.29.2'
DOCKER_DAEMON_CONFIG_FILE='/etc/docker/daemon.json'
DOCKER_DATA_ROOT='/mnt/docker-data'
PERSISTENT_DISK_DEVICE_NAME='/dev/sdb'
PERSISTENT_DISK_LABEL='sourcegraph'
# Install git
sudo apt-get update -y
sudo apt-get install -y git
# Clone the deployment repository
git clone "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL}" "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
git checkout "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION}"
# Format (if unformatted) and then mount the attached volume
device_fs=$(sudo lsblk "${PERSISTENT_DISK_DEVICE_NAME}" --noheadings --output fsType)
if [ "${device_fs}" == "" ] ## only format the volume if it isn't already formatted
then
    sudo mkfs.ext4 -m 0 -E lazy_itable_init=0,lazy_journal_init=0,discard "${PERSISTENT_DISK_DEVICE_NAME}"
fi
sudo e2label "${PERSISTENT_DISK_DEVICE_NAME}" "${PERSISTENT_DISK_LABEL}"
sudo mkdir -p "${DOCKER_DATA_ROOT}"
sudo mount -o discard,defaults "${PERSISTENT_DISK_DEVICE_NAME}" "${DOCKER_DATA_ROOT}"
# Mount file system by label on reboot
sudo echo "LABEL=${PERSISTENT_DISK_LABEL}  ${DOCKER_DATA_ROOT}  ext4  discard,defaults,nofail  0  2" | sudo tee -a /etc/fstab
sudo umount "${DOCKER_DATA_ROOT}"
sudo mount -a
# Install, configure, and enable Docker
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-get update -y
sudo apt-get install -y software-properties-common
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update -y
apt-cache policy docker-ce
apt-get install -y docker-ce docker-ce-cli containerd.io
## Enable Docker at startup
sudo systemctl enable --now docker
## Install jq for scripting
sudo apt-get update -y
sudo apt-get install -y jq

```

--------------------------------

### Monitor Startup Script

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/google-cloud.md

Follows the logs of the startup script in real-time to monitor the progress of the Sourcegraph installation and setup process.

```bash
tail -c +0 -f /var/log/syslog | grep startup-script
```

--------------------------------

### Sourcegraph Docker Deployment Startup Script

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/digitalocean.md

This bash script automates the setup of a Sourcegraph instance on a DigitalOcean Droplet. It clones the deployment repository, formats and mounts persistent storage, installs Docker, and configures it to use the mounted volume. Ensure you replace `{CURRENT_VERSION}` with your desired Sourcegraph version.

```bash
#!/usr/bin/env bash
set -euxo pipefail
###############################################################################
# ACTION REQUIRED: REPLACE THE URL AND REVISION WITH YOUR DEPLOYMENT REPO INFO
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION={CURRENT_VERSION}
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
DOCKER_DATA_ROOT='/mnt/docker-data'
DOCKER_COMPOSE_VERSION='1.29.2'
DOCKER_DAEMON_CONFIG_FILE='/etc/docker/daemon.json'
PERSISTENT_DISK_DEVICE_NAME='/dev/sda'
# Install git
sudo apt-get update -y
sudo apt-get install -y git
# Clone the deployment repository
git clone "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL}" "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
git checkout "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION}"
# Format (if unformatted) and then mount the attached volume
device_fs=$(sudo lsblk "${PERSISTENT_DISK_DEVICE_NAME}" --noheadings --output fsType)
if [ "${device_fs}" == "" ]
then
    sudo mkfs.ext4 -m 0 -E lazy_itable_init=0,lazy_journal_init=0,discard "${PERSISTENT_DISK_DEVICE_NAME}"
fi
sudo mkdir -p "${DOCKER_DATA_ROOT}"
sudo mount -o discard,defaults "${PERSISTENT_DISK_DEVICE_NAME}" "${DOCKER_DATA_ROOT}"
# Mount file system by UUID on reboot
DISK_UUID=$(sudo blkid -s UUID -o value "${PERSISTENT_DISK_DEVICE_NAME}")
sudo echo "UUID=${DISK_UUID}  ${DOCKER_DATA_ROOT}  ext4  discard,defaults,nofail  0  2" >> '/etc/fstab'
sudo umount "${DOCKER_DATA_ROOT}"
sudo mount -a
# Install, configure, and enable Docker
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update -y
apt-cache policy docker-ce
apt-get install -y docker-ce docker-ce-cli containerd.io
## Enable Docker at startup
sudo systemctl enable --now docker
# Install jq for scripting
sudo apt-get update -y
sudo apt-get install -y jq
## Initialize the config file with empty json if it doesn't exist
if [ ! -f "${DOCKER_DAEMON_CONFIG_FILE}" ]
then
    mkdir -p $(dirname "${DOCKER_DAEMON_CONFIG_FILE}")
    echo '{}' > "${DOCKER_DAEMON_CONFIG_FILE}"
fi
## Point Docker storage to mounted volume
tmp_config=$(mktemp)
trap "rm -f ${tmp_config}" EXIT
sudo cat "${DOCKER_DAEMON_CONFIG_FILE}" | sudo jq --arg DATA_ROOT "${DOCKER_DATA_ROOT}" '.["data-root"]=$DATA_ROOT' > "${tmp_config}"
sudo cat "${tmp_config}" > "${DOCKER_DAEMON_CONFIG_FILE}"
## Restart Docker daemon to pick up new changes
sudo systemctl restart --now docker

```

--------------------------------

### Install executor dependencies

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary.md

Run these commands as root to install and configure required components for the executor.

```bash
executor install all
# OR run the following, to see how to install/configure components separately.
executor install --help
```

--------------------------------

### Start PostgreSQL in Single-Container Instance

Source: https://sourcegraph.com/docs/self-hosted/how-to/run-psql.md

After exec'ing into the container, run this command to start the PostgreSQL client and connect to the database. No password is required by default.

```bash
psql -U postgres
```

--------------------------------

### Check Docker Installation

Source: https://sourcegraph.com/docs/batch-changes/troubleshooting.md

Confirm that Docker is installed and configured correctly. This command tests Docker by running the `hello-world` image.

```bash
docker run hello-world
```

--------------------------------

### Good Example: Specific Email Validation Prompt with Test Cases

Source: https://sourcegraph.com/docs/cody/prompts-guide.md

Provide clear requirements, expected return values, and concrete examples of valid and invalid inputs to guide code generation.

```plaintext
Create a function to validate email addresses in JavaScript. Return true for valid email addresses and false for invalid ones. Here are some example test cases:

Valid:
- "john@example.com"
- "jane.doe@example.co.uk"

Invalid:
- "john@example"
- "jane.doe@example."
- "invalid.email"

Please write the function
```

--------------------------------

### Install Go SCIP Indexer

Source: https://sourcegraph.com/docs/code-navigation/how-to/index-a-go-repository.md

Installs the scip-go command-line tool, which is used to generate SCIP index files for Go projects. Ensure Go is installed and configured in your PATH.

```shell
go install github.com/sourcegraph/scip-go/cmd/scip-go@latest
```

--------------------------------

### Initial Prompt for Order Price Calculation

Source: https://sourcegraph.com/docs/cody/prompts-guide.md

Start with a general prompt to get initial code, then refine it with specific requirements.

```plaintext
I need to calculate the total price of an order. Help me write the function
```

--------------------------------

### Enable and Start Docker Service

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/azure.md

Enables the Docker service to start automatically on boot and starts it immediately. This command is essential for Docker to function.

```bash
sudo systemctl enable --now docker
```

--------------------------------

### Install Cody CLI with npm

Source: https://sourcegraph.com/docs/cody/clients/install-cli.md

Use this command to install the Cody CLI globally using npm. Ensure you have Node.js v20 or newer and npm installed.

```shell
npm install -g @sourcegraph/cody
```

--------------------------------

### Install Docker Compose

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/digitalocean.md

Installs Docker Compose and its bash completion script. Ensure DOCKER_COMPOSE_VERSION is set before running.

```bash
curl -L "https://github.com/docker/compose/releases/download/${DOCKER_COMPOSE_VERSION}/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
curl -L "https://raw.githubusercontent.com/docker/compose/${DOCKER_COMPOSE_VERSION}/contrib/completion/bash/docker-compose" -o /etc/bash_completion.d/docker-compose
```

--------------------------------

### Verify Cody CLI installation

Source: https://sourcegraph.com/docs/cody/clients/install-cli.md

Run this command after installation to confirm that the Cody CLI is installed correctly and accessible.

```shell
cody help
```

--------------------------------

### Verify src-cli installation

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary-offline.md

Confirm the binary is correctly installed and accessible in the system path.

```shell
$ src version
Current version: 7.4.0
```

--------------------------------

### Example Batch Spec with Templating

Source: https://sourcegraph.com/docs/batch-changes/batch-spec-templating.md

This example demonstrates using the `join` template helper function to construct arguments for `run` commands based on repository search results and modified files from previous steps.

```yaml
on:
    - repositoriesMatchingQuery: lang:go fmt.Sprintf("%d", :[v]) patterntype:structural -file:vendor

steps:
    - run: comby -in-place 'fmt.Sprintf("%d", :[v])' 'strconv.Itoa(:[v])' ${{ join repository.search_result_paths " " }}
      #                                                                   ^ templating starts here
      container: comby/comby
    - run: goimports -w ${{ join previous_step.modified_files " " }}
      #                 ^ templating starts here
      container: unibeautify/goimports
```

--------------------------------

### Start Postgres Instance Separately

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/migrate.md

Start only the PostgreSQL instance using a specific Docker Compose file to prepare for database restoration.

```bash
docker-compose -f db-only-migrate.docker-compose.yaml up -d
```

--------------------------------

### Start All Sourcegraph Containers

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/migrate.md

Start all Sourcegraph services using the main Docker Compose configuration file after the database migration is complete.

```bash
docker-compose -f docker-compose.yaml up -d
```

--------------------------------

### Install Cody CLI with yarn

Source: https://sourcegraph.com/docs/cody/clients/install-cli.md

Use this command to install the Cody CLI globally using yarn. Ensure you have Node.js v20 or newer and yarn installed.

```shell
yarn global add @sourcegraph/cody
```

--------------------------------

### Install Cody CLI with pnpm

Source: https://sourcegraph.com/docs/cody/clients/install-cli.md

Use this command to install the Cody CLI globally using pnpm. Ensure you have Node.js v20 or newer and pnpm installed.

```shell
pnpm install -g @sourcegraph/cody
```

--------------------------------

### Start Sourcegraph with Docker Compose

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/digitalocean.md

Starts the Sourcegraph instance using Docker Compose. Assumes you are in the "docker-compose" directory of the Sourcegraph deployment repository.

```bash
cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"/docker-compose
docker-compose up -d --remove-orphans
```

--------------------------------

### Install Sourcegraph CLI for Linux

Source: https://sourcegraph.com/docs/batch-changes/quickstart.md

Installs the Sourcegraph CLI (`src`) for Linux. Ensure you replace `<YOUR-SOURCEGRAPH-INSTANCE-URL>` with your actual Sourcegraph instance URL.

```bash
curl -L https://<YOUR-SOURCEGRAPH-INSTANCE-URL>/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
```

--------------------------------

### Another matched example for fmt.Sprintf

Source: https://sourcegraph.com/docs/code-search/types/structural.md

Another example of a `fmt.Sprintf` call matching the pattern for a string literal first argument.

```go
fmt.Sprintf("%s/campaigns/%s", externalURL, string(campaignID))
```

--------------------------------

### Install jq

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/azure.md

Installs the 'jq' command-line JSON processor, which is used for manipulating JSON data in scripts.

```bash
sudo apt-get update -y
sudo apt-get install -y jq
```

--------------------------------

### Install Sourcegraph via Shell Script

Source: https://sourcegraph.com/docs/self-hosted/deploy/single-node/script.md

Execute this command to download and run the Sourcegraph installation script. Replace `<args>` with required and optional parameters like the data disk device.

```sh
curl -sfL https://raw.githubusercontent.com/sourcegraph/deploy/main/install/scripts/k3s/install.sh | bash -s -- <args>
```

--------------------------------

### Check Git Installation

Source: https://sourcegraph.com/docs/batch-changes/troubleshooting.md

Verify that Git is installed and accessible on your machine. This is a prerequisite for executing batch specs.

```bash
git version
```

--------------------------------

### Start Sourcegraph with Docker Compose

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose.md

Build and start the Sourcegraph instance using Docker Compose in the production server's docker-compose directory. Supports both attached and detached modes.

```bash
# Go to the docker-compose configuration directory
cd docker-compose
# Start Sourcegraph with Docker Compose
docker compose up
# OR you can start Sourcegraph with Docker Compose in a detached mode
docker compose up -d
```

--------------------------------

### Install Sourcegraph CLI with npm

Source: https://sourcegraph.com/docs/cli/explanations/versioning.md

Install the Sourcegraph CLI globally using npm. This is useful if you are already using Node.js and npm in your development environment.

```bash
npm install -g @sourcegraph/src
```

--------------------------------

### Example matched by fmt.Sprintf with string argument

Source: https://sourcegraph.com/docs/code-search/types/structural.md

An example of a `fmt.Sprintf` call that would be matched by the pattern requiring a string literal as the first argument.

```go
fmt.Sprintf("external service not found: %v", e.id)
```

--------------------------------

### Verify Ignite installation

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary-offline.md

Checks the installed version of Ignite to confirm successful setup.

```shell
$ ignite version
Ignite version: version.Info{Major:"0", Minor:"10", GitVersion:"v0.10.8", GitCommit:"...", GitTreeState:"clean", BuildDate:"...", GoVersion:"...", Compiler:"gc", Platform:"linux/amd64"}
Firecracker version: v0.22.4
Runtime: containerd
```

--------------------------------

### Configure TypeScript SCIP Indexer with npm install

Source: https://sourcegraph.com/docs/code-navigation/auto-indexing-configuration.md

This configuration runs npm install and then the TypeScript indexer. It demonstrates using multiple steps within different Docker containers, both based on the same image. Note that the entrypoint must be specified if the image does not define one.

```json
{
	"steps": [
		{
			"image": "sourcegraph/scip-typescript:autoindex",
			"commands": ["npm install"],
			"root": "editors/code"
		}
	],
	"indexer": "sourcegraph/scip-typescript:autoiondex",
	"indexer_args": ["scip-typescript", "index"],
	"root": "editors/code"
}
```

--------------------------------

### Compare Kustomize Overlays (Example 1)

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/operations.md

Compares diff between resources generated by the k3s overlay for size xs instance and the k3s overlay for size xl instance.

```bash
$ diff \
    <(kubectl kustomize examples/k3s/xs) \
    <(kubectl kustomize examples/k3s/xl) |\n    more
```

--------------------------------

### Install Helm Diff Plugin

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes.md

Install the Helm Diff plugin to enable comparing live Kubernetes deployments with proposed Helm chart upgrades.

```sh
helm plugin install https://github.com/databus23/helm-diff
```

--------------------------------

### API Endpoint Naming Convention Update

Source: https://sourcegraph.com/docs/technical-changelog.md

REST API endpoints have been renamed to consistently use plural names. For example, `GET /.api/reviews/diagnostics/ID` replaces `GET /.api/review/diagnostic`. Refer to the OpenAPI spec for updated paths.

```text
Renamed REST API endpoints to consistently use plural names in `/.api/review**` and `/.api/tool`. For example, `GET /.api/reviews/diagnostics/ID` instead of `GET /.api/review/diagnostic`. See OpenAPI spec for updated paths. Backport 864c824e184a7dc84df694797c5603883d72ccf1 from #3028
```

--------------------------------

### Onboarding Prompt for New Team Members

Source: https://sourcegraph.com/docs/cody/prompts-guide.md

Use this prompt to provide new team members with essential information about a project, including setup instructions.

```text
@repo tell me about this project and how to set it up.
```

--------------------------------

### Manage Sourcegraph Docker Container

Source: https://sourcegraph.com/docs/self-hosted/http-https-configuration.md

Commands to stop, start, and view logs for the Sourcegraph server container during certificate setup.

```bash
docker stop $(docker ps | grep sourcegraph/server | awk '{ print $1 }')
```

```bash
docker start $(docker ps -a | grep sourcegraph/server | awk '{ print $1 }')
```

```bash
docker logs $(docker ps | grep sourcegraph/server | awk '{ print $1 }')
```

--------------------------------

### Monitor Sourcegraph Startup Script

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/digitalocean.md

Follows the output of the cloud-init startup script to monitor the installation process.

```bash
tail -f /var/log/cloud-init-output.log
```

--------------------------------

### Install Git and Clone Sourcegraph Docker Deploy Repo

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/azure.md

This script installs Git, clones the Sourcegraph Docker deployment repository, and checks out a specific revision. Ensure you replace the placeholder URL and revision with your deployment details. It also formats and mounts a persistent disk for Docker data.

```bash
#!/usr/bin/env bash
set -euxo pipefail
###############################################################################
# ACTION REQUIRED: REPLACE THE URL AND REVISION WITH YOUR DEPLOYMENT REPO INFO
###############################################################################
# Please read the notes below the script if you are cloning a private repository
DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL='https://github.com/sourcegraph/deploy-sourcegraph-docker.git'
DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION={CURRENT_VERSION}
##################### NO CHANGES REQUIRED BELOW THIS LINE #####################
DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT='/root/deploy-sourcegraph-docker'
DOCKER_COMPOSE_VERSION='1.29.2'
DOCKER_DAEMON_CONFIG_FILE='/etc/docker/daemon.json'
DOCKER_DATA_ROOT='/mnt/docker-data'
PERSISTENT_DISK_DEVICE_NAME='/dev/sdb'
PERSISTENT_DISK_LABEL='sourcegraph'
# Install git
sudo apt-get update -y
sudo apt-get install -y git
# Clone the deployment repository
git clone "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_CLONE_URL}" "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
cd "${DEPLOY_SOURCEGRAPH_DOCKER_CHECKOUT}"
git checkout "${DEPLOY_SOURCEGRAPH_DOCKER_FORK_REVISION}"
# Format (if unformatted) and then mount the attached volume
device_fs=$(sudo lsblk "${PERSISTENT_DISK_DEVICE_NAME}" --noheadings --output fsType)
if [ "${device_fs}" == "" ]
then
    sudo mkfs.ext4 -m 0 -E lazy_itable_init=0,lazy_journal_init=0,discard "${PERSISTENT_DISK_DEVICE_NAME}"
fi
sudo e2label "${PERSISTENT_DISK_DEVICE_NAME}" "${PERSISTENT_DISK_LABEL}"
sudo mkdir -p "${DOCKER_DATA_ROOT}"
sudo mount -o discard,defaults "${PERSISTENT_DISK_DEVICE_NAME}" "${DOCKER_DATA_ROOT}"
# Mount file system by label on reboot
sudo echo "LABEL=${PERSISTENT_DISK_LABEL}  ${DOCKER_DATA_ROOT}  ext4  discard,defaults,nofail  0  2" | sudo tee -a /etc/fstab
sudo umount "${DOCKER_DATA_ROOT}"
sudo mount -a

```

--------------------------------

### Compare Kustomize Overlays (Example 2)

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/operations.md

Compares diff between the new base cluster and the old cluster manifests generated by Kustomize.

```bash
$ diff \
    <(kubectl kustomize examples/base) \
    <(kubectl kustomize examples/old-cluster) |\n    more
```

--------------------------------

### Verify Sourcegraph pods

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes.md

After installation, use this command to watch the status of your Sourcegraph pods. Ensure all pods restart and show as 'Running' to confirm the upgrade has started successfully.

```sh
$ kubectl get pods --watch
```

--------------------------------

### Code Generation Prompt Example

Source: https://sourcegraph.com/docs/cody/capabilities/chat.md

Ask Cody to write code by providing a natural language description. For example, 'write a function that sorts an array in ascending order'. Cody provides suggestions that can be copied, inserted, or saved to a new file.

```plaintext
write a function that sorts an array in ascending order
```

--------------------------------

### Rebuild indexes in Docker Compose

Source: https://sourcegraph.com/docs/self-hosted/how-to/rebuild-corrupt-postgres-indexes.md

These commands are for rebuilding indexes in a Docker Compose setup. Scale down other services to prevent new connections, then start only the database container and execute psql.

```shell
export DB=pgsql # change for other databases
docker-compose down # bring all containers down
docker start $DB # bring only the db container back up
docker exec -it $DB sh
psql -U sg -d sg -h localhost -p 3333
```

--------------------------------

### Include and Exclude Repositories

Source: https://sourcegraph.com/docs/cody/capabilities/ignore-context.md

When both `include` and `exclude` rules are specified, Cody uses repositories that match `include` patterns but do not match `exclude` patterns. This example allows repositories starting with 'github.com/sourcegraph/' but excludes those containing 'cody' or named 'github.com/sourcegraph/cody-analytics'.

```json
{
	"cody.contextFilters": {
		// All repositories starting with "github.com/sourcegraph/" are allowed
		"include": [{"repoNamePattern": "^github\.com\/sourcegraph\/.+"}],
		// except for "github.com/sourcegraph/cody-analytics"
		// and the ones containing "cody" in their name.
		"exclude": [
			{
				"repoNamePattern": "^github\.com\/sourcegraph\/cody-analytics$"
			},
			{"repoNamePattern": ".*cody.*"}
		]
	}
}
```

--------------------------------

### Include Repositories by Multiple Patterns

Source: https://sourcegraph.com/docs/cody/capabilities/ignore-context.md

When only `include` rules are specified, Cody is restricted to repositories matching these patterns. This example allows repositories starting with 'github.com/sourcegraph/' or containing 'cody'. A single match in the `include` rules is sufficient for a repository to be included.

```json
{
	"cody.contextFilters": {
		// Only repositories whose names either start with "github.com/sourcegraph/"
		// or contain "cody" are allowed.
		"include": [
			{"repoNamePattern": "^github\.com\/sourcegraph\/.+"},
			{"repoNamePattern": ".*cody.*"}
		]
	}
}
```

--------------------------------

### Download and install the executor binary

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary.md

Download the specified version of the executor binary and move it to the system path.

```bash
# Plug in the version of your Sourcegraph instance, e.g. v7.5.0.
export SOURCEGRAPH_VERSION=v<target version>
curl -sfLo executor https://storage.googleapis.com/sourcegraph-artifacts/executor/${SOURCEGRAPH_VERSION}/linux-amd64/executor
chmod +x executor
# Assuming /usr/local/bin is in $PATH.
mv executor /usr/local/bin
```

--------------------------------

### Log in to Sourcegraph Instance

Source: https://sourcegraph.com/docs/batch-changes/troubleshooting.md

Use this command to ensure `src` is configured correctly with your Sourcegraph instance. Replace `sourcegraph.example.com` with your instance's URL.

```bash
src login https://sourcegraph.example.com
```

--------------------------------

### Good Example: Specific Discount Calculation Prompt

Source: https://sourcegraph.com/docs/cody/prompts-guide.md

Include clear requirements, discount tiers, and the desired function signature when asking Cody to implement logic.

```plaintext
I need to calculate discounts based on customer loyalty points.

- If the customer has loyalty points above 500, apply a 10% discount.
- If the customer has loyalty points between 200 and 500, apply a 5% discount.
- If the customer has loyalty points below 200, no discount is applied.

Create a function that takes the total amount and loyalty points as input and returns an object with the discount percentage and discount amount.
```

--------------------------------

### GET /deepsearch/v1/{conversation_id} - Get Conversation

Source: https://sourcegraph.com/docs/deep-search/api.md

Retrieves a specific conversation by its ID. Poll this endpoint to get the completed answer after creation.

```APIDOC
## GET /.api/deepsearch/v1/{conversation_id}

### Description
Retrieves a specific conversation by its ID. Poll this endpoint to get the completed answer after creation.

### Method
GET

### Endpoint
`https://your-sourcegraph-instance.com/.api/deepsearch/v1/{conversation_id}`

### Parameters
#### Path Parameters
- **conversation_id** (integer) - Required - The ID of the conversation to retrieve.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the conversation.
- **questions** (array) - A list of questions within the conversation.
  - **id** (integer) - The unique identifier for the question.
  - **conversation_id** (integer) - The ID of the conversation this question belongs to.
  - **question** (string) - The text of the question.
  - **created_at** (string) - Timestamp when the question was created.
  - **updated_at** (string) - Timestamp when the question was last updated.
  - **status** (string) - The current status of the question (e.g., 'processing', 'completed').
  - **title** (string) - The title of the answer.
  - **answer** (string) - The completed answer to the question.
  - **sources** (array) - Sources used to generate the answer.
  - **stats** (object) - Statistics related to the question processing.
  - **suggested_followups** (array) - Suggested follow-up questions.
- **created_at** (string) - Timestamp when the conversation was created.
- **updated_at** (string) - Timestamp when the conversation was last updated.
- **user_id** (integer) - The ID of the user who created the conversation.
- **read_token** (string) - A token for reading the conversation.
- **viewer** (object) - Information about the viewer.
- **quota_usage** (object) - Information about quota usage.
- **share_url** (string) - A URL to share the conversation.

#### Response Example
```json
{
	"id": 140,
	"questions": [
		{
			"id": 163,
			"conversation_id": 140,
			"question": "Does github.com/sourcegraph/sourcegraph have a README?",
			"created_at": "2025-09-24T08:14:06Z",
			"updated_at": "2025-09-24T08:14:15Z",
			"status": "completed",
			"title": "GitHub README check",
			"answer": "Yes, [github.com/sourcegraph/sourcegraph](https://sourcegraph.test:3443/github.com/sourcegraph/sourcegraph) has a [README.md](https://sourcegraph.test:3443/github.com/sourcegraph/sourcegraph/-/blob/README.md) file in the root directory.",
			"sources": [
				{
					"type": "Repository",
					"link": "/github.com/sourcegraph/sourcegraph",
					"label": "github.com/sourcegraph/sourcegraph"
				}
			],
			"stats": {
				"time_millis": 6369,
				"tool_calls": 1,
				"total_input_tokens": 13632,
				"cached_tokens": 12359,
				"cache_creation_input_tokens": 13625,
				"prompt_tokens": 11,
				"completion_tokens": 156,
				"total_tokens": 13694,
				"credits": 2
			},
			"suggested_followups": [
				"What information does the README.md file contain?",
				"Are there other important documentation files in the repository?"
			]
		}
	],
	"created_at": "2025-09-24T08:14:06Z",
	"updated_at": "2025-09-24T08:14:15Z",
	"user_id": 1,
	"read_token": "caebeb05-7755-4f89-834f-e3ee4a6acb25",
	"viewer": {"is_owner": true},
	"quota_usage": {
		"total_quota": 0,
		"quota_limit": -1,
		"reset_time": "2025-10-01T00:00:00Z"
	},
	"share_url": "https://sourcegraph.test:3443/deepsearch/caebeb05-7755-4f89-834f-e3ee4a6acb25"
}
```
```

--------------------------------

### Clone, Push, and Create Private Repository

Source: https://sourcegraph.com/docs/self-hosted/deploy/repositories.md

Clone the bare reference repository, push its contents to your private repository, and then clone your private repository locally. This process sets up your isolated deployment environment.

```bash
git clone --bare https://github.com/sourcegraph/$SG_DEPLOY_REPO_NAME
cd $DEPLOY_REPO.git
git push --mirror https://github.com/SG_DEPLOY_GITHUB_USERNAME/$SG_PRIVATE_DEPLOY_REPO_NAME.git
cd ..
rm -rf $DEPLOY_REPO.git
git clone https://github.com/SG_DEPLOY_GITHUB_USERNAME/$SG_PRIVATE_DEPLOY_REPO_NAME.git
```

--------------------------------

### Create a user account

Source: https://sourcegraph.com/docs/cli/references/users/create.md

Use this command to register a new user with a specified username and email address.

```sh
$ src users create -username=alice -email=alice@example.com
```

--------------------------------

### Install Specific Version for Sourcegraph Instance on Linux

Source: https://sourcegraph.com/docs/cli/explanations/versioning.md

Download the Sourcegraph CLI binary compatible with your specific Sourcegraph instance URL for Linux. Replace `sourcegraph.example.com` with your instance's domain.

```bash
curl -L https://sourcegraph.example.com/.api/src-cli/src_linux_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
```

--------------------------------

### Install Sourcegraph CLI for Specific Instance on Mac OS

Source: https://sourcegraph.com/docs/cli/explanations/versioning.md

Download the Sourcegraph CLI binary compatible with your specific Sourcegraph instance URL. Replace `sourcegraph.example.com` with your instance's domain.

```bash
curl -L https://sourcegraph.example.com/.api/src-cli/src_darwin_amd64 -o /usr/local/bin/src
chmod +x /usr/local/bin/src
```

--------------------------------

### Command usage syntax

Source: https://sourcegraph.com/docs/cli/references/users/create.md

General syntax for executing the user creation command.

```sh
$ src users create [options]
```

--------------------------------

### Install scip-typescript

Source: https://sourcegraph.com/docs/code-navigation/how-to/index-a-typescript-and-javascript-repository.md

Install the scip-typescript package globally using npm.

```sh
npm install -g @sourcegraph/scip-typescript
```

--------------------------------

### Downloading the service binary

Source: https://sourcegraph.com/docs/self-hosted/pprof.md

Retrieve the service binary from the pod to enable local analysis with pprof.

```bash
kubectl cp sourcegraph-frontend-xxxx:/usr/local/bin/frontend frontend-bin
```

--------------------------------

### Run Default Installation Validation

Source: https://sourcegraph.com/docs/self-hosted/validation.md

Execute `src validate install` without arguments to run the default validation checks for your Sourcegraph installation. Requires `SRC_ENDPOINT` and `SRC_ACCESS_TOKEN` environment variables.

```shell
src validate install
```

--------------------------------

### Apply Sourcegraph Kustomize Overlay

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/kustomize/eks.md

Deploys the main Sourcegraph application using the AWS EKS quick-start Kustomize overlay. Ensure all prerequisites are met before running.

```bash
kubectl apply --prune -l deploy=sourcegraph -k https://github.com/sourcegraph/deploy-sourcegraph-k8s/examples/aws
```

--------------------------------

### Install Sourcegraph CLI on Mac OS with Homebrew

Source: https://sourcegraph.com/docs/cli/explanations/versioning.md

Install the Sourcegraph CLI using Homebrew for easy management. This command installs the latest version available via the Homebrew tap.

```bash
brew install sourcegraph/src-cli/src-cli
```

--------------------------------

### Create Kustomization from Remote Resources

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/kustomize/gke.md

Initialize a local Kustomize project by pulling remote resources from a specified URL. This is useful for starting with a standard configuration.

```bash
kustomize create --resources https://github.com/sourcegraph/deploy-sourcegraph-k8s/examples/gke
```

--------------------------------

### Start the executor

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary.md

Start the executor process manually if not using a systemd service.

```bash
systemctl start executor
# OR
executor run
```

--------------------------------

### Download and install executor binary

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary.md

Download the specific version of the executor binary and move it to a directory in your system PATH.

```bash
# Plug in the version of your Sourcegraph instance, e.g. v7.4.0.
# Using latest is NOT recommended, because it might be incompatible with your Sourcegraph version.
curl -sfLo executor https://storage.googleapis.com/sourcegraph-artifacts/executor/${SOURCEGRAPH_VERSION}/linux-amd64/executor
chmod +x executor
# Assuming /usr/local/bin is in $PATH.
mv executor /usr/local/bin
```

--------------------------------

### Validate Installation with Specification File

Source: https://sourcegraph.com/docs/self-hosted/validation.md

Use `src validate install` with a YAML or JSON specification file to validate your Sourcegraph installation. Ensure the `SRC_ENDPOINT` and `SRC_ACCESS_TOKEN` environment variables are set for authentication.

```shell
src validate install validate.yaml
```

```shell
src validate install validate.json
```

--------------------------------

### Set Startup Script Version

Source: https://sourcegraph.com/docs/self-hosted/deploy/machine-images/gce.md

Paste this script into the GCE instance startup script box when launching a new instance to specify the desired Sourcegraph version.

```bash
# Replace version number to the version you are trying to upgrade to
VERSION='4.0.0'
echo $VERSION | sudo tee home/sourcegraph/.sourcegraph-version
```

--------------------------------

### Start Docker Compose Deployments

Source: https://sourcegraph.com/docs/self-hosted/how-to/upgrade-postgres-12-16-builtin-dbs.md

Bring up the specified PostgreSQL-related services after updating their images in `docker-compose.yaml`.

```bash
docker-compose up -d pgsql codeintel-db codeinsights-db
```

--------------------------------

### Install Yarn Dependencies in Subdirectory

Source: https://sourcegraph.com/docs/code-navigation/auto-indexing-configuration.md

This configuration installs Yarn dependencies in a specific subdirectory (`lib/proj`) using a Node.js Docker image. It also sets `ignore-engines` to true to bypass engine checks during installation.

```json
{
	"indexer": "node:alpine3.12@sha256:4435145...fd06fd3",
	"commands": ["yarn config set ignore-engines true", "yarn install"],
	"root": "lib/proj"
}
```

--------------------------------

### Validate executor installation

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary-offline.md

Run this command to verify the executor binary is installed and dependencies are met.

```shell
$ executor validate
```

--------------------------------

### Verify executor binary installation

Source: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary.md

Check the file size to confirm the binary was downloaded correctly.

```bash
ls -lh /usr/local/bin/executor
```

--------------------------------

### Compare Overlay with Running Cluster (Example)

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/operations.md

Compares the diff between the k3s overlay for size xl instance and the instance that is connected with `kubectl`.

```bash
$ kubectl kustomize examples/k3s/xl | kubectl diff -f  -
```

--------------------------------

### Install cert-manager

Source: https://sourcegraph.com/docs/self-hosted/how-to/setup-https.md

Install cert-manager using its official YAML manifest. This is required for automatic certificate provisioning.

```bash
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.0/cert-manager.yaml
```

--------------------------------

### Download CA Files to Local Machine

Source: https://sourcegraph.com/docs/self-hosted/ssl-https-self-signed-cert-nginx.md

Copies the root CA files from the Sourcegraph host to your local machine's mkcert directory. Replace `user` and `example.com` with your actual username and hostname.

```bash
scp user@example.com:~/.sourcegraph/config/root* "$(mkcert -CAROOT)"
```

--------------------------------

### Start Docker Compose Migrator Container

Source: https://sourcegraph.com/docs/self-hosted/updates/migrator/migrator-operations.md

Start the migrator container defined in docker-compose.yaml in detached mode.

```sh
$ docker-compose up -d migrator
```

--------------------------------

### Local: Install pgvector for PostgreSQL 12

Source: https://sourcegraph.com/docs/technical-changelog.md

Instructions for installing the pgvector extension for PostgreSQL 12 on Mac and Ubuntu.

```text
Mac: install pgvector from sourcegraph/pgvector-12
```

```text
Ubuntu: install postgresql-12-pgvector
```

--------------------------------

### Example Code Host Configuration

Source: https://sourcegraph.com/docs/self-hosted/advanced-config-file.md

This JSONC structure defines configurations for multiple code hosts, including GitHub and generic Git hosts. It demonstrates how to specify repositories and authentication details.

```jsonc
{
  "GITHUB": [
    {
      // First GitHub code host configuration: literally the JSON object from the code host config editor.
      "authorization": {},
      "url": "https://github.com",
      "token": "...",
      "repositoryQuery": ["affiliated"]
    },
    {
      // Another GitHub code host configuration.
      ...
    },
  ],
  "OTHER": [
    {
      // First "Generic Git host" code host configuration.
      "url": "https://mycodehost.example.com/repos",
      "repos": ["foo"],
    }
  ],
  "PHABRICATOR": [
    {
      // Phabricator code host configuration.
      ...
    },
  ]
}
```

--------------------------------

### Query worker sync start rate

Source: https://sourcegraph.com/docs/self-hosted/observability/dashboards.md

Measures the rate of sync starts for the Syncer.SyncExternalService family over a 9-hour window.

```PromQL
max by (family) (rate(src_repoupdater_syncer_start_sync{family="Syncer.SyncExternalService"}[9h0m0s]))
```

--------------------------------

### GraphQL API Response Example

Source: https://sourcegraph.com/docs/api/graphql.md

This is an example of a successful JSON response from the GraphQL API when querying for the current user.

```json
{"data": {"currentUser": {"username": "YOUR_USERNAME"}}}
```

--------------------------------

### Rendered Run Command Example 1

Source: https://sourcegraph.com/docs/batch-changes/batch-spec-templating.md

This shows the final `run` command after `repository.search_result_paths` is replaced with actual file paths, demonstrating how templating dynamically targets specific files for the `comby` tool.

```yaml
run: comby -in-place 'fmt.Sprintf("%d", :[v])' 'strconv.Itoa(:[v])' cmd/src/main.go internal/fmt/fmt.go
```

--------------------------------

### Use Compressed File List in Comparison

Source: https://sourcegraph.com/docs/code-search/compare-file-filtering.md

Example URL demonstrating the use of a `compressedFileList` parameter for including a large number of files in the comparison.

```bash
 ?compressedFileList=H4sIAAAAAAAAA2NgYGBg...
```

--------------------------------

### Configuring GitHub Apps Declaratively

Source: https://sourcegraph.com/docs/self-hosted/advanced-config-file.md

This JSONC snippet shows how to configure GitHub Apps directly within the `EXTSVC_CONFIG_FILE`. It requires `clientID` and `privateKey` within the `gitHubAppDetails` object for full declarative setup.

```jsonc
{
	"GITHUB": [
		{
			"url": "https://github.com",
			"gitHubAppDetails": {
				"appID": 12345,
				"installationID": 67890,
				"clientID": "Iv1.abc123def456",
				"privateKey": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"
			},
			"repositoryQuery": ["affiliated"]
		}
	]
}
```

--------------------------------

### Prune inactive users examples

Source: https://sourcegraph.com/docs/cli/references/users/prune.md

Basic usage examples for removing users based on inactivity duration or specific account criteria.

```sh
$ src users prune -days 182
```

```sh
$ src users prune -remove-admin -remove-null-users
```

--------------------------------

### TLS Secret Output Example

Source: https://sourcegraph.com/docs/admin/deploy/kubernetes/configure

Example of a generated Kubernetes Secret resource for TLS, containing encoded certificate and key data.

```yaml
# cluster.yaml - output file after running build
apiVersion: v1
kind: Secret
type: kubernetes.io/tls
metadata:
    name: sourcegraph-frontend-tls-99dh8g92m5
    namespace: $YOUR_NAMESPACE
data:
    tls.crt: |
        LS...FUlRJRklDQVRFLS0tLS0=
    tls.key: |
        LS...SSVZBVEUgS0VZLS0tLS0=

# the data is abbreviated in this example
```

--------------------------------

### Kustomization file for Sourcegraph deployment

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/kustomize/gke.md

Example kustomization.yaml for creating a custom overlay. This file defines resources, namespaces, sizes, and cluster-specific configurations.

```yaml
# overlays/$INSTANCE_NAME/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: ns-sourcegraph
resources:
    # Deploy Sourcegraph main stack
    - ../../base/sourcegraph
    # Deploy Sourcegraph monitoring stack
    - ../../base/monitoring
components:
    # Create a namespace for ns-sourcegraph
    - ../../components/resources/namespace
    # Use resources for a size-XS instance
    - ../../components/sizes/xs
    # Apply configurations for GKE
    - ../../components/clusters/gke/configure
```

--------------------------------

### Rendered Run Command Example 2

Source: https://sourcegraph.com/docs/batch-changes/batch-spec-templating.md

This illustrates the `run` command for `goimports` after `previous_step.modified_files` is substituted with the list of files modified by the preceding `comby` step.

```yaml
run: goimports -w cmd/src/main.go internal/fmt/fmt.go
```

--------------------------------

### Install Docker CE on Ubuntu

Source: https://sourcegraph.com/docs/self-hosted/deploy/docker-compose/azure.md

Installs Docker Community Edition and related packages on an Ubuntu system. Ensure your system is up-to-date before proceeding.

```bash
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo apt-get update -y
sudo apt-get install -y software-properties-common
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
sudo apt-get update -y
apt-cache policy docker-ce
apt-get install -y docker-ce docker-ce-cli containerd.io
```

--------------------------------

### Install Specific Version with Homebrew

Source: https://sourcegraph.com/docs/cli/explanations/versioning.md

Install a specific version of the Sourcegraph CLI using Homebrew. Replace `{CURRENT_VERSION_NO_V}` with the desired version number.

```bash
brew install sourcegraph/src-cli/src-cli@{CURRENT_VERSION_NO_V}
```

--------------------------------

### Compare Kustomize Overlays

Source: https://sourcegraph.com/docs/self-hosted/deploy/kubernetes/operations.md

Compares the Kubernetes resources generated by two different Kustomize overlays. This helps in reviewing changes before applying them.

```bash
$ diff \
    <(kubectl kustomize $PATH_TO_OVERLAY_1) \
    <(kubectl kustomize $PATH_TO_OVERLAY_2) |\n    more
```
Tokens:
Raw