Skip to content

CLI Quick Reference

Navigation: Documentation HomeReferenceCLI Quick Reference

Quick reference for the most commonly used AgenticGoKit CLI commands.

Project Creation

bash
# Research assistant with web search
agentcli create research-bot --template research-assistant

# RAG knowledge base
agentcli create knowledge-base --template rag-system

# Data processing pipeline
agentcli create data-flow --template data-pipeline

# Chat system with memory
agentcli create chat-bot --template chat-system

# Basic multi-agent system
agentcli create my-project --template basic

Custom Configuration

bash
# Custom RAG system
agentcli create my-kb --memory pgvector --embedding openai --rag 1500

# Production MCP setup
agentcli create my-bot --mcp production --visualize

# Interactive setup
agentcli create --interactive

Template Overrides

bash
# Use template but customize
agentcli create my-research --template research-assistant --agents 5 --mcp production

Template Management

bash
# List all templates
agentcli template list

# Create custom template
agentcli template create my-template

# Validate template
agentcli template validate my-template.yaml

# Show search paths
agentcli template paths

Consolidated Flags

FlagDescriptionExamples
--template, -tProject templatebasic, research-assistant, rag-system
--memoryMemory providermemory, pgvector, weaviate
--embeddingEmbedding provideropenai, ollama:nomic-embed-text
--mcpMCP integrationbasic, production, full
--ragRAG chunk sizedefault, 1000, 2000
--orchestrationAgent coordinationsequential, collaborative, loop
--agents, -aNumber of agents2, 3, 5
--provider, -pLLM provideropenai, azure, ollama
--visualizeGenerate diagrams(boolean flag)
--interactive, -iInteractive mode(boolean flag)

Built-in Templates

TemplateDescriptionUse Case
basic2 agents, sequentialLearning, simple projects
research-assistant3 agents, web searchResearch, analysis
rag-system3 agents, vector DBKnowledge bases, Q&A
data-pipeline4 agents, sequentialETL, data processing
chat-system2 agents, memoryChatbots, conversations

Other Commands

bash
# Version info
agentcli version

# List sessions
agentcli list

# View traces
agentcli trace session-id

# Memory debug
agentcli memory --stats

# MCP management
agentcli mcp servers

# Cache management
agentcli cache stats

# Shell completion
agentcli completion bash > /etc/bash_completion.d/agentcli
agentcli completion zsh > "${fpath[1]}/_agentcli"
agentcli completion powershell > agentcli.ps1

Common Patterns

Development Setup

bash
# Quick development project
agentcli create dev-project --template basic --provider mock

Production Setup

bash
# Production-ready RAG system
agentcli create prod-kb --template rag-system --mcp production --visualize

Research Workflow

bash
# Research assistant with custom agents
agentcli create research-team --template research-assistant --agents 4

Data Processing

bash
# ETL pipeline with visualization
agentcli create etl-system --template data-pipeline --visualize

Help Commands

bash
# General help
agentcli --help

# Command-specific help
agentcli create --help
agentcli template --help

# Template details
agentcli create help-templates
agentcli template list

Shell Completion

Enable intelligent tab completion for faster CLI usage:

Bash

bash
# Load for current session
source <(agentcli completion bash)

# Install permanently (Linux)
agentcli completion bash > /etc/bash_completion.d/agentcli

# Install permanently (macOS with Homebrew)
agentcli completion bash > $(brew --prefix)/etc/bash_completion.d/agentcli

Zsh

bash
# Enable completion support
echo "autoload -U compinit; compinit" >> ~/.zshrc

# Install completion
agentcli completion zsh > "${fpath[1]}/_agentcli"

PowerShell

powershell
# Load for current session
agentcli completion powershell | Out-String | Invoke-Expression

# Install permanently
agentcli completion powershell > agentcli.ps1
# Add to your PowerShell profile

Fish

bash
# Load for current session
agentcli completion fish | source

# Install permanently
agentcli completion fish > ~/.config/fish/completions/agentcli.fish

For complete documentation, see the Full CLI Reference.

Released under the Apache 2.0 License.