Skip to content

docs: add interactive merge conflict resolution UI documentation for inkeep pull #2862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
inkeep wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add interactive merge conflict resolution UI documentation for inkeep pull #2862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e066bc0
docs: add merge conflict resolution section to pull-from-remote guide
inkeep[bot] Mar 27, 2026
2eb95c5
docs: add merge conflict resolution UI section to inkeep pull CLI ref…
inkeep[bot] Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions agents-docs/content/guides/cli/pull-from-remote.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,16 @@ If validation passes, you'll see:

Review the generated files to confirm they look correct. If validation fails, the CLI reports specific differences so you can investigate.

## Resolving merge conflicts

When pulling into an existing project, conflicts can occur if both you and a teammate modified the same agent, tool, or configuration. Instead of silently overwriting your local changes, the CLI presents an interactive merge conflict resolution UI.

For each conflict, you can choose to keep your local version, accept the remote version, or manually merge the two. The CLI highlights the differences side by side so you can make an informed decision before any files are written.

<Tip>
If you want to skip conflict resolution and always accept the remote version, use `inkeep pull --introspect` to do a full regeneration from the remote configuration.
</Tip>

## Step 4: Use the pulled project

Once pulled, your project is a standard TypeScript project using `@inkeep/agents-sdk` builder APIs. You can:
Expand Down
11 changes: 11 additions & 0 deletions agents-docs/content/typescript-sdk/cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,17 @@ By default, the pull command updates your existing TypeScript files using LLM ge
2. **Selective Updates**: Only updates relevant parts based on server configuration changes
3. **File-Specific Context**: Each file type receives appropriate context (Agents get Agent data, Sub Agents get Sub Agent data, etc.)


#### Merge Conflict Resolution

When local and remote changes conflict, the CLI presents an interactive merge conflict resolution UI. For each conflicting file, you can:

- **Keep local** — preserve your local version of the file
- **Accept remote** — overwrite with the server version
- **Manually merge** — review a side-by-side diff and choose which changes to keep

This ensures your local customizations aren't silently overwritten when pulling updates from the server.

**Examples:**

```bash
Expand Down