Skip to content

QUICKSTART.md

Latest commit

 

History

History
185 lines (141 loc) · 5.14 KB

QUICKSTART.md

File metadata and controls

185 lines (141 loc) · 5.14 KB

ArgusBot Quickstart

1) Install

python -m venv .venv
source .venv/bin/activate
pip install -e .

2) One-word entrypoint (recommended)

argusbot

Show supported features/commands:

argusbot help

Behavior:

  • First run: prompts you to choose control channel (1. Telegram, 2. Feishu (适合CN网络环境), default Telegram), then choose runner backend (1. Codex CLI, 2. Claude Code CLI), then collects selected channel credentials, writes .argusbot/daemon_config.json, and starts daemon.
  • Later runs: auto-reuse previous config, auto-start daemon if needed, and attach to live logs.
  • argusbot init: stop current workspace daemon, prompt control channel + backend + credentials/model preset/play mode, start a fresh daemon in background, and exit.
  • After init, run argusbot to attach monitor.
  • In attach console, terminal control works directly:
    • /run <objective>
    • /new
    • /inject <instruction>
    • /mode <off|auto|record>
    • /btw <question>
    • /plan <direction>
    • /review <criteria>
    • /show-main-prompt
    • /show-plan
    • /show-plan-context
    • /show-review [round]
    • /show-review-context
    • /status, /stop, /daemon-stop
    • plain text: running => inject, idle => run

Planner Mode:

  • off: disable plan agent behavior for daemon-launched runs.
  • auto (default): planner stays enabled and daemon may propose or auto-run the next request.
  • record: planner records markdown only without automatic follow-up execution.

Daemon-launched runs use --yolo by default.

Disable daemon quickly:

argusbot daemon-stop

3) Run (basic)

argusbot-run \
  --runner-backend claude \
  --runner-bin /opt/homebrew/bin/claude \
  --max-rounds 500 \
  "帮我在这个文件夹写一下pipeline"

4) Run with Telegram (secure remote visibility)

export TELEGRAM_BOT_TOKEN='123456789:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

argusbot-run \
  --max-rounds 500 \
  --telegram-bot-token "$TELEGRAM_BOT_TOKEN" \
  --telegram-events "loop.started,round.review.completed,loop.completed" \
  "帮我在这个文件夹写一下pipeline"

Notes:

  • chat_id defaults to auto and is resolved from Telegram updates.
  • Live terminal streaming is on by default.
  • Telegram live deltas are sent every 30s only when content changes.
  • Telegram control commands are enabled by default (/inject, /status, /stop).
  • Daemon child defaults inherit the selected backend configuration unless you set a preset or explicit model override.

Control examples from Telegram Web:

  • /inject 先停止当前实验，改成只跑100 step并保存checkpoint
  • /status
  • /stop

6) Keep Telegram online even when no run is active

argusbot-daemon \
  --telegram-bot-token "$TELEGRAM_BOT_TOKEN" \
  --telegram-chat-id auto

Then from Telegram Web:

  • /run 帮我在这个文件夹写一下pipeline
  • /status
  • /stop

7) Interactive setup + background daemon

argusbot-setup --run-cd .

If the command is missing, use:

  .\.venv\Scripts\Activate.ps1                                                                                   
         Get-Process | Where-Object { $_.ProcessName -like 'argusbot*' } | Stop-Process -Force                          
python -m codex_autoloop.setup_wizard --run-cd .

Setup now asks for execution backend first, then planner mode after model selection:

  • 1 No Planner
  • 2 Auto Planner (default)
  • 3 Record-Only Planner

Auto Planner follow-up countdown defaults to 10 minutes.

Then terminal control (same daemon, no restart needed):

argusbot-daemon-ctl --bus-dir .argusbot/bus run "实现一个长程目标"
argusbot-daemon-ctl --bus-dir .argusbot/bus inject "切换到更保守的方案并先跑测试"
argusbot-daemon-ctl --bus-dir .argusbot/bus status
argusbot-daemon-ctl --bus-dir .argusbot/bus stop

Defaults:

  • Daemon-launched run uses --yolo by default.
  • Default check command is optional (leave empty for no forced check).
  • Idle daemon tries to resume from the last saved session_id.
  • One Telegram token can only be used by one active daemon.
  • Operator messages are recorded into per-run markdown files in .argusbot/logs/.
  • Copilot proxy is Codex-only; Claude backend ignores proxy flags.
  • Claude maps xhigh effort down to high.
  • Re-running setup/start will stop the previous daemon for the same .argusbot before starting a new one.

One-click kill:

./scripts/kill_telegram_daemon.sh

Realtime log mirror:

./scripts/watch_argusbot_logs.sh .argusbot

If command is missing, use:

python -m codex_autoloop.daemon_ctl --bus-dir .argusbot/bus status

4) Optional dashboard

argusbot-run \
  --dashboard \
  --dashboard-host 127.0.0.1 \
  --dashboard-port 8787 \
  --max-rounds 500 \
  "your objective"

5) Privacy / de-sensitization checklist

  • Never hardcode token/chat id in source files.
  • Use env vars for secrets (TELEGRAM_BOT_TOKEN etc.).
  • Rotate bot token immediately if it appears in terminal history or screenshots.
  • Before publish, scan repository for secrets:
rg -n "([0-9]{8,}:[A-Za-z0-9_-]{20,}|TELEGRAM_BOT_TOKEN|chat_id|token)" -S