Help Center/ CodeArts Agent/ User Guide (IDE)/ Agents/ Checkpoints
Updated on 2026-07-29 GMT+08:00
View PDF
Share

Checkpoints

Checkpoint is a built-in mechanism that enables CodeArts Agent to automatically take snapshots of code status and allow for rollback. The system will automatically track the editing operations when the agent is running. Before every time that the agent modifies code, the system will automatically save the current code and chat status for quick cancellation, rollback, and historical version recovery. This function is applicable to AI-assisted development scenarios that require quick trial-and-error, secure editing, and one-click rollback.

Constraints

Table 1 Constraints

Category

Description

Time

Checkpoints are valid for 15 days and will be automatically cleared upon expiration. Once they expire, the rollback button will no longer be displayed, and historical versions cannot be restored.

Model

This feature is available only when Agent or a custom agent is selected.

File size and type

Checkpoints do not track binary files such as images, videos, archives, EXEs, and PDFs, and they ignore text files exceeding 10 MB. For text files larger than 2 MB, a diff view will not be available during version rollback previews.

Function
  • The system automatically generates a checkpoint before each AI edit, tracking only file modifications made by AI editing tools within the current chat.
  • File modifications made via Bash commands or external editors will not be tracked.
  • AI modifications made to the same file across multiple chats are consolidated into that file's checkpoint. Modifications to different files are isolated from each other. However, manual modifications by users or changes made by other software are not tracked by the system and will not trigger checkpoint generation.
  • Checkpoints are designed to quickly undo or roll back modifications within the current chat, which is temporary recovery. They are not a substitute for professional version control systems like Git.
  • For files outside the project, checkpoints only support rolling back the chat content, not the file content.

Automatic Tracking

The automatic tracking capabilities of CodeArts Agent are as follows:

  • Tracking all edits: Modifications made by AI file editors are automatically tracked.
  • Creating checkpoints based on prompts: Each time a user submits a prompt, the system creates a checkpoint before AI edits, recording the current code state.
  • Persistence: Users can choose to restore their code to a specific checkpoint within historical chats. Each checkpoint remains valid for 15 days.

Rolling Back a Chat

  1. Log in to CodeArts Agent IDE as instructed in Quick Start.
  2. At the bottom of the input box on the chat panel, choose Built-in > Agent to switch to the agent mode. The selected model is displayed on the right. You can select a model as required from the drop-down list.

    If the chat panel of CodeArts Agent is not displayed, click (Expand AI Sidebar) in the upper right corner of the top menu bar to open it.

  3. On the chat panel of CodeArts Agent, roll back a chat.

    The rollback operation cannot be undone. Exercise caution when performing this operation.

    Rolling Back a Specified Chat in Historical Chats

    1. Click in the upper right corner.
    2. Click the name of the chat to be rolled back.
    3. Hover the cursor over the chat to be rolled back, and click . A confirmation dialog box is displayed.
      • If a file is modified, the name of the file to be restored is displayed.
      • If no file is modified, no file information is displayed.
      Figure 1 Confirmation dialog box for restoration (files modified)
      Figure 2 Confirmation dialog box for restoration (no files modified)
    4. (Optional) If files have been modified, click the name of the file you want to restore to open the diff view before and after the rollback in the editor area.
      Figure 3 Diff view
    5. Click OK to roll back the chat.
      • If files have been modified, they will be rolled back to their historical states, and the messages at and after this timestamp in the current chat will disappear.
      • If no files have been modified, the messages at and after this timestamp in the current chat will disappear.

    Rolling Back the Current Chat

    1. Hover the cursor over the chat to be rolled back, and click . A confirmation dialog box is displayed.
      • If a file is modified, the name of the file to be restored is displayed.
      • If no file is modified, no file information is displayed.
      Figure 4 Confirmation dialog box for restoration (files modified)
      Figure 5 Confirmation dialog box for restoration (no files modified)
    2. (Optional) If files have been modified, click the name of the file you want to restore to open the diff view before and after the rollback in the editor area.
      Figure 6 Diff view
    3. Click OK to roll back the chat.
      • If files have been modified, they will be rolled back to their historical states, and the messages at and after this timestamp in the current chat will disappear.
      • If no files have been modified, the messages at and after this timestamp in the current chat will disappear.

Related Documents

If you need an end-to-end example of checkpoints, see Best Practices for Checkpoint Session Rollback. This practice uses a lightweight coffee ordering system to demonstrate checkpoint capabilities during chatting, including status archiving, precise rollback, and UI restoration.

Parent Topic: Agents