Skip to content

Commit f846c3f

Browse files
committed
Update install docs for published CLI and Marketplace extension
CLI now installs from npm (@iqlabs-official/agentnet-cli) and the VS Code extension from the Marketplace (IQLabs.agentnet-vscode), so lead every guide with the shipped path and move the clone-and-build flow into contributor sections. Drop the stale pre-release devnet notes, the vestigial build:core step, and the old feat/agentnet-cli branch note; add an Install & run section with real commands to the root README.
1 parent 5fc07a9 commit f846c3f

4 files changed

Lines changed: 70 additions & 76 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@
55

66
## Install & run
77

8-
See the **[Install Guide](install-guide/README.md)** for every surface:
8+
Pick a surface — they all share the same core and the same wallet-keyed sessions:
99

10+
- **CLI** — from npm:
11+
```bash
12+
npm install -g @iqlabs-official/agentnet-cli
13+
agentnet
14+
```
15+
- **VS Code extension** — install **[AgentNet](https://marketplace.visualstudio.com/items?itemName=IQLabs.agentnet-vscode)** from the VS Code Marketplace (or `code --install-extension IQLabs.agentnet-vscode`), then run **"AgentNet: Open Chat"** from the Command Palette.
1016
- **Android app** — install the latest APK from [android-latest](https://github.com/IQCoreTeam/AgentNet/releases/tag/android-latest) (developers: [build from source](install-guide/android.md))
11-
- **VS Code extension**[install-guide/vscode.md](install-guide/vscode.md)
12-
- **CLI**[install-guide/cli.md](install-guide/cli.md)
1317

14-
> Pre-release: all surfaces run on **devnet**. Once released these switch to `npm install` (CLI),
15-
> the VS Code Marketplace link, the app link, and the **Seeker store** (Android).
18+
The CLI and the VS Code extension drive your locally installed `claude` / `codex` CLI, so
19+
install and log into at least one of those first. Full per-surface guides, prerequisites,
20+
and troubleshooting: **[Install Guide](install-guide/README.md)**.
1621

1722

1823
## 0. What this doc says (TL;DR)

install-guide/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ How to install and run each AgentNet surface (app). Pick the one you want.
55
| Surface | What it is | Install |
66
|---|---|---|
77
| **Android app** | The phone app — runs the agent on your subscription, on-device. | [Download the latest APK](https://github.com/IQCoreTeam/AgentNet/releases/tag/android-latest) |
8-
| **VS Code extension** | The desktop extension — the agent inside your editor. | [vscode.md](vscode.md) |
9-
| **CLI** | The terminal surface. | [cli.md](cli.md) |
8+
| **VS Code extension** | The desktop extension — the agent inside your editor. | [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IQLabs.agentnet-vscode) ([guide](vscode.md)) |
9+
| **CLI** | The terminal surface. | `npm install -g @iqlabs-official/agentnet-cli` ([guide](cli.md)) |
1010

1111
## Android — most users
1212

1313
Install the app straight from the release: **[android-latest](https://github.com/IQCoreTeam/AgentNet/releases/tag/android-latest)**. Download the APK to your phone and open it. No build tools, no Android Studio.
1414

1515
Building from source instead (developers): see [android.md](android.md) — the dev / debugging build guide.
1616

17-
> ⚠️ Pre-release: Android, VS Code, and the CLI all currently run on **devnet** and are not
18-
> published yet. Once released this guide switches to the shipped paths: `npm install` for the
19-
> CLI, the VS Code Marketplace extension link, the app link, and the **Seeker store** for Android.
17+
> The VS Code extension is on the [Marketplace](https://marketplace.visualstudio.com/items?itemName=IQLabs.agentnet-vscode)
18+
> and the CLI installs from npm (`@iqlabs-official/agentnet-cli`). Android currently ships as
19+
> the APK release above; store listings (Seeker store, Google Play) are in progress.
2020
2121
> AgentNet is **one codebase, many surfaces** (Android, VS Code, a local web server). They
2222
> share the same core; each guide here is just how to install and launch that one surface.

install-guide/cli.md

Lines changed: 32 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
# AgentNet CLI — Dev Running Guide
1+
# AgentNet CLI
22

3-
For new devs testing the CLI surface (`surfaces/cli`).
3+
The terminal surface. Installs from npm:
44

5-
> Pre-release (devnet). Once released, this becomes a plain `npm install`.
5+
```bash
6+
npm install -g @iqlabs-official/agentnet-cli
7+
8+
agentnet # launch the TUI
9+
agentnet doctor # check claude/codex install + login (non-interactive)
10+
```
11+
12+
Requires Node.js 20+ and at least one engine (`claude` or `codex`) installed and logged
13+
in — see Prerequisites below. Developers running from source: jump to
14+
[Running from source](#running-from-source-contributors).
615

716
---
817

918
## Prerequisites
1019

11-
### 1. Node / pnpm
20+
### 1. Node
1221

1322
```bash
1423
node -v # need v20+
15-
pnpm -v # need v9+
1624
```
1725

1826
### 2. Install `claude` CLI and log in
@@ -57,39 +65,17 @@ solana-keygen new --outfile ~/.config/solana/id.json
5765

5866
> The keypair is **local only** — no tokens, no blockchain tx required for the CLI.
5967
> It's only used to derive an encryption key for your session logs.
68+
> If the default path doesn't exist, the CLI generates one there on first launch
69+
> (it never overwrites an existing file).
6070
6171
---
6272

63-
## Setup
64-
65-
Clone + install from the repo root:
66-
67-
```bash
68-
cd /path/to/AgentNet
69-
pnpm install
70-
```
71-
72-
Build core first (CLI depends on it):
73+
## First launch
7374

7475
```bash
75-
pnpm build:core
76-
```
77-
78-
---
79-
80-
## Running (dev mode — no build needed)
81-
82-
```bash
83-
# From repo root:
84-
pnpm dev:cli
85-
86-
# Or from surfaces/cli directly:
87-
cd surfaces/cli
88-
pnpm dev
76+
agentnet
8977
```
9078

91-
This runs `tsx src/index.tsx` — hot-reloads on save (via tsx watch).
92-
9379
You'll see:
9480
1. Animated IQ banner
9581
2. Boot checklist (claude ✓ / codex ✓ / wallet ✓)
@@ -98,20 +84,23 @@ You'll see:
9884

9985
---
10086

101-
## Running (built binary)
87+
## Running from source (contributors)
88+
89+
Needs pnpm v9+ (the repo is a pnpm workspace). Clone, then from the repo root:
10290

10391
```bash
104-
# Build once:
105-
pnpm build:cli
92+
pnpm install
10693

107-
# Run:
108-
node surfaces/cli/dist/cli.js
94+
# Dev mode (tsx, hot-reloads on save):
95+
pnpm dev:cli
10996

110-
# Or install globally to get `agentnet` command:
111-
npm install -g ./surfaces/cli
112-
agentnet
97+
# Or build + run the bundled binary:
98+
pnpm build:cli
99+
node surfaces/cli/dist/cli.js
113100
```
114101

102+
The build inlines the workspace core from source — no separate core build step needed.
103+
115104
---
116105

117106
## CLI Flags
@@ -242,7 +231,7 @@ When it gets high (>80%), use `/compact` to summarize.
242231
→ Usually a usage limit on your OpenAI account (not a code bug). Check `codex doctor` or your OpenAI billing.
243232

244233
**"Dynamic require of buffer not supported"**
245-
→ Build issue. Run `pnpm install` then `pnpm build:core && pnpm build:cli`.
234+
→ Build issue (source builds only). Run `pnpm install` then `pnpm build:cli`.
246235

247236
**Animations look broken in some terminals**
248237
→ Run with `--calm` flag. Or set `NO_COLOR=1` in env.
@@ -259,25 +248,15 @@ When it gets high (>80%), use `/compact` to summarize.
259248
npm install -g @anthropic-ai/claude-code
260249
claude login
261250

262-
# 2. setup
263-
cd AgentNet && pnpm install && pnpm build:core
251+
# 2. install
252+
npm install -g @iqlabs-official/agentnet-cli
264253

265254
# 3. run
266-
pnpm dev:cli
255+
agentnet
267256

268257
# 4. test
269258
# Type a message → watch claude respond with tool cards
270259
# Type /new → new session
271260
# Type !ls → bash passthrough
272261
# Press Esc mid-turn → interrupt
273262
```
274-
275-
---
276-
277-
## Branch
278-
279-
All CLI work is on `feat/agentnet-cli`. Base branch: `agentnet` (from `main`).
280-
281-
```bash
282-
git checkout feat/agentnet-cli
283-
```

install-guide/vscode.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
1-
# Running AgentNet in VS Code
1+
# AgentNet in VS Code
22

3-
How to run the AgentNet **VS Code extension** — the agent inside your editor. No prior
4-
extension-development experience needed.
3+
The AgentNet **VS Code extension** — the agent inside your editor.
54

6-
> Pre-release (devnet). Once released, install it straight from the VS Code Marketplace.
5+
## Install (Marketplace)
6+
7+
Install **[AgentNet from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=IQLabs.agentnet-vscode)**:
8+
search "AgentNet" in the Extensions view (`Cmd/Ctrl+Shift+X`), or run:
9+
10+
```bash
11+
code --install-extension IQLabs.agentnet-vscode
12+
```
13+
14+
Then install at least one agent CLI (Step 1 below), open the Command Palette and run
15+
**"AgentNet: Open Chat"** (Step 4). Steps 2 and 3 are only for developers running the
16+
extension from source.
717

818
- [How this differs from the phone app](#how-this-differs-from-the-phone-app)
919
- [What you need](#what-you-need)
1020
- [Step 1 — Install the agent CLIs](#step-1--install-the-agent-clis)
11-
- [Step 2 — Get the code & build](#step-2--get-the-code--build)
12-
- [Step 3 — Launch the extension (F5)](#step-3--launch-the-extension-f5)
21+
- [Step 2 — (from source) Get the code & build](#step-2--from-source-get-the-code--build)
22+
- [Step 3 — (from source) Launch the extension (F5)](#step-3--from-source-launch-the-extension-f5)
1323
- [Step 4 — Open the chat](#step-4--open-the-chat)
1424
- [Troubleshooting](#troubleshooting)
1525

@@ -28,11 +38,9 @@ So the order matters: **install and sign into the CLIs first**, then run the ext
2838
## What you need
2939

3040
- **VS Code**https://code.visualstudio.com
31-
- **Node.js 20+** and **pnpm** (the repo is a pnpm workspace).
32-
- Install Node: https://nodejs.org (LTS).
33-
- Install pnpm: `npm install -g pnpm`
41+
- **Node.js 20+**https://nodejs.org (LTS), needed for the agent CLIs.
3442
- **claude** and/or **codex** CLI installed and logged in (see Step 1).
35-
- The repo cloned to your computer.
43+
- Running from source instead? Also **pnpm** (`npm install -g pnpm`) and the repo cloned.
3644

3745
---
3846

@@ -62,7 +70,9 @@ global bin is on your `PATH`.
6270

6371
---
6472

65-
## Step 2 — Get the code & build
73+
## Step 2 — (from source) Get the code & build
74+
75+
> Marketplace users skip this and Step 3 — go straight to [Step 4](#step-4--open-the-chat).
6676
6777
From the repo root:
6878

@@ -77,7 +87,7 @@ pnpm build:vscode # build the extension (outputs surfaces/vscode/dist)
7787
7888
---
7989

80-
## Step 3 — Launch the extension (F5)
90+
## Step 3 — (from source) Launch the extension (F5)
8191

8292
The extension runs in a second VS Code window ("Extension Development Host").
8393

@@ -94,7 +104,7 @@ The extension runs in a second VS Code window ("Extension Development Host").
94104

95105
## Step 4 — Open the chat
96106

97-
In the new (Extension Development Host) window:
107+
In VS Code (Marketplace install) or the Extension Development Host window (source install):
98108

99109
1. Open the Command Palette: **Cmd+Shift+P** (Mac) / **Ctrl+Shift+P** (Windows).
100110
2. Run **"AgentNet: Open Chat"** (or **"AgentNet: New Chat (new tab)"** for a fresh tab).

0 commit comments

Comments
 (0)