Skip to content

Commit aca4ba1

Browse files
committed
docs: align README with Agent Router positioning
1 parent 6fcaee8 commit aca4ba1

5 files changed

Lines changed: 71 additions & 8 deletions

File tree

‎README.md‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
1-
# BeatAPI CLI and TypeScript Client
1+
<p align="center">
2+
<img src="assets/readme/cover.svg" alt="BeatAPI CLI and TypeScript SDK — route Agent capabilities from terminal and code" width="100%" />
3+
</p>
24

3-
Official command-line interface and TypeScript client for BeatAPI's Model,
4-
Data, and Workflow capabilities. Version 0.3.0 provides the unified Search,
5-
Inspect, Run, and status commands while preserving the existing media,
6-
workflow, task, webhook, and Realtime commands.
5+
<p align="center">
6+
<a href="https://beatapi.io/"><strong>Explore BeatAPI</strong></a> ·
7+
<a href="https://beatapi.io/dashboard/apikeys">Create an API key</a> ·
8+
<a href="https://docs.beatapi.io/">Docs</a> ·
9+
<a href="#install-the-cli">Install</a> ·
10+
<a href="#command-reference">Commands</a>
11+
</p>
12+
13+
# BeatAPI CLI and TypeScript SDK
14+
15+
BeatAPI is the **Agent Router for Everything**: one route to Model, Data, Tool,
16+
and Workspace capabilities. This repository provides the official terminal and
17+
TypeScript interfaces, including the unified Search, Inspect, Run, and status
18+
loop.
19+
20+
```bash
21+
npm install --global beatapi
22+
beatapi capabilities search --query video --limit 5
23+
```
724

825
The live catalog is intentionally not hardcoded into the packages. Discover
926
current text, image, and video models plus 1,000+ Social Data actions at runtime,
@@ -20,6 +37,15 @@ Both packages are generated and tested against the reviewed OpenAPI snapshot in
2037
[`contract/beatapi.openapi.yaml`](./contract/beatapi.openapi.yaml). The lock file
2138
records the exact source commit and SHA-256 digest.
2239

40+
## Where this repository fits
41+
42+
```text
43+
Terminal or TypeScript app -> BeatAPI CLI / SDK -> BeatAPI -> Model · Data · Tool · Workspace
44+
```
45+
46+
The packages route only capabilities exposed by the current BeatAPI catalog and
47+
public contract. They do not hardcode future catalog promises.
48+
2349
## Install the CLI
2450

2551
Node.js 20.19+ or 22.12+ is required.
@@ -218,3 +244,7 @@ Release steps and ownership prerequisites are documented in
218244
## License
219245

220246
MIT
247+
248+
<p align="center">
249+
Built by <a href="https://beatapi.io/"><strong>BeatAPI</strong></a> — Agent Router for Everything.
250+
</p>

‎assets/readme/cover.svg‎

Lines changed: 33 additions & 0 deletions
Loading

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "beatapi-cli-workspace",
33
"version": "0.3.0",
44
"private": true,
5-
"description": "Official CLI and TypeScript client for BeatAPI models, Social Data, and workflows.",
5+
"description": "Official CLI and TypeScript SDK for BeatAPI, the Agent Router for Everything.",
66
"type": "module",
77
"workspaces": [
88
"packages/*"

‎packages/cli/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "beatapi",
33
"version": "0.3.0",
4-
"description": "Command-line interface for BeatAPI models, Social Data, and workflows.",
4+
"description": "Command-line interface for routing BeatAPI Model, Data, Tool, and Workspace capabilities.",
55
"type": "module",
66
"bin": {
77
"beatapi": "dist/bin.js"

‎packages/client/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "beatapi-client",
33
"version": "0.3.0",
4-
"description": "Type-safe JavaScript and TypeScript client for BeatAPI models, data, and workflows.",
4+
"description": "Type-safe JavaScript and TypeScript SDK for BeatAPI capability routing.",
55
"type": "module",
66
"main": "./dist/index.js",
77
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)