Skip to content

Alice-space/alice

Repository files navigation

Alice

Dev CI Main Release Release On Tag

A Feishu long-connection connector for CLI-based LLM agents such as Codex, Claude, Gemini, and Kimi.

Alice runs as a local multi-bot runtime:

  • receives Feishu messages over WebSocket
  • routes messages into chat or work scenes
  • calls the configured LLM CLI backend
  • sends progress, replies, files, and images back to Feishu
  • exposes a local runtime API used by bundled skills

For Chinese documentation, see README.zh-CN.md.

Features

  • Multi-bot runtime from a single config.yaml
  • Per-bot isolated workspace, SOUL.md, and prompts, with shared CODEX_HOME by default
  • Scene-aware routing for casual chat and explicit work threads
  • Runtime HTTP API for bundled skills and automation
  • Bundled skills are materialized under ${ALICE_HOME:-~/.alice}/skills, linked into ~/.agents/skills, and exposed to Claude via ~/.claude/skills
  • alice-code-army uses Alice runtime role dispatch for planner / reviewer / executor flows; templates no longer hardwire concrete models
  • alice-code-army campaign repos now validate refined task packages (task.md / context.md / plan.md) via repo-lint, require review before approve-plan, and keep review files inside each task folder
  • alice-code-army now enforces post-run task invariants after each executor / reviewer round: executor rounds must hand off legally (review_pending, waiting_external, or blocked), and reviewer rounds must leave a valid task-local review artifact
  • alice-code-army waiting-for-human-approval cards now expose direct Approve / Reject buttons in Feishu, with stale-round protection
  • Embedded prompts, skills, config example, and SOUL.md example
  • Release installer for systemd --user deployments

Requirements

  • Go 1.25+ for source builds
  • One installed and authenticated backend CLI:
    • codex
    • claude
    • gemini
    • kimi
  • A Feishu app with:
    • bot capability
    • im.message.receive_v1 subscription
    • required message permissions
    • long connection mode enabled

Quick Start

Install From Release

curl -fsSL https://cdn.jsdelivr.net/gh/Alice-space/alice@main/scripts/alice-installer.sh | bash -s -- install

Then:

  1. Edit ${ALICE_HOME:-~/.alice}/config.yaml
  2. Set bots.*.feishu_app_id and bots.*.feishu_app_secret
  3. Restart the service:
systemctl --user restart alice.service

Run From Source

cp config.example.yaml ~/.alice/config.yaml
# edit ~/.alice/config.yaml

go mod tidy
go test ./...
go run ./cmd/connector --feishu-websocket

Configuration

Alice uses a pure multi-bot config model.

Important concepts:

  • bots.<id>: one runtime bot
  • llm_profiles: named model presets
  • group_scenes.chat: conversational scene for group chats
  • group_scenes.work: explicit task scene for work threads
  • trigger_mode: legacy fallback when both scenes are disabled
  • workspace_dir / prompt_dir: per-bot runtime directories
  • codex_home: optional per-bot override for the shared CODEX_HOME (default: ~/.codex)
  • image_generation: optional roleplay image generation pipeline

Start from config.example.yaml.

Usage

Alice's operating model and chat / work scene behavior are documented in:

Additional docs:

Connector startup mode is now explicit: use --feishu-websocket for the real Feishu connector, or --runtime-only for local runtime/API-only execution. For isolated debug or temporary rerun runtimes, use alice-headless --runtime-only; headless binaries no longer allow Feishu websocket startup.

SOUL.md

Each bot can define persona and machine-readable metadata in workspace/SOUL.md.

Current frontmatter keys accepted by Alice:

  • image_refs
  • image_generation
  • output_contract

The embedded example is SOUL.md.example.

Installer

The installer script lives at scripts/alice-installer.sh.

Common commands:

# install or update the latest stable release
curl -fsSL https://cdn.jsdelivr.net/gh/Alice-space/alice@main/scripts/alice-installer.sh | bash -s -- install

# uninstall
curl -fsSL https://cdn.jsdelivr.net/gh/Alice-space/alice@main/scripts/alice-installer.sh | bash -s -- uninstall

Development

make check
make build
make run

make check includes formatting, vet, unit tests, and connector race tests.

Contribution guidelines are in CONTRIBUTING.md.

Release Process

  • Day-to-day work happens on dev
  • dev -> main drives the normal release path
  • Tagged releases are published through GitHub Actions

Workflow files:

License

MIT

About

Codex Feishu Connector

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages