Push to remote Inkeep instance

This tutorial walks you through pushing agent configurations to a remote Inkeep instance.

Prerequisites

• Access to a remote Inkeep instance (e.g. Inkeep Enterprise or a self-hosted deployment)
• The Inkeep CLI installed globally:

npm install -g @inkeep/agents-cli

• A CLI profile configured and authenticated (only needed for remote deployments). If you haven't done this yet, follow the Set up a CLI profile tutorial.

Step 1: Navigate to your project

Navigate to your project directory. A project directory contains an index.ts file that exports a project definition:

cd my-project

Step 2: Push to remote Inkeep instance

Run the push command:

inkeep push

The CLI will:

1. Detect the project from your index.ts file
2. Resolve configuration — your active CLI profile overrides inkeep.config.ts for API URLs, API key, and tenant ID (see Configuration Priority)
3. Check for conflicts between your local state and remote
4. Push all agents, tools, and configurations to remote Inkeep instance

Handling conflicts

If the remote instance has changed since your last pull, the CLI detects conflicts and aborts the push.

To resolve conflicts, run inkeep pull first — the interactive merge UI walks you through each conflict. Then push again.

To skip conflict detection and overwrite the remote state:

inkeep push --force

Step 3: Verify the push

After a successful push, the CLI prints a deployment summary with resource counts. You can also verify by opening the Visual Builder to see your updated configurations.

Push all projects at once

If you have multiple projects in a workspace, push them all:

inkeep push --all

What's next