Development preview · These guides describe unreleased source code.
This page is not available in the selected version. Start with its overview below.
Run your first ticket
By the end of this walkthrough, an agent will have made a small change in its own worktree, and you will have reviewed and merged it. First complete installation and agent setup.
1. Choose a repository
Section titled “1. Choose a repository”Enter an existing Git repository with at least one commit. Use a clean primary checkout on the branch where you want to receive the change.
cd /path/to/your/repositorygit status --shortgit branch --show-currentCommit or set aside your existing work before continuing. The example below asks for a documentation change so its scope is easy to inspect.
2. Describe a small task
Section titled “2. Describe a small task”dg ticketThis opens your editor. Use the first line as the ticket title, then add any additional details below it. For example:
Document local development
Add a Local development section to README.md.Use the repository's existing build and test commands, and check themagainst the project configuration. Keep the change limited todocumentation; do not change application code.Save and close the editor to create the ticket. dg ticket prints its ID and triggers scheduling: when the queue is unpaused and has capacity, an agent starts automatically. You do not need to leave the inbox open.
3. Read the inbox
Section titled “3. Read the inbox”dgRun dg again to see current state. The ticket moves from QUEUED to RUNNING, then to READY when the agent reports a commit.
If it stays queued or fails, use the troubleshooting guide before creating another ticket.
4. Review the proposed change
Section titled “4. Review the proposed change”Once the ticket is READY, inspect it:
dg showWithout an ID, dg show defaults to the first ready ticket for the current project. It shows the branch, worktree, session, dependencies, and run history.
From your primary checkout, compare the ticket’s branch with your current branch. The inline command selects the branch of the first ready ticket automatically:
git diff HEAD...$(dg show --branch-only)Read the full diff to review the agent’s work. If you want to make changes yourself, open the ticket’s worktree:
cd $(dg show --worktree-only)You can edit files and run tests there. Commit your changes, then return to your primary checkout before merging.
More substantial changes needed? See continue the agent session.
5. Merge, then accept
Section titled “5. Merge, then accept”From your primary checkout, merge the branch after review:
git merge $(dg show --branch-only)dg acceptdgLike dg show, dg accept without an ID selects the first ready ticket for the current project. If you have several ready tickets, make sure it is the one you just reviewed and merged, or supply its ID explicitly.
If Git reports conflicts, resolve and complete the merge before accepting. dg accept verifies the branch is incorporated into the project’s current HEAD and that its worktree can be removed, marks the ticket DONE, and removes that worktree. It also starts eligible queued work when capacity is available.
You have completed the full workflow. Next, learn to write tickets with useful acceptance criteria or link a sequence of changes.