Skip to content

Developer CLI for AgenticGoKit - scaffolding, tracing, and debugging AI agent workflows

License

Notifications You must be signed in to change notification settings

AgenticGoKit/agk

Repository files navigation

AGK - AgenticGoKit CLI

The Unified Toolchain for Agentic AI Systems

AGK is the official CLI for AgenticGoKit, designed to manage the entire lifecycle of intelligent agents. From scaffolding new projects to distributing templates and observing production workflows, AGK provides a standardized interface for building the next generation of AI software.

Version License Status


Vision: The Complete Lifecycle

AGK aims to streamline the developer experience across four key pillars:

  1. Create: Scaffold powerful agents instantly using a rich registry of templates.
  2. Distribute: (Planned) Share your agent architectures and workflows with the community or your team.
  3. Deploy: (Planned) Seamlessly ship agents to cloud platforms, Kubernetes, or edge devices.
  4. Trace: Gain deep observability into your agent's reasoning, prompts, and performance.

Quick Start

1. Installation

# Build from source
cd agk
go build -o agk main.go

2. Create Your First Agent

# Initialize a new project with the quickstart template
./agk init my-agent --template quickstart --llm openai

# Navigate to the project
cd my-agent

# Install dependencies
go mod tidy

3. Run It

# Set your API key
export OPENAI_API_KEY=sk-...

# Run the agent
go run main.go

Templates & Registry

AGK features a powerful template system that lets you use both built-in and community-created templates. Explore the Official Template Registry.

Use a Template

./agk init enterprise-bot --template workflow --llm anthropic

Manage Templates

Bring in templates from GitHub, local folders, or other sources.

# List all available templates (built-in + cached)
agk template list

# Add a template from a remote source
agk template add github.com/username/my-template

# Remove a cached template
agk template remove my-template

Want to build your own? Check out the Creating Templates Guide.

Built-in Templates

Template Best For Description
Quickstart Learning Minimal setup. Single file. Hardcoded config. Perfect for understanding the basics.
Workflow Pipelines Multi-step workflow (e.g. Sequential, Parallel) structure.

Run agk init --list to see all available templates including those from the registry.

Example usage:

./agk init enterprise-bot --template workflow --llm anthropic

🔍 Trace Auditor

AGK includes a powerful Trace Auditor to help you understand exactly what your agents are thinking.

1. Capture Traces

Control data granularity with AGK_TRACE_LEVEL:

Level Data Captured Use Case
minimal Timing, status Production monitoring
standard + Tokens, latency General debugging
detailed + Prompts, responses, tool args Deep evaluation & auditing
# Enable detailed tracing to see prompts and thoughts
$env:AGK_TRACE="true"
$env:AGK_TRACE_LEVEL="detailed"
go run main.go

2. Analyze Traces

Interactive Viewer (TUI) Browse traces, explore spans, and view content details.

agk trace view
# Tip: Press 'd' on a span to see the full Prompt & Response content!

Audit Report (JSON) Export structured data for automated evaluation pipelines.

agk trace audit > evaluation_dataset.json

Visual Flowchart (Mermaid) Generate a diagram of the agent's execution path.

agk trace mermaid > trace_flow.md

🛠️ Commands

Command Description
init Create a new project from a template.
init --list Show details of all available templates.
trace list List all captured trace runs.
trace show Display summary of a specific run.
trace view Open the interactive TUI trace explorer.
trace audit Analyze a trace for reasoning quality.
trace export Export trace data (OTEL, Jaeger, JSON).

Roadmap

Completed

  • Template Registry System (list, add, remove)
  • Smart Scaffolding (Quickstart, Workflow bases)
  • Trace Auditor (Interactive TUI & Mermaid export)
  • Streaming Support (Native across all templates)

In Progress

  • Multi-Agent Templates
  • Advanced Full-Stack Templates

Planned

  • Template Distribution (pack, push)
  • Cloud Deployment Engine (agk deploy)
  • Workflow Visualization (Interactive graph editor)
  • Interactive Init Wizard (agk init -i)
  • MCP Server Management
  • RAG & Knowledge Base Management

🤝 Contributing

We love contributions! Please read CONTRIBUTING.md for guidelines.

� License

Apache 2.0 - See LICENSE.


Built with ❤️ for the AgenticGoKit community