From e0b5a933e2f41603c34a9fe2b54f6b3f32dc2a9a Mon Sep 17 00:00:00 2001 From: 35C4n0r Date: Tue, 14 Oct 2025 20:24:14 +0530 Subject: [PATCH 1/2] docs: update installation instructions in README.md --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d9cee97..c589c5a 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,15 @@ You can use AgentAPI: ## Quickstart -1. Install `agentapi` by downloading the latest release binary from the [releases page](https://github.com/coder/agentapi/releases). +1. Install `agentapi`: -1. Verify the installation: + ```bash + sh -c 'curl -fsSL https://github.com/coder/agentapi/releases/latest/download/agentapi-$(uname -s | tr "[:upper:]" "[:lower:]")-$(uname -m | sed "s/x86_64/amd64/;s/aarch64/arm64/") -o agentapi' && chmod +x agentapi + ``` + + Alternatively, you can download the latest release binary from the [releases page](https://github.com/coder/agentapi/releases). + +2. Verify the installation: ```bash agentapi --help @@ -23,7 +29,7 @@ You can use AgentAPI: > On macOS, if you're prompted that the system was unable to verify the binary, go to `System Settings -> Privacy & Security`, click "Open Anyway", and run the command again. -1. Run a Claude Code server (assumes `claude` is installed on your system and in the `PATH`): +3. Run a Claude Code server (assumes `claude` is installed on your system and in the `PATH`): ```bash agentapi server -- claude @@ -31,7 +37,7 @@ You can use AgentAPI: > If you're getting an error that `claude` is not in the `PATH` but you can run it from your shell, try `which claude` to get the full path and use that instead. -1. Send a message to the agent: +4. Send a message to the agent: ```bash curl -X POST localhost:3284/message \ @@ -39,13 +45,13 @@ You can use AgentAPI: -d '{"content": "Hello, agent!", "type": "user"}' ``` -1. Get the conversation history: +5. Get the conversation history: ```bash curl localhost:3284/messages ``` -1. Try the chat web interface at http://localhost:3284/chat. +6. Try the chat web interface at http://localhost:3284/chat. ## CLI Commands From 2beefd812008bc80d30a9908f1e00d70f1202c37 Mon Sep 17 00:00:00 2001 From: 35C4n0r Date: Thu, 16 Oct 2025 20:42:42 +0530 Subject: [PATCH 2/2] chore: improve command and renumber --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c589c5a..dd39485 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,14 @@ You can use AgentAPI: 1. Install `agentapi`: ```bash - sh -c 'curl -fsSL https://github.com/coder/agentapi/releases/latest/download/agentapi-$(uname -s | tr "[:upper:]" "[:lower:]")-$(uname -m | sed "s/x86_64/amd64/;s/aarch64/arm64/") -o agentapi' && chmod +x agentapi + OS=$(uname -s | tr "[:upper:]" "[:lower:]"); + ARCH=$(uname -m | sed "s/x86_64/amd64/;s/aarch64/arm64/"); + curl -fsSL "https://github.com/coder/agentapi/releases/latest/download/agentapi-${OS}-${ARCH}" -o agentapi && chmod +x agentapi ``` Alternatively, you can download the latest release binary from the [releases page](https://github.com/coder/agentapi/releases). -2. Verify the installation: +1. Verify the installation: ```bash agentapi --help @@ -29,7 +31,7 @@ You can use AgentAPI: > On macOS, if you're prompted that the system was unable to verify the binary, go to `System Settings -> Privacy & Security`, click "Open Anyway", and run the command again. -3. Run a Claude Code server (assumes `claude` is installed on your system and in the `PATH`): +1. Run a Claude Code server (assumes `claude` is installed on your system and in the `PATH`): ```bash agentapi server -- claude @@ -37,7 +39,7 @@ You can use AgentAPI: > If you're getting an error that `claude` is not in the `PATH` but you can run it from your shell, try `which claude` to get the full path and use that instead. -4. Send a message to the agent: +1. Send a message to the agent: ```bash curl -X POST localhost:3284/message \ @@ -45,13 +47,13 @@ You can use AgentAPI: -d '{"content": "Hello, agent!", "type": "user"}' ``` -5. Get the conversation history: +1. Get the conversation history: ```bash curl localhost:3284/messages ``` -6. Try the chat web interface at http://localhost:3284/chat. +1. Try the chat web interface at http://localhost:3284/chat. ## CLI Commands