Skip to main content

A sleek and professional agentic coding console and CLI assistant.

Project description

zzm-agent

A local-first personal coding agent and CLI for OpenAI-compatible chat models.

zzm-agent gives you an interactive REPL for project work, a non-interactive exec mode for scripts and CI, persistent sessions, semantic memory, prompt snapshots, and plugin-based tools for files, search, and shell commands.

Install

pip install zzm-agent

Requires Python 3.11 or newer.

First Run

Start the REPL:

zzm-agent

On the first interactive run, zzm-agent asks for:

  • Base URL, for example https://api.openai.com/v1
  • Model name, for example gpt-4o-mini
  • LLM API key

It creates user-level configuration:

~/.zzm_agent/config.yaml
~/.zzm_agent/.env

Secrets are written to .env; config.yaml keeps references such as ${LLM_API_KEY}.

You can also use existing environment variables:

LLM_BASE_URL=https://api.openai.com/v1
LLM_MODEL_NAME=gpt-4o-mini
LLM_API_KEY=your_api_key_here

Usage

Interactive REPL:

zzm-agent
zzm-agent repl --session my-session
zzm-agent repl --config path/to/config.yaml

Non-interactive one-shot tasks:

zzm-agent exec "summarize this repository"
zzm-agent exec --stdin < prompt.txt
zzm-agent exec --json "review the latest changes"
zzm-agent exec -o answer.md "write release notes"

In exec mode, medium and high risk tools are denied instead of prompting, so CI jobs and scripts do not hang on interactive approvals.

Shell completion:

zzm-agent completion bash
zzm-agent completion zsh
zzm-agent completion powershell

Configuration

Config resolution:

  1. --config <path>
  2. ZZM_AGENT_CONFIG
  3. ~/.zzm_agent/config.yaml
  4. repository config.yaml
  5. ./config.yaml
  6. ./.zzm_agent/config.local.yaml

.env files are loaded from the current directory and next to each loaded config file before ${ENV_NAME} placeholders are expanded.

Minimal config:

model:
  base_url: "${LLM_BASE_URL:-https://api.openai.com/v1}"
  api_key: "${LLM_API_KEY}"
  model_name: "${LLM_MODEL_NAME:-gpt-4o-mini}"

agent:
  stream: true
  auto_approve: false

memory:
  path: "~/.zzm_agent/memory.json"
  max_history: 50

REPL Commands

Useful commands inside the REPL:

  • /help
  • /tools
  • /models [filter]
  • /model [id]
  • /config
  • /memory
  • /sessions
  • /session <id>
  • /new
  • /remember <fact>
  • /search <keyword>
  • /evolve run
  • /exit

Project Links

Source repository and full documentation are available in the project README.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zzm_agent-0.1.2.tar.gz (196.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zzm_agent-0.1.2-py3-none-any.whl (161.8 kB view details)

Uploaded Python 3

File details

Details for the file zzm_agent-0.1.2.tar.gz.

File metadata

  • Download URL: zzm_agent-0.1.2.tar.gz
  • Upload date:
  • Size: 196.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for zzm_agent-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ca794790b2a7907cce16dbc29d05f2d1c08b9b50c3cf4b8fa7e381e682f58848
MD5 7bad6a8f82c9c011701123cb153a5e11
BLAKE2b-256 3e8aaafc5254e46752e6e863ba92bd2abe1719556d668785452bed14670f3824

See more details on using hashes here.

File details

Details for the file zzm_agent-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: zzm_agent-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 161.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for zzm_agent-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c07c57680e40d86811185e26156148238deb3589df328b578ae55a50ee5b53ab
MD5 1ff899122ce078453311df83394db262
BLAKE2b-256 78c305d5d818f8652d82e33b7704a7bfda210045cea9c3d3f362572361f9a5ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page