starcite 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -39
- package/dist/index.js +427 -385
- package/dist/index.js.map +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -41,24 +41,16 @@ For temporary usage, use `npx starcite` or `bunx starcite` instead of installing
|
|
|
41
41
|
## Quick Start
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
starcite
|
|
44
|
+
starcite config set endpoint https://<your-instance>.starcite.io
|
|
45
|
+
starcite config set api-key <YOUR_API_KEY>
|
|
45
46
|
starcite create --id ses_demo --title "Draft contract"
|
|
46
47
|
starcite sessions list --limit 5
|
|
47
48
|
starcite append ses_demo --agent researcher --text "Found 8 relevant cases..."
|
|
48
|
-
starcite append ses_demo --agent drafter --text "Drafted section 2 with clause references."
|
|
49
49
|
starcite tail ses_demo --cursor 0 --limit 1
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
## Cloud Setup
|
|
53
53
|
|
|
54
|
-
```bash
|
|
55
|
-
starcite init
|
|
56
|
-
starcite config set endpoint https://<your-instance>.starcite.io
|
|
57
|
-
starcite auth login
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
Non-interactive alternative:
|
|
61
|
-
|
|
62
54
|
```bash
|
|
63
55
|
starcite config set endpoint https://<your-instance>.starcite.io
|
|
64
56
|
starcite config set api-key <YOUR_KEY>
|
|
@@ -67,7 +59,7 @@ starcite config set api-key <YOUR_KEY>
|
|
|
67
59
|
## Global Options
|
|
68
60
|
|
|
69
61
|
- `-u, --base-url <url>`: Starcite API base URL (highest precedence)
|
|
70
|
-
- `-k, --token <
|
|
62
|
+
- `-k, --token <key>`: Starcite API key (highest precedence)
|
|
71
63
|
- `--config-dir <path>`: Starcite CLI config directory (defaults to `~/.starcite`)
|
|
72
64
|
- `--json`: machine-readable JSON output
|
|
73
65
|
- `-v, --version`: show CLI version and exit
|
|
@@ -121,22 +113,6 @@ Useful flags:
|
|
|
121
113
|
- `--cursor <cursor>`: pagination cursor from previous result
|
|
122
114
|
- `--metadata <json>`: flat JSON object of exact-match metadata filters
|
|
123
115
|
|
|
124
|
-
### `init`
|
|
125
|
-
|
|
126
|
-
Initialize config for remote usage.
|
|
127
|
-
|
|
128
|
-
Behavior:
|
|
129
|
-
|
|
130
|
-
- writes endpoint to `~/.starcite/config.json`
|
|
131
|
-
- optionally stores API key
|
|
132
|
-
- supports interactive prompts when flags are omitted
|
|
133
|
-
|
|
134
|
-
Useful flags:
|
|
135
|
-
|
|
136
|
-
- `--endpoint <url>`: endpoint to store
|
|
137
|
-
- `--api-key <key>`: API key to save
|
|
138
|
-
- `-y, --yes`: skip prompts and use provided values only
|
|
139
|
-
|
|
140
116
|
### `config`
|
|
141
117
|
|
|
142
118
|
Manage local configuration.
|
|
@@ -153,18 +129,6 @@ Key aliases accepted by `config set`:
|
|
|
153
129
|
- producer id: `producer-id`, `producer_id`
|
|
154
130
|
- API key: `api-key`, `api_key`
|
|
155
131
|
|
|
156
|
-
### `auth`
|
|
157
|
-
|
|
158
|
-
Manage API key auth.
|
|
159
|
-
|
|
160
|
-
```bash
|
|
161
|
-
starcite auth login
|
|
162
|
-
starcite auth status
|
|
163
|
-
starcite auth logout
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
`auth login` supports `--api-key <key>` for non-interactive flows.
|
|
167
|
-
|
|
168
132
|
### `up`
|
|
169
133
|
|
|
170
134
|
Start local Starcite containers through an interactive wizard (Docker required).
|
|
@@ -248,3 +212,12 @@ starcite tail ses_demo --agent drafter --limit 5 --json
|
|
|
248
212
|
```
|
|
249
213
|
|
|
250
214
|
Press `Ctrl+C` to stop.
|
|
215
|
+
|
|
216
|
+
Useful flags:
|
|
217
|
+
|
|
218
|
+
- `--cursor <cursor>`: replay cursor (inclusive)
|
|
219
|
+
- `--agent <agent>`: filter to one `agent:<name>`
|
|
220
|
+
- `--limit <count>`: stop after N emitted events
|
|
221
|
+
- `--no-follow`: stop after replay instead of following live events
|
|
222
|
+
|
|
223
|
+
By default, `tail` requests batched replay frames from the API for faster catch-up.
|