CLI
CLI Tutorials
Copy page
Learn how to use the Inkeep CLI for common workflows
The Inkeep CLI is your primary tool for managing your Inkeep agents and MCP servers. These guides walk you through common CLI workflows.
What you'll learn
Set Up a CLI Profile
Create a profile and authenticate with a remote deployment (only needed for remote push/pull)
Push to Remote
Push your local agent configurations to remote Inkeep instance
Pull from Remote
Pull agent configurations from remote Inkeep instance to your local project
Prerequisites
Before starting these tutorials, ensure you have:
- The Inkeep CLI installed globally:
- Access to a remote Inkeep instance (e.g. Inkeep Enterprise or a self-hosted deployment)
Quick reference
For a complete list of CLI commands and options, see the CLI Reference.