Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Update Documentation to Highlight Pro-Tier Tool Availability#171

Closed
aravindputrevu wants to merge4 commits intomainfrompro-tier-message
Closed
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletionsdocs/guides/ondemand-reports.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
---
title: On-demand Reports
sidebar_label: On-demand Reports (Beta)
sidebar_label: On-demand Reports
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
sidebar_position: 6
---
Expand All@@ -9,19 +9,17 @@ sidebar_position: 6
import ReportSchema from "@site/src/components/ReportSchema";
```

:::info

This feature is in beta
CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
You will need an API Key to access the CodeRabbit API and generate an on-demand report.

:::note
Reports are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
You will need an API Key to access the CodeRabbit API and generate an on-demand report.

## Create an API key

Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar.
Click on the **Create API Key** button and enter a name for the API Key.
Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar.
Click on the **Create API Key** button and enter a name for the API Key.
Copy the API key, and keep it safe as it won't be visible again.

![API Keys](/img/guides/api_keys.png)
Expand Down
4 changes: 4 additions & 0 deletionsdocs/integrations/knowledge-base.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,10 @@ sidebar_position: 4

CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Issues

The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/actionlint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Actionlint.
[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
GitHub Actions workflow files.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

We look for `GitHub Action` files specifically in the following directory:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/biome.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Biome.

[Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Biome will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/buf.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Buf.

[Buf](https://buf.build/) offers linting for Protobuf files.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Buf will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/checkov.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Checkov.

[Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Checkov will run on files with the following files and extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/circleci.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to CircleCi.

[CircleCi](https://circleci.com/) is a static checker and validator for circleci config files.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

We look for `CircleCi Configuration` files specifically in the following directory:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/cppcheck.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Cppcheck.

[Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Cppcheck will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/detekt.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Detekt.

[Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Detekt will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/eslint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ESLint.

[ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

ESLint will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/gitleaks.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Gitleaks.

[Gitleaks](https://gitleaks.io/) is a secret-scanner.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Gitleaks will run on all files.
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/golangci-lint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to golangci-lint.

[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

golangci-lint will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/hadolint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Hadolint.

[Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Hadolint will run on files with the following file names:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/languagetool.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to LanguageTool.

[LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

LanguageTool will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/markdownlint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Markdownlint.

[Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Markdownlint will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/phpstan.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PHPStan.

[PHPStan](https://phpstan.org/) is a static analysis tool for PHP.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

PHPStan will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/pmd.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to PMD.

[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

PMD will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/regal.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Regal.

[Regal](https://docs.styra.com/regal/) is a linter and language server for Rego.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Regal will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/rubocop.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Rubocop.

[Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Rubocop will run on the following files and extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/ruff.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Ruff.

[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.

:::note
Tools are available under[Pro-tier](https://coderabbit.ai/pricing).
:::

##Files

Ruff will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/semgrep.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,10 @@ description: CodeRabbit's guide to Semgrep.
[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code
for security vulnerabilities and code quality issues.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Configuration

Semgrep uses a YAML style configuration file. By default we will automatically
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/shellcheck.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to ShellCheck.

[ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

ShellCheck will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/swiftlint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to SwiftLint.

[SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

SwiftLint will run on files with the following extensions:
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/tools.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,10 @@ sidebar_position: 1

CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Enabling/Disabling Tools

You can enable or disable tools by setting `reviews.tools.<tool>.enabled` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Tool → Enabled" field in CodeRabbit's settings page.
Expand Down
4 changes: 4 additions & 0 deletionsdocs/tools/yamllint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ description: CodeRabbit's guide to Yamllint.

[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.

:::note
Tools are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

## Files

Yamllint will run on files with the following extensions:
Expand Down
2 changes: 1 addition & 1 deletiondocusaurus.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -211,7 +211,7 @@ const config: Config = {
position: "right",
},
{
href: "https://github.com/coderabbitai",
href: "https://github.com/coderabbitai/coderabbit-docs",
className: "github-link",
"aria-label": "GitHub",
position: "right",
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp