CLI
CLI Tutorials
Copy page
Learn how to use the Inkeep CLI for common workflows
The Inkeep CLI is your primary tool for managing agents, syncing configurations, and deploying to Inkeep Cloud. These tutorials 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 cloud push/pull)
Push to Inkeep Cloud
Push your local agent configurations to Inkeep Cloud
Pull from Inkeep Cloud
Pull agent configurations from Inkeep Cloud to your local project
Prerequisites
Before starting these tutorials, ensure you have:
- The Inkeep CLI installed globally:
- Access to Inkeep Cloud or a self-hosted deployment
Quick reference
For a complete list of CLI commands and options, see the CLI Reference.