Skip to content

Commit 76be9dc

Browse files
committed
docs(cli): document all commands and exposed tools
1 parent e41e42b commit 76be9dc

1 file changed

Lines changed: 92 additions & 1 deletion

File tree

README.md

Lines changed: 92 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,57 @@ Words you will see elsewhere in this doc: **network** = a community you are in;
3535

3636
## Commands
3737

38+
### Command reference
39+
40+
Every exposed CLI command is listed below. Add `--json` for machine-readable
41+
results; `conversation stream --json` emits one event per line. Command-specific
42+
flags are listed in [Options](#options), and examples follow this reference.
43+
44+
| Command | Function |
45+
| --- | --- |
46+
| `index help` | Show global help; also available as `index`, `index --help`, or `index -h`. |
47+
| `index version` | Show the installed version; also available as `index --version` or `index -v`. |
48+
| `index login` | Sign in through the browser and store this device's session. |
49+
| `index logout` | Revoke and clear the stored device session. |
50+
| `index tool list` | List the API's protocol functions, descriptions, and input schemas. |
51+
| `index tool call <name> --query '<json object>'` | Invoke any function in the [protocol tool reference](#protocol-tool-reference). |
52+
| `index agent me` | Read the agent selected to handle your negotiations. |
53+
| `index profile` | Show your own profile. |
54+
| `index profile show <user-id>` | Show another user's accessible profile. |
55+
| `index profile sync` | Research public profile information and return a suggested profile without persisting it. |
56+
| `index intent list` | List signals, with optional archived and result-limit filters. |
57+
| `index intent show <id>` | Show one signal. |
58+
| `index intent create <text>` | Create a signal from its description. |
59+
| `index intent update <id> <text>` | Update and reprocess a signal's description. |
60+
| `index intent archive <id>` | Archive a signal so it stops participating in discovery. |
61+
| `index intent add-to-network <id> <network-id>` | Share a signal in a network. |
62+
| `index intent remove-from-network <id> <network-id>` | Stop sharing a signal in a network. |
63+
| `index negotiation list` | List negotiations, optionally filtered by intent or open/settled state. |
64+
| `index negotiation show <opportunity-id>` | Read the negotiation's turns, current state, and available actions. |
65+
| `index negotiation turn <opportunity-id> --action <action> --message <text> --expected-turn-count <n>` | Submit one `propose`, `counter`, `accept`, or `decline` turn against the observed turn count. |
66+
| `index opportunity list` | List persisted opportunities, with optional status and result-limit filters. |
67+
| `index opportunity show <id>` | Show an opportunity's presentation and participants. |
68+
| `index opportunity accept <id>` | Request acceptance through the server's owner-approval flow. |
69+
| `index opportunity reject <id>` | Reject an opportunity. |
70+
| `index network list` | List your networks. |
71+
| `index network create <title>` | Create a network when eligible, or submit an early-access creation request. |
72+
| `index network show <id>` | Show a network and its members. |
73+
| `index network update <id> --title <text>` | Change a network's title. |
74+
| `index network delete <id>` | Delete a network you own. |
75+
| `index network join <id>` | Join an open network. |
76+
| `index network leave <id>` | Leave a network. |
77+
| `index network invite <id> <email>` | Invite a member by email. |
78+
| `index conversation list` | List your conversations. |
79+
| `index conversation with <user-id>` | Open or resume a human DM. |
80+
| `index conversation show <id>` | Read messages; use `agent --intent-id <id>` for the personal agent's scoped messages and pending question. |
81+
| `index conversation send <id> <text>` | Send a message; for `agent`, supply `--intent-id` and the displayed `--question-id` when answering a question. |
82+
| `index conversation stream` | Subscribe to conversation, negotiation, opportunity, and intent events over SSE. |
83+
| `index conversation help` | Show conversation-specific help. |
84+
| `index onboarding confirm-profile` | Confirm that the owner has reviewed their profile. |
85+
| `index onboarding complete` | Complete onboarding once profile confirmation and first-signal prerequisites are met. |
86+
| `index scrape <url>` | Extract text from a URL, optionally guided by an objective. |
87+
| `index sync` | Read your profile, networks, and signals into `~/.index/context.json`, or stdout with `--json`. |
88+
3889
### `index login`
3990

4091
Authenticate with Index Network. Opens a browser window that runs the device authorization grant against your existing session (or a fresh login), then hands this machine a session of its own.
@@ -72,6 +123,39 @@ index agent me --json
72123
Tool discovery includes the actual input schemas. `--query` must be a JSON
73124
object; tool failures produce a structured error and a nonzero exit status.
74125

126+
#### Protocol tool reference
127+
128+
The API in this release exposes these 20 functions through `index tool call`.
129+
Run `index tool list --json` against your selected API to read each function's
130+
current input schema. The API enforces ownership, membership, and permission
131+
checks when a function is invoked.
132+
133+
| Function | Purpose |
134+
| --- | --- |
135+
| `research_profile` | Research public identity information and return a suggested profile without persisting it. |
136+
| `read_intents` | Read accessible signals with user, network, and pagination filters. |
137+
| `create_intent` | Create a signal and link it to the explicitly supplied networks. |
138+
| `update_intent` | Revise and reprocess a signal's description. |
139+
| `delete_intent` | Archive a signal. |
140+
| `add_intent_to_network` | Share a signal in a network. |
141+
| `list_intent_networks` | List the networks a signal is shared in. |
142+
| `remove_intent_from_network` | Remove a signal's link to a network. |
143+
| `search_intents` | Search accessible signals by semantic similarity. |
144+
| `read_networks` | Read accessible networks and their details. |
145+
| `read_network_memberships` | Read network memberships and member information. |
146+
| `update_network` | Update a network's settings. |
147+
| `create_network` | Create a network, subject to the API's creation permissions. |
148+
| `delete_network` | Delete a network you own. |
149+
| `create_network_membership` | Join an open network or add a member when authorized. |
150+
| `delete_network_membership` | Remove a member from a network you own. |
151+
| `list_opportunities` | Read persisted opportunities and their presentation. |
152+
| `update_opportunity` | Request an opportunity status transition under the server's lifecycle rules. |
153+
| `scrape_url` | Extract text from a URL with an optional objective. |
154+
| `read_docs` | Read canonical protocol guidance, optionally narrowed to a topic. |
155+
156+
Agent identity, negotiation turns, conversations, and onboarding use their
157+
dedicated commands above and the corresponding REST endpoints.
158+
75159
### `index logout`
76160

77161
Revoke this machine's session server-side, then clear the local credential file. A session can revoke itself, so sign-out takes effect immediately without needing your browser. If the server cannot be reached the local file is still cleared, and logout tells you to revoke the device in Index web settings. If local cleanup fails, logout exits nonzero and asks you to remove the file manually.
@@ -236,10 +320,17 @@ index opportunity reject <id>
236320
| `--app-url <url>` | | Override app URL for login (default: `https://index.network`) |
237321
| `--archived` | | Include archived signals (intent list) |
238322
| `--status <status>` | | Filter opportunities by status |
239-
| `--limit <n>` | | Limit number of results |
323+
| `--limit <n>` | | Positive result limit for intent/opportunity lists or conversation messages |
240324
| `--prompt <text>` | `-p` | Network description (for `network create`) |
241325
| `--title <text>` | | Network title (for `network update`) |
242326
| `--objective <text>` | | Focus objective (for `scrape`) |
327+
| `--query <json>` | | Required JSON object for `tool call` |
328+
| `--intent-id <id>` | | Filter negotiations, scope agent conversations, or select onboarding's first signal |
329+
| `--state <state>` | | Filter negotiations by `open` or `settled` |
330+
| `--action <action>` | | Required negotiation turn action: `propose`, `counter`, `accept`, or `decline` |
331+
| `--message <text>` | | Required message for a negotiation turn |
332+
| `--expected-turn-count <n>` | | Required observed nonnegative integer turn count for a negotiation turn |
333+
| `--question-id <id>` | | Identify the displayed question when answering the personal agent |
243334
| `--json` | | Output raw JSON to stdout |
244335
| `--help` | `-h` | Show help |
245336
| `--version` | `-v` | Show version |

0 commit comments

Comments
 (0)