Files
cleveragents-core/docs/index.md
T

1.4 KiB

CleverAgents Core Documentation

CleverAgents is the Python implementation of the Plandex automation platform. This documentation tracks the migration effort and provides guidance for contributors porting the Go functionality to Python.

Current Deliverables

  • src/cleveragents package providing the cleveragents and agents CLI entry points
  • Updated benchmarks targeting CLI startup behavior
  • Behave scenarios verifying help and version metadata
  • Robot placeholder suites ready for integration parity tests
  • Nox sessions orchestrating linting, typing, testing, docs, builds, and benchmarks

Getting Started

python -m venv .venv
source .venv/bin/activate
pip install -e .[tests,docs]
nox -s unit_tests
nox -s integration_tests

Migration Notes

  • Reference the Go sources under plandex/ for feature parity—never modify that directory.
  • All CLI branding should use CleverAgents terminology; retain plandex only as a compatibility alias.
  • Document discoveries and open questions directly in implementation_plan.md under the appropriate phase.

Next Steps

  • Expand discovery tooling for CLI, server routes, and shared contracts (Phase 0 checklist).
  • Add Robot suites validating route mapping and configuration parity.
  • Create ADRs defining CleverAgents architecture (Phase 1).

For detailed progress, follow the living checklist in implementation_plan.md.