Basic Workflows
Learn the basic workflows for using Sculptor. This guide covers how to start tasks, review an agent's changes, merge new code, and resolve merge conflicts.
Creating agents
On your projects homepage, describe your task to the agent.
Press “Start task” or CMD+Enter to start the task. Press Enter to start a new line in your task description.
Your new agent will appear in the sidebar. Click into it to see the changes as the agent works.
When you’re viewing an agent’s task, you can press the + New Agent button or CMD+N to quickly create a new agent.
Note: for now, your first agent will take about a minute to start. We're working on making it instant!
Testing the agent’s changes
Each agent runs in a safe container with a copy of your repo. Their branch lives in the container. Pairing Mode lets you bring an agent's branch into your IDE so you can instantly test its changes, while it sees your edits in real-time. When you turn it on, it checks out the agent's branch locally and keep your files + git state synced.
Click the Pairing Mode button in the sidebar or the top right corner to turn it on
Run the agent’s code, run terminal commands, make edits in your IDE, or keep working with the agent in chat while in Pairing Mode. Any local changes you make will sync back to the agent’s branch and persist after turning off Pairing Mode.
Note: Currently Pairing Mode will be disabled if you have uncommitted or unstashed changes in your current local branch. Stash or commit changes to enable Pairing Mode using git stash --include-untracked.
Merging the agent’s changes
Turn off Pairing Mode to switch your local state back to where it was.
Commit the agent’s changes in Sculptor.
Press the Merge button in the top right corner, select your target branch, and pull the agent’s changes.
For power users: you can also commit and merge the agent's changes locally while Pairing Mode is on using git commit on the branch, checking out the target branch, and git merge <source-branch>.
Resolving merge conflicts
If you expect merge conflicts, the agent can help you resolve them!
Push your target branch to the agent’s branch using the Merge panel.
Tell the agent to resolve any merge conflicts that arise.
After it’s done, merge the agent branch into your target branch as described in the last section (Merging the agent’s changes).
If you try merging the agent's branch into your target branch, and merge conflicts arise, you will see this dialog. Choose whether to force merge or abort if there are conflicts that can’t be resolved.
Last updated