Greptile

https://www.greptile.com/docs/
Admin
Greptile is an AI code review agent that automatically reviews every pull request with a complete,...
Tokens:93,970
Snippets:1,056
Trust Score:9.6
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Manual onboarding and review commands

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Manual onboarding and review workflow. Run the three commands from your repository root to install the CLI, navigate to your repo, and start the onboarding wizard. After setup finishes, run `greptile review` to review your code.

```bash
npm i -g greptile@latest
cd path/to/your/repo
greptile onboard

```

```bash
greptile review

```

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

### Create .greptile/config.json with review settings

Source: https://www.greptile.com/docs/code-review/greptile-config

Start with review settings in .greptile/config.json. Fields are the same as the legacy greptile.json format. This example sets strictness to 2 and comment types to logic and syntax.

```json
{
  "strictness": 2,
  "commentTypes": ["logic", "syntax"]
}
```

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

### Install systemd services for auto-start

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Installs and enables systemd services for automatic startup on boot. Copies service and timer files, reloads systemd, then enables and starts the greptile-hatchet and greptile-app services.

```bash
sudo cp systemd/*.service /etc/systemd/system/
sudo cp systemd/*.timer /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable greptile-hatchet greptile-app
sudo systemctl start greptile-hatchet greptile-app

```

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

### Start Greptile

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Starts the Greptile services.

```bash
./bin/start-greptile.sh

```

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

### Install Greptile plugin

Source: https://www.greptile.com/docs/integrations/claude-code

Installs the Greptile plugin from the marketplace. Choose an installation scope (user, project, or local) when prompted.

```bash
/plugin install greptile@greptile-claude-plugin
```

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

### Install the Greptile plugin

Source: https://www.greptile.com/docs/integrations/codex

Installs the Greptile plugin, which includes Greptile MCP and the login and review skills. Start a new Codex task after installation.

```bash
codex plugin add greptile@greptile-plugin

```

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

### Verify the installation

Source: https://www.greptile.com/docs/integrations/codex

Verifies the installation by listing marketplaces and plugins. Confirm the greptile-plugin marketplace and the enabled greptile plugin are listed.

```bash
codex plugin marketplace list
codex plugin list

```

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

### Install Greptile CLI via npm, Homebrew, or script

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Installation methods for the Greptile CLI: npm, Homebrew, and a curl install script. Choose the method that matches your environment.

```bash
npm i -g greptile@latest

```

```bash
brew install greptileai/tap/greptile

```

```bash
curl -fsSL https://raw.githubusercontent.com/greptileai/cli/main/install.sh | bash

```

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

### Copy Caddyfile example

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Copies the example Caddyfile to the active configuration file before editing.

```bash
cp Caddyfile.example Caddyfile

```

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

### Test Greptile MCP server

Source: https://www.greptile.com/docs/integrations/claude-code

Example natural-language command to test the Greptile MCP server after installation.

```text
Use Greptile to list my open pull requests.
```

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

### Full greptile.json configuration example

Source: https://www.greptile.com/docs/code-review/custom-standards

Full greptile.json configuration example. Includes review behavior settings, custom standards, pattern repositories for cross-repo context, and ignore patterns as a newline-separated string.

```json
{
  // Review behavior
  "strictness": 2,
  "commentTypes": ["logic", "syntax", "style"],
  
  // Custom standards
  "customContext": {
    "rules": [
      {
        "rule": "No direct database queries in controllers",
        "scope": ["src/controllers/**/*.ts"]
      }
    ],
    "files": [
      {
        "path": "docs/architecture.md",
        "description": "System architecture guidelines"
      }
    ]
  },
  
  // Pattern repositories (cross-repo context)
  "patternRepositories": ["company/shared-standards"],
  
  // Ignore patterns (newline-separated string)
  "ignorePatterns": "*.generated.*\n**/vendor/**\n**/__snapshots__/**"
}

```

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

### Install Greptile CLI with Install Script

Source: https://www.greptile.com/docs/code-review/greptile-cli

Installs the Greptile CLI using the official install script. Requires Node.js 22 or newer.

```bash
curl -fsSL https://raw.githubusercontent.com/greptileai/cli/main/install.sh | bash
```

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

### Install Greptile CLI with Homebrew

Source: https://www.greptile.com/docs/code-review/greptile-cli

Installs the Greptile CLI via Homebrew.

```bash
brew install greptileai/tap/greptile
```

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

### Custom rules configuration example

Source: https://www.greptile.com/docs/code-review/custom-standards

Complete configuration example showing only custom rules. Each rule uses a glob scope to target specific files or directories.

```json
{
  "customContext": {
    "rules": [
      {
        "rule": "Use dependency injection for all services",
        "scope": ["src/services/**/*.ts"]
      },
      {
        "rule": "API endpoints must have rate limiting",
        "scope": ["**/api/**/*.ts"]
      },
      {
        "rule": "Test files must use .test.ts extension",
        "scope": ["src/**/*"]
      }
    ]
  }
}

```

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

### Cross-repository context configuration example

Source: https://www.greptile.com/docs/code-review/greptile-config-reference

Example configuration for specifying related repositories to read during reviews. Each entry must be in owner/repo format, on the same SCM host, and accessible with the same credentials.

```json
{
  "context": {
    "repos": ["acme/shared-types", "acme/payment-sdk"]
  }
}
```

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

### Complete .greptile/config.json example

Source: https://www.greptile.com/docs/code-review/greptile-config-reference

A full configuration example for Greptile. It includes structured rules with optional id, scope, and severity. The first rule has an id so it can be disabled by child configs; the second rule has no id and applies everywhere.

```json
{
  "strictness": 2,
  "commentTypes": ["logic", "syntax"],
  "autoReview": ["open", "push", "rebase"],
  "ignorePatterns": "**/*.generated.*\ndist/**\nnode_modules/**",
  "summarySection": {
    "included": true,
    "collapsible": true,
    "defaultOpen": false
  },
  "context": {
    "repos": ["acme/shared-types", "acme/payment-sdk"]
  },
  "instructions": "This is a TypeScript monorepo using pnpm workspaces. We use Prisma for database access and zod for validation.",
  "rules": [
    {
      "id": "no-console",
      "rule": "Do not use console.log in production code. Use the logger service instead.",
      "scope": ["src/**"],
      "severity": "medium"
    },
    {
      "rule": "All async functions must have error handling.",
      "severity": "high"
    }
  ],
  "disabledRules": []
}
```

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

### Codex OAuth setup: add, login, and verify Greptile MCP

Source: https://www.greptile.com/docs/mcp-v2/setup

Add the Greptile MCP server to Codex, start OAuth explicitly with `codex mcp login greptile`, and verify with `codex mcp list` followed by asking Codex to list custom context rules. In the Codex IDE extension, open MCP servers, select Greptile, then select Authenticate. A successful result confirms authentication.

```bash
codex mcp add greptile --url https://api.greptile.com/mcp

```

```bash
codex mcp login greptile

```

```bash
codex mcp list

```

```text
List my Greptile custom context rules.

```

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

### Troubleshoot services not starting

Source: https://www.greptile.com/docs/docker-compose/aws-terraform

Troubleshoot services not starting by checking systemd logs, container status, and Docker Compose logs.

```bash
sudo journalctl -u greptile-app -f
docker compose ps
docker compose logs

```

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

### Install Hatchet workflow orchestration

Source: https://www.greptile.com/docs/kubernetes-new

Installs Hatchet, the workflow orchestration system, before bootstrapping Greptile so the next step can mint a client token automatically. Adds the Hatchet Helm repository and installs the stack with the provided values file.

```bash
helm repo add hatchet https://hatchet-dev.github.io/hatchet-charts
helm upgrade --install hatchet-stack hatchet/hatchet-stack \
  -f ./charts/profiles/hatchet-values.yaml

```

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

### Install Greptile CLI with npm

Source: https://www.greptile.com/docs/code-review/greptile-cli

Installs the Greptile CLI globally via npm. Requires Node.js 22 or newer.

```bash
npm install -g greptile@latest
```

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

### files.json example

Source: https://www.greptile.com/docs/code-review/greptile-config-reference

Example configuration for .greptile/files.json. Files without a scope are included in every review; files with a scope are only included when the reviewed file matches one of the glob patterns. File references accumulate from parent configs.

```json
{
  "files": [
    {
      "path": "prisma/schema.prisma",
      "description": "Database schema — reference for model relationships and field types"
    },
    {
      "path": "docs/api-contracts.yaml",
      "description": "OpenAPI specification for all public endpoints",
      "scope": ["src/api/**"]
    },
    {
      "path": "docs/auth-flow.md",
      "description": "Authentication and authorization flow documentation",
      "scope": ["src/auth/**", "src/middleware/auth*"]
    }
  ]
}
```

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

### Troubleshoot services not starting

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Troubleshooting commands when services won't start: validate the compose file, check service logs, and verify the Docker daemon status.

```bash
docker compose config          # Validate compose file
docker compose logs <service>  # Check specific service logs
sudo systemctl status docker   # Check Docker daemon

```

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

### Install Greptile skills via git clone or submodule

Source: https://www.greptile.com/docs/mcp-v2/skills

Clone the Greptile skills repository into the Claude Code skills directory, or add it as a submodule in your project. Both commands install the skills for use with Claude Code.

```bash
git clone https://github.com/greptileai/skills.git ~/.claude/skills/greptile

```

```bash
git submodule add https://github.com/greptileai/skills.git .skills/greptile

```

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

### Run onboarding wizard from repo root

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Run the onboarding wizard from your repository root. The wizard scans your checkout for AI rules files; running it from your home directory silently finds nothing. If not signed in, the wizard opens your browser for sign-in.

```bash
cd path/to/your/repo
greptile onboard

```

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

### Learning Examples: Style Comments Get Filtered vs Critical Issues Always Surface

Source: https://www.greptile.com/docs/how-greptile-works/nitpicks

Illustrates that Greptile always comments on security risks like missing input validation, but stops commenting on style issues like missing semicolons after learning the team ignores them.

```javascript
// Greptile will ALWAYS comment on this (even if team ignores style):
function transferMoney(amount, account) {
  // No input validation - SECURITY RISK
  database.transfer(amount, account);
}

// But stops commenting on this after learning:
const user = getUser()  // Missing semicolon - but team doesn't care
```

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

### Copy terraform.tfvars.example to terraform.tfvars

Source: https://www.greptile.com/docs/docker-compose/aws-terraform

Create the Terraform configuration file from the example template.

```bash
cp terraform.tfvars.example terraform.tfvars

```

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

### Install ingress-nginx controller

Source: https://www.greptile.com/docs/kubernetes-new

Installs the ingress-nginx controller, required once per cluster. Adds the Helm repository, updates it, and installs the controller in the ingress-nginx namespace.

```bash
helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx
helm repo update
helm upgrade --install nginx-ingress ingress-nginx/ingress-nginx \
  -n ingress-nginx --create-namespace

```

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

### Initialize and deploy Terraform stack

Source: https://www.greptile.com/docs/docker-compose/aws-terraform

Initialize Terraform, review the plan, and apply the configuration. Deployment takes 10-15 minutes.

```bash
terraform init
terraform plan    # Review what will be created
terraform apply   # Type 'yes' to confirm

```

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

### VS Code OAuth setup: add Greptile MCP server and sign in

Source: https://www.greptile.com/docs/mcp-v2/setup

In VS Code, add the Greptile MCP server via the Command Palette (MCP: Add Server), choose HTTP, enter `https://api.greptile.com/mcp`, and select Global or Workspace. Then ask VS Code to list custom context rules; on the first protected tool call, follow the browser prompt to sign in. A successful `list_custom_context` result confirms authentication, while a Running status in MCP: List Servers only confirms discovery. The equivalent `mcp.json` entry is shown.

```text
List my Greptile custom context rules.

```

```json
{
  "servers": {
    "greptile": {
      "type": "http",
      "url": "https://api.greptile.com/mcp"
    }
  }
}

```

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

### Add context files in .greptile/files.json

Source: https://www.greptile.com/docs/code-review/greptile-config

Optional: point the reviewer to files it should reference. This example lists a file with its path and description.

```json
{
  "files": [
    { "path": "docs/architecture.md", "description": "System architecture overview" }
  ]
}
```

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

### Get all comments with fixes

Source: https://www.greptile.com/docs/mcp-v2/auto-fix

Prompt to get all comments with fixes. The assistant filters for hasSuggestion: true.

```text
List all Greptile comments on PR #5 that have suggested code fixes
```

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

### Start Hatchet

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Starts the Hatchet service. Wait approximately 30 seconds for Hatchet to become healthy.

```bash
./bin/start-hatchet.sh

```

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

### Get comments for specific file

Source: https://www.greptile.com/docs/mcp-v2/auto-fix

Prompt to get comments for a specific file. Filters results by filePath.

```text
Show Greptile comments for src/auth/login.ts
```

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

### Agent prompt for onboarding

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Copy this prompt into a coding agent to onboard to Greptile. The agent reads the playbook, runs machine steps, stops for browser/interactive steps, asks for the organization name, and finishes with a review.

```text
Onboard me to Greptile. Read the agent playbook at
https://www.greptile.com/docs/code-review/cli-onboarding and follow it exactly.

Work in the git repository I currently have open.

Run the machine steps yourself. When you reach a step that needs my browser
or an interactive terminal, stop, print the exact command or URL I need, and
wait for me to confirm before continuing. Do not guess my organization name —
ask me.

Finish by running a review on my current branch and summarizing the findings.

```

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

### Install Greptile Bridge CLI

Source: https://www.greptile.com/docs/integrations/fix-with-your-agent

Installs the Greptile Bridge CLI globally. Required for Fix with your Agent to route fix requests from GitHub to your local agent. After installation, the dashboard shows a green checkmark with 'Greptile bridge app connected'.

```bash
npm install -g greptile
```

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

### Copy the environment template

Source: https://www.greptile.com/docs/docker-compose/manual-setup

Copies the .env.example file to .env, which must be edited with required values as described in the Configuration section.

```bash
cp .env.example .env

```

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

### Check and upgrade Greptile version

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Check your installed version and upgrade if it is below 3.2.0. The `onboard` command shipped in v3.2.0, so you need at least that version.

```bash
greptile --version

```

```bash
npm i -g greptile@latest   # or: brew upgrade greptile

```

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

### Verify Greptile plugin installation

Source: https://www.greptile.com/docs/integrations/claude-code

Verifies the Greptile plugin is installed and enabled, and that the greptile MCP server is connected.

```bash
/plugin
```

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

### Onboarding completion output

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Expected output after onboarding completes. It confirms the number of repositories added and AI-rules files imported. Your 14-day free trial starts here; no payment method is required.

```text
Greptile is ready to review your first PR!
  1 repo added
  2 AI-rules files imported

```

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

### Verify ingress controller installation

Source: https://www.greptile.com/docs/kubernetes-new

Verifies that an nginx ingress class and the controller service exist after installing the ingress controller.

```bash
kubectl get ingressclass
kubectl get pods,svc -n ingress-nginx

```

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

### Claude Code OAuth setup: add, login, and verify Greptile MCP

Source: https://www.greptile.com/docs/mcp-v2/setup

Add the Greptile MCP server to Claude Code, start OAuth explicitly with `claude mcp login greptile`, and verify with `claude mcp list` followed by asking Claude to list custom context rules. For SSH or headless sessions, use `claude mcp login greptile --no-browser` and paste the final redirect URL. A successful result confirms authentication.

```bash
claude mcp add --transport http greptile https://api.greptile.com/mcp

```

```bash
claude mcp login greptile

```

```bash
claude mcp list

```

```text
List my Greptile custom context rules.

```

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

### Configure values.user.yaml

Source: https://www.greptile.com/docs/kubernetes-new

Example values.user.yaml configuration. Set the values the bootstrap script can't infer: registry, tag, network URLs, GitHub app details, and provider/integration secrets. See values.user.example.yaml for the annotated template and values.yaml for every available key.

```yaml
global:
  registry: "<REGISTRY_FROM_GREPTILE>"
  tag: "<IMAGE_TAG>"
  imagePullSecrets:
    - name: regcred

network:
  appUrl: "https://greptile.yourcompany.com"
  webhookUrl: "https://greptile.yourcompany.com/webhook"

github:
  appId: "123456"
  appUrl: "https://github.com/apps/your-greptile-app"

secrets:
  mode: native
  native:
    # Auto-filled by init-values.sh; only fill the provider/integration keys.
    ANTHROPIC_KEY: "sk-ant-..."
    GITHUB_WEBHOOK_SECRET: "your-webhook-secret"
    WEBHOOK_SECRET: "your-webhook-secret"
    GITHUB_PRIVATE_KEY: "-----BEGIN RSA PRIVATE KEY-----..."
    GITHUB_CLIENT_ID: "Iv1.xxx"
    GITHUB_CLIENT_SECRET: "xxx"

ingress:
  enabled: true
  className: nginx

```

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

### Run first review with --agent

Source: https://www.greptile.com/docs/code-review/cli-onboarding

Run the first review with the agent flag.

```bash
greptile review --agent
```

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

### Specific rule for API error responses

Source: https://www.greptile.com/docs/code-review/custom-standards

Example rule that specifies a detailed requirement with an example. Using specific rules improves detection accuracy.

```json
{
  "rule": "API error responses must include: status (number), message (string), timestamp (ISO 8601), requestId (UUID)",
  "scope": ["**/api/**"]
}
```

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

### Sign in to Greptile CLI

Source: https://www.greptile.com/docs/code-review/greptile-cli

Signs in once on each device.

```bash
greptile login
```
Tokens:
Raw