Set up a CLI profile

Note

Profile setup is only required when pushing or pulling to a remote deployment (Inkeep Cloud or a self-hosted instance). If you're pushing or pulling locally, you can skip this step.

A CLI profile tells the CLI where to connect and how to authenticate with a remote deployment. This tutorial walks you through creating a profile and logging in.

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 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.

Step 2: Set the active profile

Set the profile you created as the active profile:

inkeep profile use <profile-name>

Confirm which profile is active:

inkeep profile current

Step 3: Log in

Authenticate with your active profile:

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.

Managing multiple profiles

You can create profiles for different environments and switch between them:

inkeep profile add staging
inkeep profile use staging
inkeep login

To authenticate a specific profile without switching:

inkeep login --profile staging

To remove a profile you no longer need:

inkeep profile remove staging

For a full list of profile commands, see the CLI Reference.

What's next

Push to Cloud

Push local agent configurations to Inkeep Cloud

Pull from Cloud

Pull agent configurations from Inkeep Cloud to your local project