Skip to main content
Like AOF? Give us a star!
If you find AOF useful, please star us on GitHub. It helps us reach more developers and grow the community.

aofctl CLI Reference

Complete command reference for the AOF CLI tool.

Command Structure​

aofctl follows a verb-first pattern (like kubectl):

aofctl <verb> <resource_type> [name] [flags]

Available Commands​

CommandDescriptionStatus
runRun an agent or workflow✅ Implemented
getGet/list resources✅ Implemented
applyApply configuration from file✅ Implemented
deleteDelete resources✅ Implemented
describeDescribe resources in detail✅ Implemented
logsGet logs from a resource✅ Implemented
execExecute a command in a resource✅ Implemented
api-resourcesList available API resources✅ Implemented
versionShow version information✅ Implemented
serveStart the trigger webhook server (daemon mode)✅ Implemented

Note: Fleet, Flow, Config, and Completion commands are planned for future releases.

apply​

Apply configuration from a YAML file.

aofctl apply -f <file> [flags]

Flags:

  • -f, --file string - Path to YAML file (required)
  • -n, --namespace string - Namespace for resources

Examples:

# Apply agent configuration
aofctl apply -f my-agent.yaml

# Apply with namespace
aofctl apply -f my-agent.yaml -n production

get​

List or retrieve resources.

aofctl get <resource_type> [name] [flags]

Flags:

  • -o, --output string - Output format: json|yaml|wide|name (default: wide)
  • --all-namespaces - Show resources across all namespaces

Examples:

# List all agents
aofctl get agent

# Get specific agent
aofctl get agent my-agent

# Get as YAML
aofctl get agent my-agent -o yaml

# All namespaces
aofctl get agent --all-namespaces

Output:

NAME              MODEL           STATUS    AGE
k8s-helper        google:gemini-2.5-flash    Running   5d
slack-bot         anthropic:claude-3-5-sonnet-20241022   Running   2d
incident-responder google:gemini-2.5-flash   Running   1d

describe​

Show detailed information about a resource.

aofctl describe <resource_type> <name> [flags]

Flags:

  • -n, --namespace string - Namespace

Examples:

aofctl describe agent my-agent

Output:

Name:         my-agent
Namespace:    default
Labels:       env=production
              team=platform
Annotations:  owner=platform@company.com
Created:      2024-01-15 10:30:00

Spec:
  Model:              google:gemini-2.5-flash
  Temperature:        0.3
  Max Tokens:         2000

Tools:
  - Type: Shell
    Commands: kubectl, helm
  - Type: MCP
    Server: kubectl-mcp

Memory:
  Type: SQLite
  Path: ./agent-memory.db
  Messages: 150/1000

Status:
  State:              Running
  Last Activity:      2024-01-20 14:45:00
  Total Executions:   234
  Success Rate:       98.7%
  Avg Response Time:  2.3s

Recent Conversations:
  2024-01-20 14:45:00  User: Show me failing pods
  2024-01-20 14:30:12  User: Scale nginx to 5 replicas
  2024-01-20 14:15:00  User: What's the status of the cluster?

run​

Run an agent or workflow.

aofctl run <resource_type> <name_or_file> [flags]

Flags:

  • -i, --input string - Input/query for the agent
  • -o, --output string - Output format: json|yaml|text (default: text)

Examples:

# Interactive mode
aofctl run agent my-agent.yaml

# With query
aofctl run agent my-agent.yaml -i "Show me all pods"

# Run workflow
aofctl run workflow incident-response.yaml

Example Output:

$ aofctl run agent k8s-helper.yaml --input "Show me all pods"

Agent: k8s-helper
Result: Here are the pods in the default namespace:

NAME                        READY   STATUS    RESTARTS   AGE
nginx-deployment-abc123     2/2     Running   0          5d
postgres-0                  1/1     Running   0          10d

All pods are healthy!

exec​

Execute a command in a resource.

aofctl exec <resource_type> <name> [command...] [flags]

Examples:

# Execute command
aofctl exec agent k8s-helper -- kubectl get pods

delete​

Delete a resource.

aofctl delete <resource_type> <name> [flags]

Flags:

  • -n, --namespace string - Namespace

Examples:

# Delete agent
aofctl delete agent my-agent

logs​

View resource logs.

aofctl logs <resource_type> <name> [flags]

Flags:

  • -f, --follow - Stream logs in real-time
  • --tail int - Number of recent lines

Examples:

# View recent logs
aofctl logs agent my-agent

# Follow logs
aofctl logs agent my-agent -f

# Last 50 lines
aofctl logs agent my-agent --tail 50

serve​

Start the trigger webhook server (daemon mode) for running agents as a service.

aofctl serve [flags]

Flags:

  • -c, --config string - Configuration file (YAML)
  • -p, --port int - Port to listen on (overrides config)
  • --host string - Host to bind to (default: 0.0.0.0)
  • --agents-dir string - Directory containing agent YAML files

Examples:

# Start server with default settings
aofctl serve

# Serve with custom port and agents directory
aofctl serve --port 8080 --agents-dir ./agents

# Use a configuration file
aofctl serve -c daemon-config.yaml

Utility Commands​

aofctl version​

Show version information.

aofctl version

Output:

aofctl version: 0.1.11
aof-core version: 0.1.11
MCP version: 2024-11-05

Fleet & Flow Commands​

AOF uses kubectl-style verb-noun syntax for all commands.

Fleet Commands​

AgentFleet enables multi-agent coordination:

# List all fleets
aofctl get fleets

# Get specific fleet
aofctl get fleet my-fleet

# Describe fleet (from file)
aofctl describe fleet my-fleet.yaml

# Run a fleet with input
aofctl run fleet my-fleet.yaml -i '{"query": "analyze data"}'

# Delete a fleet
aofctl delete fleet my-fleet

Flow Commands​

AgentFlow enables workflow orchestration:

# List all flows
aofctl get flows

# Get specific flow
aofctl get flow my-flow

# Describe flow (from file)
aofctl describe flow my-flow.yaml

# Run a flow
aofctl run flow my-flow.yaml -i '{"input": "value"}'

# Delete a flow
aofctl delete flow my-flow

Completion​

Generate shell completion scripts:

# Bash
aofctl completion bash > /etc/bash_completion.d/aofctl

# Zsh
aofctl completion zsh > ~/.zsh/completion/_aofctl

# Fish
aofctl completion fish > ~/.config/fish/completions/aofctl.fish

# PowerShell
aofctl completion powershell > aofctl.ps1

Config Commands (Coming Soon)​

  • aofctl config view - Display current config
  • aofctl config set-context - Set current context
  • aofctl config get-contexts - List available contexts

Environment Variables​

VariableDescriptionDefault
OPENAI_API_KEYOpenAI API key-
ANTHROPIC_API_KEYAnthropic API key-
GOOGLE_API_KEYGoogle Gemini API key-
GROQ_API_KEYGroq API key-
KUBECONFIGKubernetes config path~/.kube/config

Examples​

Complete Workflow​

# 1. Create agent
cat > my-agent.yaml <<EOF
apiVersion: aof.dev/v1
kind: Agent
metadata:
  name: k8s-helper
spec:
  model: google:gemini-2.5-flash
  instructions: "You are a K8s expert. Help users with kubectl commands."
  tools:
    - shell
EOF

# 2. Run the agent
aofctl run agent my-agent.yaml --input "Show me all pods"

# 3. Run with JSON output
aofctl run agent my-agent.yaml --input "Check deployment status" --output json

# 4. List available agents
aofctl get agent

# 5. Describe agent details
aofctl describe agent k8s-helper

Start as Daemon Service​

# Start the server with agents directory
aofctl serve --agents-dir ./agents --port 8080

# The server will expose agents via HTTP API
# Agents can be triggered via webhooks

See Also​