cr-asst

English | 中文

Review your code changes with AI assistants.

Usage

CLI

Print Help

npx cr-asst -h

Code Review

COMMAND_TO_GET_CODE_DIFFS | npx cr-asst --model gpt-4 --api-key sk-xxx
# for example:
git log -p master.. | npx cr-asst --model gpt-4 --api-key sk-xxx

If cr-asst is executed directly, it defaults to get code diffs from the latest git commit, except for package-lock.json, pnpm-lock.yaml and yarn.lock.

API

import { codeReview } from 'cr-asst';

const { content } = await codeReview({
  diffs: 'CODE_DIFFS', // or `diffsCmd: 'COMMAND_TO_GET_CODE_DIFFS'`
  model: 'gpt-4',
  apiKey: 'sk-xxx',
  // other options...
});

See CodeReviewOptions for more details.

Output Example

expand

# Overall Changes

1. Extracted the completion logic into a separate file (`completion.ts`) to improve modularity and reusability.
2. Removed the `dryRun` option from `CodeReviewOptions` and updated related code.
3. Renamed `inputTokens` and `outputTokens` to `promptTokens` and `completionTokens` respectively to align with OpenAI's terminology.
4. Updated test files and snapshots to reflect the changes in token naming and the removal of the `dryRun` option.

# Overall Review Comments

1. The refactoring improves code organization by separating concerns, making the codebase easier to maintain and extend.
2. The removal of the `dryRun` option simplifies the API, though it may impact testing. Ensure that alternative testing strategies are in place.

# File-wise Review

1. `src/code_review/completion.ts`

   1. Added a new file to handle the creation and reading of completion streams. This improves modularity by encapsulating the completion logic in a single place.

2. `src/code_review/index.ts`

   1. Updated the `codeReview` function to use the new `createCompletion` function, simplifying the main logic and removing redundant code.
   2. Removed the `dryRun` option and related logic, making the function more straightforward.

3. `src/code_review/test/__snapshots__/utils.test.ts.snap`

   1. Updated the snapshot to reflect the renaming of `inputTokens` and `outputTokens` to `promptTokens` and `completionTokens`.

4. `src/code_review/test/index.test.ts`

   1. Deleted the test file since it was specific to the `dryRun` option, which has been removed.

5. `src/code_review/test/utils.test.ts`

   1. Updated the test cases to use the new token naming conventions (`promptTokens` and `completionTokens`).

6. `src/code_review/utils.ts`

   1. Updated the utility functions to use the new `CompletionUsage` and `CompletionStats` types, aligning with the changes in the completion logic.

7. `src/types.ts`

   1. Removed the `dryRun` option from `CodeReviewOptions`.
   2. Updated the `CodeReviewResult` type to use `CompletionStats` and `CompletionUsage` from the new `completion.ts` file, ensuring type consistency across the codebase.

Custom Prompt

You can use your custom prompt file by specifying the --prompt-file option. The custom prompt file should include $DIFFS, which cr-asst will replace with the actual code diffs during execution.

Here is a simple example of a custom prompt file:

Please review the following code changes and provide your review comments:

```diff
$DIFFS
```

Environment Variables (CLI Only)

cr-asst reads the following environment variables:

Environment Variable	Description
CR_MODEL	AI model to use for review.
CR_API_KEY	API key for the AI service.
CR_BASE_URL	Base URL for the AI service API.
CR_DIFFS_CMD	Command to get code diffs for review.
CR_OUTPUT_FILE	Save review result to file.
CR_PROMPT_FILE	Path to a custom prompt file, or a builtin prompt (options: en, zh-cn).
CR_PRINT	Print review result to stdout.
CR_PRINT_REASONING	Print reasoning to stdout (only available for models that support reasoning_content field).
CR_PRINT_DEBUG	Print debug information to stdout.

Moreover, cr-asst CLI uses dotenv to load environment variables from .env file in the current working directory.

Integrating with GitHub Actions

You can use cr-asst-action to integrate cr-asst with Github Actions.

License

MIT License © 2025-PRESENT mys1024