Push to Inkeep Cloud

This tutorial walks you through pushing agent configurations to Inkeep Cloud. You'll learn how to set up a CLI profile, authenticate with your Inkeep Cloud account, and push changes made in the Visual Builder.

Prerequisites

Access to Inkeep Cloud or a self-hosted deployment
The Inkeep CLI installed globally:

npm install -g @inkeep/agents-cli

Step 1: Create a cloud profile

Profiles let you manage multiple environments (cloud, local, staging) from the same CLI. Create a profile for Inkeep Cloud:

inkeep profile add <profile-name>

The CLI prompts you to configure the profile:

Remote type: Select Custom
Agents API URL: Enter the URL of your agents API
Manage UI URL: Enter the URL of your manage UI
Environment name: Enter production (or your preferred name)

Tip

You can verify the profile was created by running inkeep profile list.

Switch to your cloud profile

Set the cloud profile as your active profile:

inkeep profile use cloud

You can confirm which profile is active:

inkeep profile current

Step 2: Log in

Authenticate:

inkeep login

The CLI will:

Open your browser to the Inkeep authentication page
Display a device code (e.g., ABCD-1234)
Wait for you to complete authentication in the browser

Once authenticated, you'll see confirmation:

✓ Logged in as you@example.com
✓ Organization: Your Organization
✓ Profile: cloud

Note

Your credentials are securely stored in your system keychain. You only need to log in once per profile.

Step 3: Push changes to Inkeep Cloud

After making changes in the Visual Builder or in code, push them to Inkeep Cloud.

Push from a project directory

Navigate to your project directory and run:

cd my-project
inkeep push