Skip to content

INDEX.md

Latest commit

 

History

History
78 lines (60 loc) · 4.39 KB

INDEX.md

File metadata and controls

78 lines (60 loc) · 4.39 KB
Raw

Beep.AI.Code — Documentation Index

Repository: Beep.AI.Code
Package: beep-ai-code · CLI: beep
Server dependency: Beep.AI.Server

Start here

Document Audience Summary
APP_OVERVIEW.md Everyone What the CLI is, how it connects to the server, runtime model
CLI_AND_COMMANDS.md Users / operators Command and REPL surface reference
SERVICES_REGISTRY.md Contributors AppService, domains, and package map
ENHANCEMENT_PLAN.md PM / contributors Master enhancement roadmap with per-feature plans
../ARCHITECTURE.md Contributors Runtime layers, ownership, clean-code boundaries
../README.md Users Install, setup, daily usage, troubleshooting
../MASTER-TODO-TRACKER.md Contributors Canonical phased execution tracker (.plans/ phases)

Feature enhancement plans

Each plan describes current behavior, code locations, and a prioritized enhancement backlog.

Feature Plan
Beep.AI.Server integration (default backend) features/server-integration.md
Integrations catalog (skills/MCP/tools) features/integrations-catalog.md
Coding-agent parity (Claude Code/OpenCode) features/coding-agent-parity.md
New features (greenfield) features/new-features.md
API client & streaming features/api-client.md
Coding Assistant bridge features/coding-assistant.md
Chat REPL & slash commands features/chat-repl.md
Agent runtime (LangGraph) features/agent-runtime.md
Workspace & editing features/workspace-editing.md
Context & intelligence features/context-and-intelligence.md
Memory, rules, skills features/memory-rules-skills.md
Plugins features/plugins.md
MCP bridge features/mcp-bridge.md
Templates features/templates.md
Sessions & compaction features/sessions.md
RAG features/rag.md
Code analysis & indexing features/code-analysis-indexing.md
Quality commands (test/lint/review) features/quality-commands.md
Permissions, sandbox, hooks features/permissions-sandbox-hooks.md
Watcher, tasks, bookmarks features/watcher-tasks-bookmarks.md
TUI features/tui.md
Publishing & agent bundles features/publishing-and-bundles.md
Diagnostics & updates features/diagnostics-packaging-updates.md
Configuration & setup features/configuration-setup.md

Index of feature folders: features/README.md.

Engineering standards

Document Notes
ENGINEERING_IMPLEMENTATION_GUIDELINES.md Cross-cutting implementation rules (originated in Beep.AI.Server workspace; applies to CLI changes that touch APIs and auth)
INSTALL_AND_UPDATE.md Install channels and update workflows
../AGENTS.md Ecosystem agent-framework rules when integrating with the server

Historical / server monorepo notes

These files describe server extraction or debug routes from an earlier monorepo layout. Prefer the documents above for Beep.AI.Code work unless you are changing server integration contracts.

Last updated: documentation suite for Beep.AI.Code app scan.