Back to home

Docs

User guideget productive fast

How to use CodeCritic from sign-up to GitHub Action.

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 X for quick access.

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

2. Code review in the app

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

  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. Submit and wait for analysis to finish.
  6. You will be redirected to the review details page when complete.

Each review consumes credits according to your plan or pay-per-use settings. Check usage in the Dashboard before submitting.

3. Understanding results

After a review completes, you will typically see:

  • Quality score (0–100): An overall read on the submission.
  • Categories: Feedback grouped by type (bugs, security, style, performance, and so on).
  • Issues and suggestions: Specific items with explanations and, where applicable, suggested code.

Past reviews appear in the Dashboard under Reviews. Open any row for full detail.

4. GitHub Action

CodeCritic can review pull requests via a GitHub Action. Setup at a high level:

  1. Copy your API key from the Dashboard (Settings → API key).
  2. In the repo: Settings → Secrets and variables → Actions.
  3. Add a secret named CODECRITIC_API_KEY with your key.
  4. Add .github/workflows/codecritic.yml with content like:
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 workflow runs and can post the review as a comment. Common inputs:

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

5. Billing and usage

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

  • Plans: Tiers with different monthly review limits. See Pricing for current options.
  • Pay-per-use: Extra credits when you exceed plan limits, where enabled in Settings.
  • Billing: Subscription and payment methods on the Billing page.
  • Transactions: History on the Transactions page.

6. Settings

In the Dashboard, open Settings to:

  • View or regenerate your API key (Action and API access).
  • Enable or disable pay-per-use, where available.
  • Manage notification preferences.
  • Configure two-factor authentication (2FA).

7. Support

If you need help: