From eaaee2171a531a247c4f288736d42d0c6563d158 Mon Sep 17 00:00:00 2001 From: mmontan Date: Wed, 11 Feb 2026 05:49:32 -0800 Subject: [PATCH 1/2] docs: Update README with end-user installation instructions Co-Authored-By: Claude Opus 4.6 --- README.md | 48 ++++++++++++++++++++++-------------------------- 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index f26a9a1..d49af92 100644 --- a/README.md +++ b/README.md @@ -2,45 +2,41 @@ 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 +``` + +## 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: From cd6682f366e410d702fc7bc84241eddf93bf1beb Mon Sep 17 00:00:00 2001 From: mmontan Date: Wed, 11 Feb 2026 06:18:14 -0800 Subject: [PATCH 2/2] Revert "docs: Update README with end-user installation instructions" This reverts commit eaaee2171a531a247c4f288736d42d0c6563d158. --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d49af92..f26a9a1 100644 --- a/README.md +++ b/README.md @@ -2,41 +2,45 @@ A command-line interface to manage Agent Engine. -## Installation +## Installation 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 -``` - -## Development Setup +This project is set up to work seamlessly with `uv`. 1. **Install uv** (if you haven't already): ```bash curl -LsSf https://astral.sh/uv/install.sh | sh ``` -2. **Clone the repo and install dependencies**: +2. **Create a virtual environment and install dependencies**: ```bash - git clone https://github.com/mmontan/agent-engine-cli.git - cd agent-engine-cli - uv sync + uv venv + source .venv/bin/activate + uv pip install -e . ``` -3. **Run the CLI locally**: +3. **Run the CLI**: ```bash - uv run ae --help + 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: