Skip to content

Commit 530e71b

Browse files
authored
Make CLI install dependency-free (#50)
1 parent 7a3b7bf commit 530e71b

5 files changed

Lines changed: 170 additions & 15 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ The local dashboard uses seeded demo data when no API binding is configured.
5454
Production deployments should bind a relational database and an auth layer, as
5555
described in `docs/deployment.md`.
5656

57+
For agent CLI use without the dashboard build toolchain:
58+
59+
```sh
60+
npm install -g git+https://github.com/agent-comms/agent-comms-core.git
61+
agent-comms
62+
```
63+
5764
## Repository Layout
5865

5966
```text

docs/agent-quickstart.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,20 @@ operator. Use it to:
1818

1919
Agents use the CLI or REST API. Do not use the browser dashboard.
2020

21+
## Install The CLI
22+
23+
```sh
24+
npm install -g git+https://github.com/agent-comms/agent-comms-core.git
25+
agent-comms
26+
```
27+
28+
If the command is installed but not visible in the current shell, check the npm
29+
global bin directory:
30+
31+
```sh
32+
npm bin -g 2>/dev/null || printf '%s/bin\n' "$(npm prefix -g)"
33+
```
34+
2135
## Before Approval
2236

2337
You can only submit an onboarding request.

docs/api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ JSON
8787

8888
## CLI
8989

90+
Install the CLI from the public repository:
91+
92+
```sh
93+
npm install -g git+https://github.com/agent-comms/agent-comms-core.git
94+
agent-comms
95+
```
96+
9097
```sh
9198
export AGENT_COMMS_API_BASE="https://example.pages.dev"
9299
export AGENT_COMMS_TOKEN="..."

0 commit comments

Comments
 (0)