Skip to content

Commit a890ef9

Browse files
committed
readme: go install in quickstart, clarification about hosted chat, openapi schema wording
1 parent 3ff9842 commit a890ef9

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

README.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,36 +13,42 @@ You can use AgentAPI:
1313

1414
## Quickstart
1515

16-
Install `agentapi`:
16+
1. Install `agentapi` by either:
1717

18-
1. Download the latest release binary from the [releases page](https://github.com/coder/agentapi/releases)
19-
2. Rename it (e.g. `mv agentapi-darwin-arm64 agentapi`)
20-
3. Make it executable (`chmod +x agentapi`)
21-
4. Put it in your PATH (e.g. `sudo mv agentapi /usr/local/bin`)
22-
5. Verify the installation (`agentapi --help`)
23-
6. (macOS) If you're prompted that macOS was unable to verify the binary, go to `System Settings -> Privacy & Security`, click "Open Anyway", and run the command again.
18+
- Downloading the latest release binary from the [releases page](https://github.com/coder/agentapi/releases)
19+
- Or building from source:
20+
```bash
21+
go install github.com/coder/agentapi@latest
22+
```
2423

25-
Run a Claude Code server (assumes `claude` is installed on your system):
24+
1. Verify the installation:
2625

27-
```bash
28-
agentapi server -- claude
29-
```
26+
```bash
27+
agentapi --help
28+
```
3029

31-
Send a message to the agent:
30+
1. (macOS) If you're prompted that macOS was unable to verify the binary, go to `System Settings -> Privacy & Security`, click "Open Anyway", and run the command again.
31+
1. Run a Claude Code server (assumes `claude` is installed on your system):
3232
33-
```bash
34-
curl -X POST localhost:3284/message \
35-
-H "Content-Type: application/json" \
36-
-d '{"content": "Hello, agent!", "type": "user"}'
37-
```
33+
```bash
34+
agentapi server -- claude
35+
```
3836
39-
Get the conversation history:
37+
1. Send a message to the agent:
4038
41-
```bash
42-
curl localhost:3284/messages
43-
```
39+
```bash
40+
curl -X POST localhost:3284/message \
41+
-H "Content-Type: application/json" \
42+
-d '{"content": "Hello, agent!", "type": "user"}'
43+
```
44+
45+
1. Get the conversation history:
46+
47+
```bash
48+
curl localhost:3284/messages
49+
```
4450
45-
We host a demo web chat interface at https://coder.github.io/agentapi/chat which will connect to your local AgentAPI server and let you test it out.
51+
1. Try the demo web chat interface at https://coder.github.io/agentapi/chat. Even though it's hosted on GitHub Pages, the chat will connect to your AgentAPI server running on `localhost:3284`.
4652

4753
## CLI Commands
4854

@@ -61,9 +67,9 @@ agentapi server -- aider --model sonnet --api-key anthropic=sk-ant-apio3-XXX
6167
agentapi server -- goose
6268
```
6369
64-
The OpenAPI schema is available in this repository: [openapi.json](openapi.json).
70+
An OpenAPI schema is available in [openapi.json](openapi.json).
6571
66-
By default, the server runs on port 3284. Additionally, the server exposes an OpenAPI schema at http://localhost:3284/openapi.json. You may also inspect the available endpoints at http://localhost:3284/docs.
72+
By default, the server runs on port 3284. Additionally, the server exposes the same OpenAPI schema at http://localhost:3284/openapi.json and the available endpoints in a documentation UI at http://localhost:3284/docs.
6773
6874
There are 4 endpoints:
6975

0 commit comments

Comments
 (0)