From 37dd15c85626ba22d294624928d538f2db1ecbed Mon Sep 17 00:00:00 2001 From: mmontan Date: Wed, 11 Feb 2026 06:19:00 -0800 Subject: [PATCH] docs: Update README with end-user installation instructions Add __main__.py to support `python -m agent_engine_cli`. Co-Authored-By: Claude Opus 4.6 --- README.md | 54 +++++++++++++++++--------------- src/agent_engine_cli/__main__.py | 3 ++ 2 files changed, 31 insertions(+), 26 deletions(-) create mode 100644 src/agent_engine_cli/__main__.py diff --git a/README.md b/README.md index f26a9a1..7051c07 100644 --- a/README.md +++ b/README.md @@ -2,45 +2,47 @@ A command-line interface to manage Agent Engine. -## Installation with uv +## Installation -This project is set up to work seamlessly with `uv`. +```bash +# With uv (recommended) +uv tool install agent-engine-cli + +# With pip +pip install agent-engine-cli +``` + +After installation, the `ae` command is available globally: + +```bash +ae --help +``` + +## Run Without Installing + +```bash +python -m agent_engine_cli --help +``` + +## Development Setup 1. **Install uv** (if you haven't already): ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` -2. **Create a virtual environment and install dependencies**: +2. **Clone the repo and install dependencies**: ```bash - uv venv - source .venv/bin/activate - uv pip install -e . + git clone https://github.com/mmontan/agent-engine-cli.git + cd agent-engine-cli + uv sync ``` -3. **Run the CLI**: +3. **Run the CLI locally**: ```bash - ae --help + uv run ae --help ``` -## Running Without Installation - -You can run the CLI directly without installing it: - -```bash -# Using uv (recommended) -uv run python -m agent_engine_cli.main --help - -# Or with plain Python (after installing dependencies) -python -m agent_engine_cli.main --help -``` - -Example commands: -```bash -uv run python -m agent_engine_cli.main list -p PROJECT_ID -l us-central1 -uv run python -m agent_engine_cli.main get AGENT_ID -p PROJECT_ID -l us-central1 -``` - ## Chat with an Agent Start an interactive chat session with a deployed agent: diff --git a/src/agent_engine_cli/__main__.py b/src/agent_engine_cli/__main__.py new file mode 100644 index 0000000..0aae4ba --- /dev/null +++ b/src/agent_engine_cli/__main__.py @@ -0,0 +1,3 @@ +from agent_engine_cli.main import app + +app()