Reference¶

This page collects the current operational reference points for Annolid.

Commands¶

Primary entry points:

annolid: launch the GUI
annolid-run: run plugin-based training and inference workflows

Common CLI discovery commands:

annolid --help
annolid-run --help
annolid-run list-models
annolid-run train <model> --help-model
annolid-run predict <model> --help-model

Security-focused agent commands:

annolid-run agent-security-check
annolid-run agent-security-audit
annolid-run agent-security-audit --fix
annolid-run agent-secrets-audit

ACP bridge command:

annolid-run agent acp bridge --workspace /path/to/repo

Important Config Files¶

LLM and Annolid Bot model settings: ~/.annolid/llm_settings.json
Annolid agent runtime and channel config: ~/.annolid/config.json
Annolid agent local private secret store: ~/.annolid/agent_secrets.json
Annolid agent Google Calendar credentials: ~/.annolid/agent/google_calendar_credentials.json
Annolid agent Google Calendar cached token: ~/.annolid/agent/google_calendar_token.json
Annolid agent sessions directory: ~/.annolid/sessions/
LabelMe/GUI-style user config: ~/.labelmerc

Current Docs Pages¶

Current Bot/Agent Surfaces¶

Annolid Bot currently spans:

GUI chat dock in the desktop app,
optional background channels such as Zulip and WhatsApp,
MCP integrations,
browser/web tooling when configured,
automation scheduling and auxiliary services defined in the agent config.

The current Zulip UI flow is part of the Annolid Bot dock and depends on the Zulip channel block in ~/.annolid/config.json.

Selected Repository Paths¶

GUI code: annolid/gui/
Bot widget code: annolid/gui/widgets/ai_chat_widget.py
Agent/channel config schema: annolid/core/agent/config/
CLI plugin entry point: annolid/engine/cli.py
Tutorial notebooks: docs/tutorials/
MkDocs config: mkdocs.yml

Current Documentation Rule¶

User-facing guidance should be added to docs/ first. Historical book content and legacy links are secondary references, not the primary source of truth.