Checkpoints

Checkpoints automatically preserve snapshots of your workspace after each step in a task. This capability enables you to track changes, revert when necessary, and experiment confidently with your code.

How Checkpoints Work

Sypha generates a checkpoint after each tool use (file edits, commands, etc.). These checkpoints:

• Function alongside your Git workflow without interference
• Preserve context between restores
• Utilize a shadow Git repository to track changes

For instance, if you're developing a feature and Sypha makes multiple file changes, each change generates a checkpoint. This allows you to review each modification and, if required, revert to any point without impacting your main Git repository.

Viewing Changes & Restoring

After each tool use, you can:

1. Select the "Compare" button to view modified files
2. Select the "Restore" button to access restore options

Restore Options

To revert to a previous point:

1. Select the "Restore" button next to any step
2. Choose from three options:
   • Restore Task and Workspace: Reset both codebase and task to that point
   • Restore Task Only: Retain codebase changes but revert task context
   • Restore Workspace Only: Reset codebase while maintaining task context

Example: If Sypha implements changes you dislike while styling a component, you can use "Restore Workspace Only" to revert the code changes while retaining the conversation context, enabling you to attempt a different approach.

Use Cases

Checkpoints enable you to be more experimental with Sypha. While human coding is often methodical and iterative, AI can implement substantial changes rapidly. Checkpoints assist you in tracking these changes and reverting if necessary.

Using Auto-Approve Mode

• Offers safety net for rapid iterations
• Simplifies undoing unexpected results

Testing Different Approaches

• Attempt multiple solutions confidently
• Compare different implementations
• Swiftly revert to working states
• Ideal for exploring different design patterns or architectural approaches

Best Practices

1. Utilize checkpoints as safety nets when experimenting
2. Leverage auto-approve mode more confidently, knowing you can always revert
3. Restore selectively based on requirements:
   • Employ "Restore Task and Workspace" for a fresh start
   • Employ "Restore Task Only" to try different prompts while keeping file changes
   • Employ "Restore Workspace Only" to attempt different implementations while maintaining conversation context

Relationship with Message Editing

The message editing feature employs checkpoints under the hood when you select the "Restore All" option. This permits you to not only edit and resubmit your message but also restore your workspace to the state it was in at that conversation point.

Deleting Checkpoints

You can remove all checkpoints by using the "Delete All History" button in the task history menu. Note that this will also delete all tasks. Checkpoints are stored in VS Code's globalStorage.