Back to Home

User Guide

How to use CodeCritic

1. Getting Started

To use CodeCritic, you need an account. You can sign up in two ways:

  • Email and password: Register with your email address and create a password.
  • OAuth: Sign in with GitHub, Google, or Twitter for quick access.

After registration, you can log in anytime from the homepage. Make sure to agree to our Terms of Service and Privacy Policy when creating your account.

2. Code Review via Web Interface

The simplest way to get a code review is through the web interface:

  1. Go to New Review (you must be logged in).
  2. Paste your code into the editor or type it directly.
  3. Optionally add a title to help identify the review later.
  4. Language is auto-detected by default; you can change it if needed.
  5. Click "Submit for Review" and wait 5–30 seconds for the analysis.
  6. You will be redirected to the review details page when complete.

Each review consumes credits from your subscription or pay-per-use balance. Check your usage in the Dashboard before submitting.

3. Understanding Review Results

After a review completes, you will see:

  • Quality score (0–100): An overall assessment of your code.
  • Categories: Feedback grouped by type (bugs, security, style, performance, etc.).
  • Issues and suggestions: Specific recommendations with explanations.

You can view all your past reviews in the Dashboard under the "Reviews" tab. Click any review to see its full details.

4. GitHub Action Integration

CodeCritic can automatically review pull requests via a GitHub Action. Here is how to set it up:

  1. Get your API key from the Dashboard (Settings tab → API Key section).
  2. In your GitHub repository, go to Settings → Secrets and variables → Actions.
  3. Add a new secret named CODECRITIC_API_KEY with your API key.
  4. Create .github/workflows/codecritic.yml with the following content:
name: CodeCritic Review
on:
  pull_request:
    types: [opened, synchronize]
  workflow_dispatch:

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: CodeCritic-Reviews/review-action@v1
        with:
          api_key: ${{ secrets.CODECRITIC_API_KEY }}

When you open or update a pull request, the action will run and post the review as a comment. Key inputs you can customize:

  • api_url - API endpoint (default: https://api.code-critic.com)
  • wait_for_completion - Wait for review to finish (default: true)
  • post_comment - Post results as PR comment (default: true)
  • timeout - Max wait time in seconds (default: 600)

5. Billing and Subscriptions

CodeCritic offers subscription plans and pay-per-use credits:

  • Plans: Free, Professional, and Enterprise tiers with different review limits per month.
  • Pay-per-use: Purchase additional credits when you exceed your plan limit. Enable this in Settings.
  • Billing: Manage your subscription and payment methods on the Billing page.
  • Transactions: View payment history and credit usage on the Transactions page.

6. Settings

In the Dashboard, open the "Settings" tab to:

  • View or regenerate your API key for GitHub Action and API access.
  • Enable or disable pay-per-use reviews.
  • Manage notification preferences.
  • Configure two-factor authentication (2FA) for extra security.

7. Support

If you need help or have questions:

Privacy Policy|Terms of Service|Home