Annolid Documentation Portal

Ship annotation and tracking workflows faster.

Annolid combines a desktop GUI, a composable CLI, and agent-assisted tools for real-world behavior analysis projects.

Start with a stable local setup, then move into repeatable workflows, memory-backed context, and deployment-ready operations.

Getting Started in 20 minutes Install Annolid Use .venv for development Follow core workflows Run annolid-run from Annolid agents Explore tutorials Enable memory subsystem

Choose Your Path

New Users Start from installation and one-line setup paths, then run your first GUI project.
Installation | One-Line Installer

Power Users Use annolid-run, MCP integrations, and automation-friendly CLI flows.
Workflows | Agent CLI | MCP | Reference

Maintainers Keep deployment, migration, and release workflows predictable and documented.
Deployment | Migration Plan

Core Areas

Setup

Pick the right environment path for your platform and development mode.

Open installation guide

Workflow Execution

Run GUI and CLI tasks with explicit, reproducible command patterns.

Open workflows

Zone Analysis

Draw chamber layouts, reuse zone files, and export phase-aware summaries.

Open zone analysis reference

Agent CLI

Use the typed annolid_run tool for safe agent-driven CLI operations.

Open agent CLI guide

Tutorials

Jump into focused guides for tracking, segmentation, and model operations.

Open tutorials

Memory System

Store reusable context, use scoped retrieval, and migrate legacy memory data.

Open memory docs

Agents and Security

Configure agents, isolate secrets, and validate local security posture.

Open security docs

Operations

Deploy docs/site assets and keep release and migration flows in sync.

Open deployment guide

Product Snapshot

• Python package metadata supports >=3.10; CI/docs currently target Python 3.10-3.13.
• Primary entry points are annolid (GUI) and annolid-run (CLI/plugins).
• Memory subsystem includes GUI CRUD manager, structured settings profiles, and legacy-source migration tooling.
• Annolid Bot supports multimodal chat and optional provider integrations in the GUI.
• Docs are built with MkDocs Material in strict mode and published through GitHub Actions.