Agentctl

module
v0.0.22 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 4, 2026 License: MIT

README

AgentCTL

The CLI binary is m for ergonomics — the product name is AgentCTL.

A small, single-binary CLI for running AI agents defined as Markdown files against your choice of LLM. Aimed at developers and DevOps people who live in the terminal and want to script agentic work without IDE lock-in or SDK sprawl.

Current version: v0.0.21 | Go version: 1.26+ | Binary size: ~7.8 MB | Docker image: ~16 MB

Status: alpha. ~1 month of evenings of work. Works for the author's daily use, but expect breaking changes until v0.1.0. Tagged releases (v0.0.1v0.0.21) ship as macOS .pkg and Linux .deb.

$ m
» fix the failing test in api/handler.go
→ fs_read   api/handler.go
→ shell     go test ./api/...
→ fs_write  api/handler.go   (patch: nil check)
  Overwrite api/handler.go? [y/N]: y
→ shell     go test ./api/...
  PASS
→ git       commit -m "fix: nil check in handler"

Full docs site (EN + SR): https://subzone.github.io/Agentctl/


Quick Start (5 minutes)

# 1. Install (macOS — pick one)
brew tap subzone/tap && brew install subzone/tap/m
# or: curl -sL https://github.com/subzone/Agentctl/releases/latest/download/m_0.0.21_macos.pkg -o m.pkg && sudo installer -pkg m.pkg -target /

# 2. Run the setup wizard
m
# Pick Ollama (free, local) or paste an API key for Anthropic/OpenAI/Gemini/Alibaba

# 3. Your first chat (with Steva Đubre fixing himself!)
» help me fix the failing test in internal/engine/engine_test.go
→ fs_read   internal/engine/engine_test.go
→ shell     go test ./internal/engine/...
→ fs_write  internal/engine/engine_test.go (patch: add nil check)
  Overwrite? [y/N]: y
→ shell     go test ./internal/engine/...
  PASS
→ git       commit -m "fix: nil check in engine test"

# 4. Slash commands
» /help          # show available commands
» /reset         # clear history
» /undo          # revert last fs_write
» /model ollama/qwen3-coder  # switch model mid-session
» /exit          # leave

# 5. Run a specific agent
m run examples/agents/devops.md "review the Dockerfile"
m chat examples/agents/coder.md

Why this exists

  • Agents are files, not config — define an agent as a Markdown file with YAML frontmatter, version it in git alongside your code, share it like any other source file.
  • No LLM SDK dependencies — every provider client is plain net/http + encoding/json. The build won't break when a vendor SDK changes.
  • CLI-first, IDE-agnostic — pipes, scripts, cron, CI all work because it's a normal binary that reads stdin and writes stdout.
  • Plays well with existing toolingkubectl, terraform, helm, git, make are reachable through the shell tool. Not a replacement for Cursor or Claude Code; a complementary tool for terminal-driven dev/DevOps work.

Install

Platform How
macOS (Homebrew) brew tap subzone/tap && brew install subzone/tap/m
macOS (pkg) Download .pkg from latest release → double-click. Installs to /usr/local/bin/m.
Linux (Debian/Ubuntu) sudo dpkg -i m_*_linux_amd64.deb
Linux (other) Tarball: tar -xzf m_*_linux_amd64.tar.gz && sudo mv m /usr/local/bin/
From source go install github.com/subzone/Agentctl/cmd/m@latest (requires Go 1.26+)

First run launches a setup wizard:

m
# Pick a provider (Ollama / Anthropic / OpenAI / Gemini / Alibaba / LiteLLM)
# Paste an API key (or skip for Ollama)
# Done — drops you into a chat with the default agent

API keys are stored in the OS keychain (macOS Keychain / Linux libsecret). Never in config files, never in plaintext.

API key fallback

If you don't want to use the keychain (or secret-tool isn't installed on Linux), you can set API keys via environment variables instead:

export ANTHROPIC_API_KEY=sk-ant-...
export OPENAI_API_KEY=sk-...
export GEMINI_API_KEY=...
export DASHSCOPE_API_KEY=...  # Alibaba
export LITELLM_API_KEY=...

The CLI checks keychain first, then falls back to the environment variable. This works for both the main m command and for model discovery (m config scan).


Defining an agent

A complete agent is one Markdown file:

---
name: devops
type: agent
model: anthropic/claude-sonnet-4-6
tools:
  - shell
  - fs_read
  - fs_write
  - git
  - test_run
temperature: 0.3
---
You are a DevOps engineer.
Explore the project with fs_list before editing.
Make targeted changes with fs_write.
Always consider security.

Run it:

m chat examples/agents/devops.md
m run examples/agents/devops.md "audit the Dockerfile"

The repo ships 32 example agents in examples/agents/, including coder, reviewer, planner, k8s-debug, terraform-plan, helm-deploy, ticket-worker, plus persona variants (steva-djubre.md, steve-trash.md).


Built-in tools

Tool Purpose User confirmation
shell Run a shell command yes (per call)
fs_read Read a file no
fs_write Create or patch a file yes (diff preview)
fs_list List a directory (recursive, skips .git/node_modules) no
git Common git operations yes for writes
test_run Run the project's test command no
web_fetch Fetch a URL and extract readable text no
delegate Call a sub-agent no

fs_write writes are reversible via /undo.


Providers

Selected per-agent via model: provider/model-name. Switch providers mid-session with /model provider/model.

Provider Transport Notes
ollama NDJSON Local, free. Default for the wizard.
anthropic Custom SSE Claude family. Native tool use, response-tool for structured output.
openai OpenAI SSE GPT-4o / GPT-4.1. json_schema strict mode.
gemini OpenAI-compat gemini-2.5-pro / flash via Google's OpenAI-compat endpoint.
alibaba OpenAI-compat DashScope: qwen-plus / turbo / max.
litellm OpenAI-compat Proxy passthrough — opens up ~100 more models.

All clients are stdlib-only. Gemini, Alibaba and LiteLLM use a WithCompat() flag that disables OpenAI-specific stream options.


MCP integrations

Three MCP server definitions ship in examples/mcp/:

  • github — PR/issue/repo operations
  • jira — search, read, create, update, transition issues
  • confluence — search, read, create, update pages

Reference one from an agent:

mcp: [jira, confluence]

Tools are namespaced (jira__get_issue, confluence__update_page) and merged into the same registry as built-ins. Transport: stdio JSON-RPC. HTTP/SSE transport is not yet implemented.


Slash commands (chat REPL)

Command Effect
/help Show available commands
/exit, /quit Leave the session
/reset Clear chat history
/compact Truncate history to last 4 exchanges
/undo Revert the most recent fs_write
/config Open interactive provider/model manager
/spec Show the agent's resolved spec
/model Switch provider/model mid-session
/models List available models, pick by number
/save Save session snapshot (timestamped)
/sessions List saved sessions
/resume Resume a saved session by id or number
/themes List available themes with descriptions
/theme Switch TUI theme

Architecture

Hexagonal layout, ~8.8k LOC, 24 test files. No SDK dependencies for LLM clients.

cmd/m/                CLI entry, TUI, REPL, slash commands
internal/engine/      Session loop, tool dispatch, structured output
internal/llm/         Provider registry + 6 stdlib-only clients
internal/tools/       Built-in tool implementations
internal/mcp/         JSON-RPC stdio client, tool adapter
internal/config/      Frontmatter parsing, agent/MCP/skill schemas
internal/ports/       ConfigSource, Secrets, StateStore interfaces
internal/adapters/    Keychain (macOS/libsecret), file-backed stores
examples/agents/      32 ready-to-use agents
examples/mcp/         3 MCP server definitions
docs/                 Static product site (EN + SR), GitHub Pages

The engine never sees provider-specific code — providers register themselves via init() + llm.Register(), and the engine only consumes a Provider.Stream(ctx, req) → <-chan Event interface.

For a deeper walk-through (engine loop, hub-and-spoke delegation, MCP flow, structured output mechanics), see the architecture page or PLAN.md.


What works today

  • Single-binary install on macOS / Linux (amd64 + arm64)
  • 6 LLM providers, switchable mid-session
  • 8 built-in tools with user confirmation on writes + undo
  • MCP stdio transport with auto-discovery and namespacing
  • Hub-and-spoke sub-agent delegation
  • Provider-native structured output enforcement (response_schema)
  • Full-screen TUI with token/cost/context indicators, falls back to line REPL in pipes
  • 9 built-in themes (matrix, nord, dracula, gruvbox, tokyonight, catppuccin, solarized, default, minimal)
  • Session persistence with AES-256-GCM encryption and autosave
  • Token-based context compaction (per-model context window awareness)
  • Agent discovery (m list)
  • Tagged release pipeline producing .pkg and .deb

Known gaps

These are real, not roadmap-ware. They affect what AgentCTL can be used for today:

  • No codebase RAG / context retrieval. Agents see what they explicitly read with fs_read / fs_list / web_fetch. There's no embedding store, no similarity search. See Codebase context (RAG) below.
  • MCP HTTP/SSE transport not implemented. Stdio only. Many real-world MCP servers use HTTP — they don't work yet.
  • No /trust for autonomous sessions. Every fs_write and shell prompts. Fine for interactive use, blocks long-running headless runs.
  • No team features. No shared agent registry, no audit log, no RBAC, no sandboxed execution. Single-developer use only for now.
  • No IDE integration. Intentional — this is a CLI tool. Not planned.

The internal UX backlog is in UX_IMPROVEMENTS_PLAN.md.


Codebase context (RAG)

Not built in. Three reasonable paths if you need it:

  1. MCP route — point AgentCTL at any vector-store MCP server (Qdrant, Chroma, etc.). The agent gets vector__search as a normal tool. No code changes needed; this is how it'll work for now.
  2. A code_search built-in tool that wraps ripgrep + a small in-memory index over the working tree. Cheaper than embeddings, often enough for "find similar functions". Probably the next logical addition.
  3. First-class embedding store in internal/ with a pluggable backend. Bigger lift, only worth it if there's a commercial story behind it.

If RAG matters for your use case, option 1 unblocks you today.


Naming

The product is called AgentCTL. The CLI binary remains m for ergonomics — short to type, easy to alias, works in scripts. Think of it like how "Kubernetes" is the product but kubectl is the binary.


Building from source

git clone https://github.com/subzone/Agentctl.git
cd Agentctl
make build       # produces ./m
make test        # runs go test ./...
make lint        # golangci-lint

Requires Go 1.26+.


Contributing

Early-stage project. Bugs, design feedback, and PRs all welcome. Before a PR for a non-trivial change, open an issue so we can align on scope — the architecture is small enough that one wrong abstraction hurts.


License

MIT. See LICENSE.

Directories

Path Synopsis
cmd
m command
Theme support for the TUI.
Theme support for the TUI.
internal
adapters
Package adapters provides concrete implementations of the ports interfaces.
Package adapters provides concrete implementations of the ports interfaces.
engine
Package engine drives the agent loop: send messages → consume the streamed response → execute requested tools → loop until the model stops on its own.
Package engine drives the agent loop: send messages → consume the streamed response → execute requested tools → loop until the model stops on its own.
llm
Package llm defines the provider-agnostic LLM interface used by the agent engine.
Package llm defines the provider-agnostic LLM interface used by the agent engine.
llm/alibaba
Package alibaba registers an "alibaba" provider that wraps the openai adapter against Alibaba Cloud's DashScope OpenAI-compatible endpoint.
Package alibaba registers an "alibaba" provider that wraps the openai adapter against Alibaba Cloud's DashScope OpenAI-compatible endpoint.
llm/anthropic
Package anthropic implements the llm.Provider contract against the Anthropic Messages API.
Package anthropic implements the llm.Provider contract against the Anthropic Messages API.
llm/gemini
Package gemini registers a "gemini" provider that wraps the openai adapter against Google's OpenAI-compatible endpoint at generativelanguage.googleapis.com.
Package gemini registers a "gemini" provider that wraps the openai adapter against Google's OpenAI-compatible endpoint at generativelanguage.googleapis.com.
llm/litellm
Package litellm registers a "litellm" provider that wraps the openai provider with a custom base URL and API key.
Package litellm registers a "litellm" provider that wraps the openai provider with a custom base URL and API key.
llm/ollama
Package ollama implements the llm.Provider contract against the Ollama /api/chat endpoint.
Package ollama implements the llm.Provider contract against the Ollama /api/chat endpoint.
llm/openai
Package openai implements the llm.Provider contract against the OpenAI Chat Completions API.
Package openai implements the llm.Provider contract against the OpenAI Chat Completions API.
mcp
Package mcp implements a minimal Model Context Protocol client over the stdio transport.
Package mcp implements a minimal Model Context Protocol client over the stdio transport.
ports
Package ports defines the interfaces that decouple the engine and CLI from concrete infrastructure.
Package ports defines the interfaces that decouple the engine and CLI from concrete infrastructure.
tools
Package tools defines the Tool interface and a registry for builtins.
Package tools defines the Tool interface and a registry for builtins.
userconfig
Package userconfig manages the per-user CLI configuration: which provider the bare `m` command uses, the model id, and provider-specific connection details.
Package userconfig manages the per-user CLI configuration: which provider the bare `m` command uses, the model id, and provider-specific connection details.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL