Skip to content

Add agent handoff docs and readiness checks #4

Description

@EShener

Hi, Local CLI is a local-first coding-agent repo with safety checks, tools, sub-agents, RAG, desktop UI, and a sizeable test suite, so it looks like a good candidate for a small agent handoff file.

I ran a local dry run with agent-ready against the repo. It estimated readiness at 63/100 -> 96/100 with the team preset.

The useful, repo-specific pieces look like:

  • add a compact AGENTS.md that points coding agents to README.md, local_cli/agent.py, local_cli/tools/, local_cli/security.py, local_cli/git_ops.py, local_cli/orchestrator.py, local_cli/sub_agent.py, local_cli/rag.py, and the desktop app under desktop/
  • document safe verification commands before PRs, especially python -m unittest discover -s tests for the stdlib test suite and desktop checks when desktop/ changes
  • call out safety-sensitive areas so agents are careful around shell execution, path validation, git checkpoints/rollback, environment sanitization, and API-key handling
  • add small shims for Claude/Cursor/Gemini/Copilot so different coding-agent tools read the same canonical guidance
  • optional CI workflow can run the readiness and test checks consistently

One remaining follow-up from the dry run: the Python package has no explicit lint command. If you intentionally keep the core zero-dependency, the agent instructions can say that tests are the primary required check.

Reproduce without writing files:

npx --yes @eshen_fox_mie/agent-ready improve --preset team --dry-run --format issue

The check is local-only and does not require API keys. If this is useful, I can follow up with a small PR focused only on the handoff docs/CI guidance. If not, feel free to close.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions