Skip to main content

Agentic coding terminal for the shell (runPixel gateway / OpenAI-compatible / offline backends)

Project description

robodog-terminal

An agentic coding terminal: a prompted tool-use loop that reads/edits files, runs commands, runs tests, and self-corrects — over pluggable LLM backends. Designed to run leading models on self-hosted gateways (air-gapped, where the usual agentic assistants can't reach), and works equally with OpenAI-compatible models or a fully offline mock.

Install

pip install -U robodog-terminal       # or, from a checkout: pip install -e apps/cli/robodog

Run

The command is dashed (robodog-terminal or the short alias robodogt); the Python package is robodog_terminal with an underscore (python -m robodog_terminal also works).

robodog-terminal --backend openrouter --model anthropic/claude-sonnet-4.6  # live via OpenRouter (provider/model ids)
robodog-terminal --backend openai --model gpt-4o      # live via OpenAI directly (bare ids)
robodog-terminal --backend gateway                    # enterprise box (the gateway / leading models)
robodog-terminal --echo                               # offline demo, no keys
robodog-terminal --backend openai -p "fix x.py and run the tests"   # headless (-p)
python -m robodog_terminal.run_tests                  # test suites (from a checkout)

Configure (first run)

Get a key at openrouter.ai/keys, then either drop it in a config file:

mkdir -p ~/.robodog
echo "ROBODOG_LLM_KEY=<your OpenRouter key>" >> ~/.robodog/config.env
robodog-terminal             # then /doctor to verify what was found

…or keep it in an encrypted KeePass vault instead — no plaintext key on disk:

pip install "robodog-terminal[keepass]"
robodog-terminal
# then, at the prompt:
#   /keepass init <your OpenRouter key>     creates vault + keyfile + loader
#   /keepass                                status; /doctor to verify

command not found right after install? Your pip scripts dir isn't on PATH — the exes live in ..\Scripts relative to the Location: shown by pip show -f robodog-terminal (e.g. ...\AppData\Roaming\Python\Python312\Scripts for a Windows user-level install). Use python -m robodog_terminal as a zero-setup fallback, and see the troubleshooting guide for PATH repair (do not use setx — it truncates long PATHs to 1024 chars), locked-exe upgrade failures, and more.

Other providers (ROBODOG_LLM_URL) and the enterprise gateway (GATEWAY_*) are covered in the repo README.

Config file (.robodog/settings.json)

Scaffold one with /config init (writes to <cwd>/.robodog/settings.json; add --global for ~/.robodog/settings.json, --force to overwrite). /config with no argument shows the effective config and which files were actually loaded.

Where robodog looks, and which one wins

Four locations are merged, in this exact order:

1. <cwd>/.robodog/settings.json   (highest priority)
2. <cwd>/.claude/settings.json
3. ~/.robodog/settings.json
4. ~/.claude/settings.json        (lowest priority)

.claude/settings.json is read too so an existing Claude Code project's settings work unchanged. Missing files are just skipped — you only need the one(s) you actually want.

How "winning" works depends on the field type:

  • permissions.allow / permissions.denyconcatenated, not overridden. Every rule from every file that exists applies; there's no way for a user-level file to "cancel" a project-level rule (deny always wins over allow regardless of which file either came from — see below).
  • hooks.* — also concatenated; project hooks run before user hooks.
  • defaults.*scalar, first file wins. If both <cwd>/.robodog/settings.json and ~/.robodog/settings.json set "guard", the project one is used and the user one is silently ignored for that key (not merged, not an error).

Every line, what it does

{
  "defaults": {
    "permissionMode": "yolo",   // "yolo" | "plan" — startup permission mode.
                                // A CLI --permission-mode flag always overrides
                                // this. Anything other than exactly "plan" is
                                // silently treated as "yolo" — a typo here is
                                // harmless (falls back to the default), not an error.
    "guard": "warn",            // "warn" | "confirm" — destructive-command handling.
                                // A CLI --guard flag always overrides this.
                                // ⚠ NOT VALIDATED: any value other than the exact
                                // string "confirm" behaves like "warn" (no
                                // confirmation is EVER asked). A typo like
                                // "confirmm" silently disables the safety prompt
                                // instead of erroring — this is the one field in
                                // this file where a mistake fails UNSAFE, not safe.
    "netWrites": "confirm",     // "confirm" | "deny" | "allow" — outward-facing
                                // network writes (POST/PUT/DELETE to a remote API,
                                // e.g. closing a Jira ticket, `git push`).
                                // A CLI --net-writes flag or $ROBODOG_NET_WRITES
                                // always overrides this. Unlike "guard" above,
                                // an unrecognized value here fails SAFE — anything
                                // that isn't exactly "allow" or "deny" is treated
                                // as "confirm" (asks before proceeding).
    "verifyEdits": true         // Scaffolded by `/config init` but NOT YET READ —
                                // only the --no-verify-edits CLI flag controls
                                // post-edit syntax verification today. Known gap;
                                // this key is currently a no-op placeholder.
  },
  "permissions": {
    "allow": ["bash(git *)", "read_file(*)"],   // "tool" or "tool(glob)".
    "deny":  ["bash(rm -rf *)", "write_file(*.env)"]
                                // The glob is fnmatch-style, matched against the
                                // call's primary argument (command for bash/
                                // run_script, path for file tools, prompt for the
                                // agent tool). A `command` value is split on
                                // top-level && / || / ; / | FIRST (quote-aware) —
                                // deny fires if ANY segment matches; allow only
                                // fires if EVERY segment matches an allow rule.
                                // So `allow: ["bash(git *)"]` does NOT bless
                                // `git status && rm -rf ~` as a whole.
  },
  "hooks": {
    "PreToolUse":  [{"matcher": "bash|run_script",     // regex, fullmatched
                                                        // against the tool name.
                                                        // Empty/absent = every tool.
                     "command": "python lint_gate.py", // runs via the shell, cwd
                                                        // = the project root. Gets
                                                        // a JSON payload on stdin:
                                                        // {event, tool_name,
                                                        //  tool_input, cwd}.
                     "timeout": 30}],                  // seconds; default 30 if
                                                        // omitted.
    "PostToolUse": [{"matcher": "write_file|edit_file",
                     "command": "npx prettier --write ."}],  // same payload +
                                                              // tool_result.
    "Stop":        [{"command": "notify-send 'robodog turn done'"}]
                     // no matcher (Stop fires once per finished turn, not per tool)
  }
}

What happens when something's wrong — the exact order things fail in

Nothing here ever crashes startup or the agent loop. Failures degrade in this order, from "whole file ignored" down to "one call proceeds instead of being gated":

  1. A settings.json file has invalid JSON → that ONE file is skipped entirely (logged as a warning), the other three still load normally.
  2. A permission rule string doesn't parse (doesn't match tool or tool(glob)) → that individual rule is silently dropped; the rest of the list still applies.
  3. A hook's matcher is an invalid regex → that hook is skipped for matching purposes (logged), other hooks still run.
  4. A hook command fails to spawn, or times out (default 30s, or the hook's own "timeout") → treated as non-fatal and logged; a broken PreToolUse hook does not block the call — it just doesn't run.
  5. A PreToolUse hook exits non-zero but not exactly 2 → logged as a warning and the call proceeds. Only exit code 2 blocks (its stderr becomes the block reason shown to the model).
  6. A defaults.* value is malformed (typo, wrong type) → see the per-field notes above; permissionMode and netWrites fail toward the safe default, guard is the one exception that fails toward less safety (an unrecognized value behaves like "warn").

Features

Agentic loop — tools (read/write/edit/multi_edit/bash/run_script/run_tests/ glob/grep/list_dir) with read-before-edit, byte-faithful writes + verify-after- write, fuzzy edits, and syntax checks.

Built for flaky gateways — truncation-aware parsing (a cut-off tool call is recovered), a capped reflection loop that re-teaches the format on a malformed call, self-healing error hints (Windows paths, hyphenated skill dirs, json.loads on a dict, a credit-limited 402 auto-retried smaller), jittered Retry-After backoff, multi-format parsing (<tool>/<invoke>, <think> stripping, JSON tool calls).

Windows-smart — auto-translates &&/||, | head/tail/wc/grep, curlcurl.exe, dir /b, 2>/dev/null; UTF-8 end-to-end (no mojibake).

Safe by default — one central guard on every code-executing tool; outward network writes (Jira POST, git push, gh pr create) confirm and block fail-safe when unattended. /net-writes allow|deny|confirm, or press a to always-allow.

Context & concurrency — keep-goal/summarize-middle compaction, on-disk freshness checks, parallel subagents (live progress + model-concurrency cap) plus background subagents (/bg /tasks /tail /kill), a bounded never-overwhelming trace (/verbose for the full feed).

Ergonomics@file/@folder mentions with tab-completion · atomic /rewind (files + transcript) · JSONL sessions (/resume, --continue) · plan mode · encrypted KeePass vault (/keepass) · skills & custom commands with keyword triggers (.robodog/, .claude/) · CLAUDE.md/ROBODOG.md hierarchy · rich + prompt_toolkit TUI (emoji/color status line, clickable file:line) · /stats (tokens + est. cost), /copy, /save · headless -p (text/json) · /doctor.

Benchmarked at capability parity with a leading agentic coding assistant across 20 agentic scenarios. See docs/TERMINAL_MODE_PLAN.md for the full design and ROADMAP.md for what's shipped/next.

How robodog compares

Criteria most relevant to picking an agentic coding tool. The 8 open-source columns come from a source-level read of each project (see ROADMAP.md for citations). Claude Code is closed-source — its column reflects documented/observed behavior from actual usage, not code I could read, so treat it as less rigorously verified than the other 9. ✅ full support · 🟡 partial · ❌ not found/not present.

Criteria (why it matters) Cline Roo Code Aider goose OpenHands Continue Gemini CLI Qwen Code Claude Code robodog
License Apache-2.0 Apache-2.0 Apache-2.0 Apache-2.0 MIT Apache-2.0 Apache-2.0 Apache-2.0 proprietary MIT
Primary interface VS Code ext VS Code ext CLI CLI (Rust) CLI/SDK/web VS Code ext + CLI CLI CLI CLI + IDE + desktop + web CLI
Windows command translation — rewrites Unix-isms (grep, dir, 2>nul, pipe filters) instead of just hoping the model writes native syntax ❌ (prompts native syntax) ❌ (native Windows backend instead) 🟡 some translation/hints observed, narrower than robodog's ~20+ patterns most extensive found
Persistent shell session — avoids a fresh process spawn (~0.75-1s) per command 🟡 VS Code terminal reuse only 🟡 VS Code terminal reuse only ✅ tmux (Linux) + native PowerShell reader (Windows) ❌ (has ConPTY option) ✅ documented persistent session
Compound-command permission splitting — an allow/deny rule matches per &&/;/| segment, not the whole line ✅ (matching only, not exec) ✅ real AST parsing 🟡 has prefix-based permission matching; exact mechanism unverifiable
Risk-tiered danger classification — not everything destructive needs the same confirm ❌ (allow/deny only) ✅✅ regex + optional ML 🟡 LLM classifier 🟡 ask/allow/deny prompting, not a verified explicit tier system deterministic 3-tier
Windows process-tree kill (taskkill /T /F, not just the parent) 🟡 🟡 🟡 🟡 unverifiable (closed-source)
Long-running command UX — hard-kill vs. a non-killing "still alive" signal hard timeout / detach dual timeout ❌ no timeout at all timeout + cancel ✅✅ soft-timeout, model can poll/interrupt idle-reset timeout idle-reset timeout timeout + bg-promote ✅ timeout + backgrounding (Ctrl+B) 🟡 idle-note (non-killing)
MCP client support ❌ not yet
Sandbox/container isolation ✅✅ Docker ✅ Docker/podman/seatbelt ✅ (same as Gemini) 🟡 permission modes; OS-level sandboxing unverifiable ❌ not yet
Embeddable as a library (no-UI core, usable outside the CLI) 🟡 ❌ (Rust binary) ✅ SDK-first 🟡 headless cn ✅ Claude Agent SDK (separate product, not the CLI itself) ✅✅ build_core()
Config file (permission rules + hooks) 🟡 settings.json (robodog's own hooks.py deliberately mirrors this) .robodog/settings.json
Customizable color themes IDE theme IDE theme N/A IDE theme ✅ (inherited) 🟡 light/dark, not arbitrary custom palettes ✅✅ 4 incl. pip-boy

What robodog covers that most others don't: Unix→Windows command rewriting (the rest either prompt the model to use native syntax or, like Claude Code, do narrower translation) — the only one in the table with a Python-native, explicitly-embeddable core (build_core()) built for that from day one, not retrofitted — and 4 switchable themes vs. everyone else's IDE-inherited or none.

robodog's real gaps — the two rows below are the honest answer to "what's missing": every other tool in this table (including Claude Code) has MCP; robodog doesn't yet (ROADMAP.md Phase 5.1, the single biggest ecosystem unlock available). Sandbox/container isolation is the second gap — OpenHands (Docker) and Gemini CLI/Qwen Code (Docker/podman/seatbelt) have real process-level isolation; robodog has permission gating but no execution sandbox yet (ROADMAP.md Phase 6). Its long-running-command UX (idle-note) is also a notch behind OpenHands' true soft-timeout-with-polling — informational only, doesn't let the model interactively poll or send input mid-command.

On Claude Code specifically: it's the most feature-complete tool in this table overall (widest interface surface, MCP, an Agent SDK, a real settings file) — but "covers everything robodog does" isn't quite accurate: robodog's Windows command-rewriting is more extensive than what's been observed from Claude Code, and Claude Code doesn't ship an embeddable no-UI core the way build_core() is — the Agent SDK is a related but separate product, not the CLI's own internals made importable. Being closed-source also means several rows above are inherently unverifiable rather than confirmed, which is a real asymmetry against the 8 tools whose source I could actually read.

Embedding (using robodog as a library, not the CLI)

robodog_terminal.core.build_core() assembles the agentic core — ToolRegistry

  • AgentLoop, with hooks/skills/background/session wiring — with no dependency on the terminal UI or argparse. This is the same function the CLI entrypoint (app.py::main()) calls; it just also wires a UI and a REPL loop on top. An embedder (a web backend, a chat bot, a test harness) can call it directly:
from robodog_terminal.core import build_core
from robodog_terminal.llm_client import EchoClient  # or GatewayClient/OpenAICompatClient

core = build_core(cwd=".", client=EchoClient())
result = core.loop.run("list the files here and summarize the project")
print(result.final_text)

Every UI touchpoint is an optional callback with a safe no-UI default (ask_fn auto-picks the first option; on_diff/on_bash_line/on_confirm/on_event no-op if you don't supply them — though a destructive command under guard="confirm" still fails closed, not open, with no on_confirm wired). Pass your own to hook into a different frontend:

core = build_core(
    cwd=".", client=my_client,
    guard="confirm", on_confirm=lambda cmd, reason: my_approval_ui(cmd, reason),
    on_bash_line=lambda line: my_ui.stream(line),
    on_event=lambda kind, data: my_ui.render(kind, data),
)

See core.py's build_core() docstring for the full parameter list. Three extension points discovered from <cwd>/.robodog/ (mirrored from .claude/ for existing Claude Code projects) come along for free in the returned Core.registry/Core.skills:

  • .robodog/settings.json (hooks.py) — permission allow/deny rules and PreToolUse/PostToolUse/Stop hooks, plus a defaults block (permissionMode/guard/netWrites) that seeds build_core()'s own defaults. Scaffold one with /config init in the CLI, or write it directly.
  • .robodog/commands/*.md, .robodog/agents/*.md, .robodog/skills/<name>/SKILL.md (skills.py) — custom slash commands, custom subagent types, and keyword-triggered context injection.
  • agents.py's AGENT_TYPES — the built-in subagent roster (explore, general); SkillsRegistry.agent_type_overrides() merges file-defined ones in, and build_core() does this merge automatically.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

robodog_terminal-0.3.68.tar.gz (243.6 kB view details)

Uploaded Source

Built Distribution

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

robodog_terminal-0.3.68-py3-none-any.whl (264.9 kB view details)

Uploaded Python 3

File details

Details for the file robodog_terminal-0.3.68.tar.gz.

File metadata

  • Download URL: robodog_terminal-0.3.68.tar.gz
  • Upload date:
  • Size: 243.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for robodog_terminal-0.3.68.tar.gz
Algorithm Hash digest
SHA256 6cefd61f54c91a055b5a15aa6f05b1f5cc2ddb8cf257ca36c7ce7e30edd1e81b
MD5 c403ec43e06e71b08c454fb36290a351
BLAKE2b-256 16e7949c214ff3d6751b6bfb0b2f1db13b25161d6f7edfe3b23e77997f8ae0fe

See more details on using hashes here.

File details

Details for the file robodog_terminal-0.3.68-py3-none-any.whl.

File metadata

File hashes

Hashes for robodog_terminal-0.3.68-py3-none-any.whl
Algorithm Hash digest
SHA256 44c0ba1af575b8407797c213bec8313ac7658a5b00c56b793856e543a88810c6
MD5 45c072196adb19cc8c3b6537721ce42b
BLAKE2b-256 927b8ea1edca1c99be8ea7a93ae16f0bf7bfcc58ad4672c17491c564ce251248

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