@gobi-ai/cli 0.7.3 → 0.9.0
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/.claude-plugin/marketplace.json +9 -5
- package/.claude-plugin/plugin.json +7 -3
- package/dist/commands/media.js +379 -0
- package/dist/main.js +2 -0
- package/package.json +2 -2
- package/skills/gobi-brain/SKILL.md +56 -0
- package/skills/{gobi/SKILL.template.md → gobi-core/SKILL.md} +27 -63
- package/skills/gobi-core/references/space.md +48 -0
- package/skills/{gobi-dev-homepage → gobi-homepage}/SKILL.md +8 -8
- package/skills/gobi-media/SKILL.md +57 -0
- package/skills/gobi-media/references/media.md +198 -0
- package/skills/gobi-sense/SKILL.md +34 -0
- package/skills/gobi-space/SKILL.md +58 -0
- package/skills/{gobi → gobi-space}/references/space.md +0 -22
- package/skills/gobi/SKILL.md +0 -216
- package/skills/gobi/scripts/generate-docs.ts +0 -199
- /package/skills/{gobi → gobi-brain}/references/brain.md +0 -0
- /package/skills/{gobi → gobi-core}/references/auth.md +0 -0
- /package/skills/{gobi → gobi-core}/references/init.md +0 -0
- /package/skills/{gobi → gobi-core}/references/session.md +0 -0
- /package/skills/{gobi → gobi-core}/references/sync.md +0 -0
- /package/skills/{gobi → gobi-core}/references/update.md +0 -0
- /package/skills/{gobi → gobi-sense}/references/sense.md +0 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# gobi space
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
Usage: gobi space [options] [command]
|
|
5
|
+
|
|
6
|
+
Space commands (threads, replies).
|
|
7
|
+
|
|
8
|
+
Options:
|
|
9
|
+
--space-slug <slug> Space slug (overrides .gobi/settings.yaml)
|
|
10
|
+
-h, --help display help for command
|
|
11
|
+
|
|
12
|
+
Commands:
|
|
13
|
+
list List spaces you are a member of.
|
|
14
|
+
warp [spaceSlug] Select the active space. Pass a slug to warp directly, or omit for interactive selection.
|
|
15
|
+
list-topics [options] List topics in a space, ordered by most recent content linkage.
|
|
16
|
+
list-topic-threads [options] <topicSlug> List threads tagged with a topic in a space (cursor-paginated).
|
|
17
|
+
get-thread [options] <threadId> Get a thread and its replies (paginated).
|
|
18
|
+
list-threads [options] List threads in a space (paginated).
|
|
19
|
+
create-thread [options] Create a thread in a space.
|
|
20
|
+
edit-thread [options] <threadId> Edit a thread. You must be the author.
|
|
21
|
+
delete-thread <threadId> Delete a thread. You must be the author.
|
|
22
|
+
create-reply [options] <threadId> Create a reply to a thread in a space.
|
|
23
|
+
edit-reply [options] <replyId> Edit a reply. You must be the author.
|
|
24
|
+
delete-reply <replyId> Delete a reply. You must be the author.
|
|
25
|
+
help [command] display help for command
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## list
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Usage: gobi space list [options]
|
|
32
|
+
|
|
33
|
+
List spaces you are a member of.
|
|
34
|
+
|
|
35
|
+
Options:
|
|
36
|
+
-h, --help display help for command
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## warp
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
Usage: gobi space warp [options] [spaceSlug]
|
|
43
|
+
|
|
44
|
+
Select the active space. Pass a slug to warp directly, or omit for interactive selection.
|
|
45
|
+
|
|
46
|
+
Options:
|
|
47
|
+
-h, --help display help for command
|
|
48
|
+
```
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: gobi-homepage
|
|
3
3
|
description: >-
|
|
4
|
-
Developer reference for building Gobi
|
|
4
|
+
Developer reference for building Gobi Homepages — custom HTML pages hosted on
|
|
5
5
|
webdrive and served as a vault's public homepage at gobispace.com/@{vaultSlug}.
|
|
6
|
-
Use when a developer wants to build or modify a vault homepage
|
|
6
|
+
Use when a developer wants to build or modify a vault homepage.
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
# Gobi
|
|
9
|
+
# Gobi Homepage Developer Guide
|
|
10
10
|
|
|
11
|
-
A **Gobi
|
|
11
|
+
A **Gobi Homepage** is a custom HTML page hosted on a vault's webdrive and served as its public homepage at `https://gobispace.com/@{vaultSlug}`. Gobi injects a `window.gobi` bridge before any scripts run, giving the homepage access to vault data, files, brain updates, and chat.
|
|
12
12
|
|
|
13
|
-
> **Sandbox:** The
|
|
13
|
+
> **Sandbox:** The homepage runs in a sandboxed iframe with `origin: null`. Direct `fetch()` / `XMLHttpRequest` calls are blocked by CORS. All data access must go through `window.gobi.*`.
|
|
14
14
|
|
|
15
15
|
---
|
|
16
16
|
|
|
@@ -20,9 +20,9 @@ A **Gobi Applet** is a custom HTML page hosted on a vault's webdrive and served
|
|
|
20
20
|
```bash
|
|
21
21
|
gobi sync
|
|
22
22
|
```
|
|
23
|
-
2. Set `
|
|
24
|
-
- `app/home.html` — Gobi sidebars visible alongside the
|
|
25
|
-
- `app/home.html?nav=false` — full-screen, no Gobi chrome
|
|
23
|
+
2. Set `homepage` in BRAIN.md (homepage property):
|
|
24
|
+
- `homepage: "[[app/home.html]]"` — Gobi sidebars visible alongside the homepage
|
|
25
|
+
- `homepage: "[[app/home.html?nav=false]]"` — full-screen, no Gobi chrome
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gobi-media
|
|
3
|
+
description: >-
|
|
4
|
+
Gobi media generation: generate images from text prompts (thumbnails,
|
|
5
|
+
assets, logos), edit and inpaint images, create avatar videos with voice
|
|
6
|
+
narration, list available avatars and voices, upload media files. Use when
|
|
7
|
+
the user wants to generate images, create videos, or manage media.
|
|
8
|
+
allowed-tools: Bash(gobi:*)
|
|
9
|
+
metadata:
|
|
10
|
+
author: gobi-ai
|
|
11
|
+
version: "0.8.0"
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# gobi-media
|
|
15
|
+
|
|
16
|
+
Gobi media generation commands (v0.8.0).
|
|
17
|
+
|
|
18
|
+
Requires gobi-cli installed and authenticated. See gobi-core skill for setup.
|
|
19
|
+
|
|
20
|
+
## Important: JSON Mode
|
|
21
|
+
|
|
22
|
+
For programmatic/agent usage, always pass `--json` as a **global** option (before the subcommand):
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
gobi --json media image-generate --prompt "a sunset over mountains"
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Available Commands
|
|
29
|
+
|
|
30
|
+
### Upload
|
|
31
|
+
|
|
32
|
+
- `gobi media upload-init` — Get a presigned upload URL for a media file.
|
|
33
|
+
- `gobi media upload-finalize` — Confirm that a media upload is complete.
|
|
34
|
+
|
|
35
|
+
### Avatars & Voices
|
|
36
|
+
|
|
37
|
+
- `gobi media avatars` — List available avatars.
|
|
38
|
+
- `gobi media voices` — List available voices.
|
|
39
|
+
|
|
40
|
+
### Videos
|
|
41
|
+
|
|
42
|
+
- `gobi media video-create` — Create an avatar video generation job.
|
|
43
|
+
- `gobi media video-list` — List all videos.
|
|
44
|
+
- `gobi media video-get` — Get video metadata.
|
|
45
|
+
- `gobi media video-status` — Poll video generation status.
|
|
46
|
+
- `gobi media video-download` — Get the download URL for a completed video.
|
|
47
|
+
|
|
48
|
+
### Images
|
|
49
|
+
|
|
50
|
+
- `gobi media image-generate` — Generate an image from a text prompt. Types: image (default), thumbnail (YouTube-optimized), asset (logo/product). Aspect ratios: 1:1, 16:9, 9:16, 4:3, 3:4
|
|
51
|
+
- `gobi media image-edit` — Edit an existing image with a prompt (image-to-image).
|
|
52
|
+
- `gobi media image-inpaint` — Inpaint an image region using a mask.
|
|
53
|
+
- `gobi media image-status` — Check image generation job status.
|
|
54
|
+
|
|
55
|
+
## Reference Documentation
|
|
56
|
+
|
|
57
|
+
- [gobi media](references/media.md)
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# gobi media
|
|
2
|
+
|
|
3
|
+
```
|
|
4
|
+
Usage: gobi media [options] [command]
|
|
5
|
+
|
|
6
|
+
Media generation commands (videos, images).
|
|
7
|
+
|
|
8
|
+
Options:
|
|
9
|
+
-h, --help display help for command
|
|
10
|
+
|
|
11
|
+
Commands:
|
|
12
|
+
upload-init [options] Get a presigned upload URL for a media file.
|
|
13
|
+
upload-finalize [options] Confirm that a media upload is complete.
|
|
14
|
+
avatars List available avatars.
|
|
15
|
+
voices List available voices.
|
|
16
|
+
video-create [options] Create an avatar video generation job.
|
|
17
|
+
video-list List all videos.
|
|
18
|
+
video-get <id> Get video metadata.
|
|
19
|
+
video-status [options] <id> Poll video generation status.
|
|
20
|
+
video-download <id> Get the download URL for a completed video.
|
|
21
|
+
image-generate [options] Generate an image from a text prompt. Types: image (default), thumbnail (YouTube-optimized), asset (logo/product). Aspect ratios: 1:1, 16:9, 9:16, 4:3, 3:4
|
|
22
|
+
image-edit [options] Edit an existing image with a prompt (image-to-image).
|
|
23
|
+
image-inpaint [options] Inpaint an image region using a mask.
|
|
24
|
+
image-status [options] <jobId> Check image generation job status.
|
|
25
|
+
help [command] display help for command
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## upload-init
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Usage: gobi media upload-init [options]
|
|
32
|
+
|
|
33
|
+
Get a presigned upload URL for a media file.
|
|
34
|
+
|
|
35
|
+
Options:
|
|
36
|
+
--file-name <fileName> Name of the file to upload
|
|
37
|
+
--content-type <contentType> MIME type (e.g. image/png, video/mp4)
|
|
38
|
+
--file-size <fileSize> File size in bytes
|
|
39
|
+
-h, --help display help for command
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## upload-finalize
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
Usage: gobi media upload-finalize [options]
|
|
46
|
+
|
|
47
|
+
Confirm that a media upload is complete.
|
|
48
|
+
|
|
49
|
+
Options:
|
|
50
|
+
--media-id <mediaId> Media ID from upload-init
|
|
51
|
+
-h, --help display help for command
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## avatars
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
Usage: gobi media avatars [options]
|
|
58
|
+
|
|
59
|
+
List available avatars.
|
|
60
|
+
|
|
61
|
+
Options:
|
|
62
|
+
-h, --help display help for command
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## voices
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
Usage: gobi media voices [options]
|
|
69
|
+
|
|
70
|
+
List available voices.
|
|
71
|
+
|
|
72
|
+
Options:
|
|
73
|
+
-h, --help display help for command
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## video-create
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
Usage: gobi media video-create [options]
|
|
80
|
+
|
|
81
|
+
Create an avatar video generation job.
|
|
82
|
+
|
|
83
|
+
Options:
|
|
84
|
+
--name <name> Name for the video
|
|
85
|
+
--avatar-id <avatarId> Avatar to use
|
|
86
|
+
--voice-id <voiceId> Voice to use
|
|
87
|
+
--script <script> Script for the avatar to read
|
|
88
|
+
--background-media-id <backgroundMediaId> Background media ID (from upload)
|
|
89
|
+
--wait Poll until generation completes
|
|
90
|
+
-h, --help display help for command
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## video-list
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Usage: gobi media video-list [options]
|
|
97
|
+
|
|
98
|
+
List all videos.
|
|
99
|
+
|
|
100
|
+
Options:
|
|
101
|
+
-h, --help display help for command
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## video-get
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
Usage: gobi media video-get [options] <id>
|
|
108
|
+
|
|
109
|
+
Get video metadata.
|
|
110
|
+
|
|
111
|
+
Options:
|
|
112
|
+
-h, --help display help for command
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## video-status
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
Usage: gobi media video-status [options] <id>
|
|
119
|
+
|
|
120
|
+
Poll video generation status.
|
|
121
|
+
|
|
122
|
+
Options:
|
|
123
|
+
--wait Poll until a terminal state is reached
|
|
124
|
+
-h, --help display help for command
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## video-download
|
|
128
|
+
|
|
129
|
+
```
|
|
130
|
+
Usage: gobi media video-download [options] <id>
|
|
131
|
+
|
|
132
|
+
Get the download URL for a completed video.
|
|
133
|
+
|
|
134
|
+
Options:
|
|
135
|
+
-h, --help display help for command
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## image-generate
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
Usage: gobi media image-generate [options]
|
|
142
|
+
|
|
143
|
+
Generate an image from a text prompt. Types: image (default), thumbnail (YouTube-optimized), asset (logo/product). Aspect ratios: 1:1, 16:9, 9:16, 4:3, 3:4
|
|
144
|
+
|
|
145
|
+
Options:
|
|
146
|
+
--prompt <prompt> Text prompt for image generation
|
|
147
|
+
--name <name> Name for the generated image
|
|
148
|
+
--type <type> Generation type: image (default), thumbnail (YouTube-optimized), asset (logo/product)
|
|
149
|
+
--aspect-ratio <aspectRatio> Aspect ratio (1:1, 16:9, 9:16, 4:3, 3:4)
|
|
150
|
+
--negative-prompt <negativePrompt> Negative prompt
|
|
151
|
+
--seed <seed> Random seed for reproducibility
|
|
152
|
+
--reference-media-id <referenceMediaId> Reference image media ID
|
|
153
|
+
--wait Poll until generation completes
|
|
154
|
+
-h, --help display help for command
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## image-edit
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
Usage: gobi media image-edit [options]
|
|
161
|
+
|
|
162
|
+
Edit an existing image with a prompt (image-to-image).
|
|
163
|
+
|
|
164
|
+
Options:
|
|
165
|
+
--media-id <mediaId> Source image media ID
|
|
166
|
+
--prompt <prompt> Edit instruction
|
|
167
|
+
--name <name> Name for the edited image
|
|
168
|
+
--wait Poll until generation completes
|
|
169
|
+
-h, --help display help for command
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## image-inpaint
|
|
173
|
+
|
|
174
|
+
```
|
|
175
|
+
Usage: gobi media image-inpaint [options]
|
|
176
|
+
|
|
177
|
+
Inpaint an image region using a mask.
|
|
178
|
+
|
|
179
|
+
Options:
|
|
180
|
+
--media-id <mediaId> Source image media ID
|
|
181
|
+
--mask-media-id <maskMediaId> Mask image media ID
|
|
182
|
+
--prompt <prompt> Inpainting prompt
|
|
183
|
+
--name <name> Name for the inpainted image
|
|
184
|
+
--wait Poll until generation completes
|
|
185
|
+
-h, --help display help for command
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## image-status
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
Usage: gobi media image-status [options] <jobId>
|
|
192
|
+
|
|
193
|
+
Check image generation job status.
|
|
194
|
+
|
|
195
|
+
Options:
|
|
196
|
+
--wait Poll until a terminal state is reached
|
|
197
|
+
-h, --help display help for command
|
|
198
|
+
```
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gobi-sense
|
|
3
|
+
description: >-
|
|
4
|
+
Gobi sense commands for activity and transcription data: fetch activity
|
|
5
|
+
records and transcription records within a time range. Use when the user
|
|
6
|
+
wants to review their activities or transcriptions from Gobi Sense.
|
|
7
|
+
allowed-tools: Bash(gobi:*)
|
|
8
|
+
metadata:
|
|
9
|
+
author: gobi-ai
|
|
10
|
+
version: "0.8.0"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# gobi-sense
|
|
14
|
+
|
|
15
|
+
Gobi sense commands for activity and transcription data (v0.8.0).
|
|
16
|
+
|
|
17
|
+
Requires gobi-cli installed and authenticated. See gobi-core skill for setup.
|
|
18
|
+
|
|
19
|
+
## Important: JSON Mode
|
|
20
|
+
|
|
21
|
+
For programmatic/agent usage, always pass `--json` as a **global** option (before the subcommand):
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
gobi --json sense activities --from 2024-01-01 --to 2024-01-31
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Available Commands
|
|
28
|
+
|
|
29
|
+
- `gobi sense activities` — Fetch activity records within a time range.
|
|
30
|
+
- `gobi sense transcriptions` — Fetch transcription records within a time range.
|
|
31
|
+
|
|
32
|
+
## Reference Documentation
|
|
33
|
+
|
|
34
|
+
- [gobi sense](references/sense.md)
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: gobi-space
|
|
3
|
+
description: >-
|
|
4
|
+
Gobi space commands for community interaction: list/create/edit/delete
|
|
5
|
+
threads and replies, browse topics and topic threads, explore what's
|
|
6
|
+
happening in a space. Use when the user wants to read, write, or manage
|
|
7
|
+
threads and replies in their Gobi community spaces.
|
|
8
|
+
allowed-tools: Bash(gobi:*)
|
|
9
|
+
metadata:
|
|
10
|
+
author: gobi-ai
|
|
11
|
+
version: "0.8.0"
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# gobi-space
|
|
15
|
+
|
|
16
|
+
Gobi space commands for community interaction (v0.8.0).
|
|
17
|
+
|
|
18
|
+
Requires gobi-cli installed and authenticated. See gobi-core skill for setup.
|
|
19
|
+
|
|
20
|
+
## Gobi Space — Community Channel
|
|
21
|
+
|
|
22
|
+
`gobi space` is the main interface for interacting with the user's Gobi community. When the user asks about what's happening, what others are discussing, or wants to engage with their community — use `gobi space` commands. Think of it as the user's community feed and communication hub.
|
|
23
|
+
|
|
24
|
+
- When the user wants to explore or catch up on what's happening in their space, invoke `/gobi:space-explore`.
|
|
25
|
+
- When the user wants to share or post learnings from the current session, invoke `/gobi:space-share`.
|
|
26
|
+
|
|
27
|
+
## Space Slug Override
|
|
28
|
+
|
|
29
|
+
`gobi space` commands use the space from `.gobi/settings.yaml`. Override it with a parent-level flag:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
gobi space --space-slug <slug> list-threads
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Important: JSON Mode
|
|
36
|
+
|
|
37
|
+
For programmatic/agent usage, always pass `--json` as a **global** option (before the subcommand):
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
gobi --json space list-threads
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Available Commands
|
|
44
|
+
|
|
45
|
+
- `gobi space list-topics` — List topics in a space, ordered by most recent content linkage.
|
|
46
|
+
- `gobi space list-topic-threads` — List threads tagged with a topic in a space (cursor-paginated).
|
|
47
|
+
- `gobi space get-thread` — Get a thread and its replies (paginated).
|
|
48
|
+
- `gobi space list-threads` — List threads in a space (paginated).
|
|
49
|
+
- `gobi space create-thread` — Create a thread in a space.
|
|
50
|
+
- `gobi space edit-thread` — Edit a thread. You must be the author.
|
|
51
|
+
- `gobi space delete-thread` — Delete a thread. You must be the author.
|
|
52
|
+
- `gobi space create-reply` — Create a reply to a thread in a space.
|
|
53
|
+
- `gobi space edit-reply` — Edit a reply. You must be the author.
|
|
54
|
+
- `gobi space delete-reply` — Delete a reply. You must be the author.
|
|
55
|
+
|
|
56
|
+
## Reference Documentation
|
|
57
|
+
|
|
58
|
+
- [gobi space](references/space.md)
|
|
@@ -25,28 +25,6 @@ Commands:
|
|
|
25
25
|
help [command] display help for command
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
## list
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
Usage: gobi space list [options]
|
|
32
|
-
|
|
33
|
-
List spaces you are a member of.
|
|
34
|
-
|
|
35
|
-
Options:
|
|
36
|
-
-h, --help display help for command
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## warp
|
|
40
|
-
|
|
41
|
-
```
|
|
42
|
-
Usage: gobi space warp [options] [spaceSlug]
|
|
43
|
-
|
|
44
|
-
Select the active space. Pass a slug to warp directly, or omit for interactive selection.
|
|
45
|
-
|
|
46
|
-
Options:
|
|
47
|
-
-h, --help display help for command
|
|
48
|
-
```
|
|
49
|
-
|
|
50
28
|
## list-topics
|
|
51
29
|
|
|
52
30
|
```
|
package/skills/gobi/SKILL.md
DELETED
|
@@ -1,216 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: gobi-cli
|
|
3
|
-
description: >-
|
|
4
|
-
Manage the Gobi collaborative knowledge platform from the command line.
|
|
5
|
-
Gobi space is the user's main channel for social interactions and engaging with
|
|
6
|
-
the outside world — checking what's happening, reading and writing threads,
|
|
7
|
-
and collaborating with others.
|
|
8
|
-
Use when the user wants to interact with Gobi spaces, vaults, brains, threads,
|
|
9
|
-
sessions, or brain updates.
|
|
10
|
-
allowed-tools: Bash(gobi:*)
|
|
11
|
-
metadata:
|
|
12
|
-
author: gobi-ai
|
|
13
|
-
version: "0.7.3"
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
# gobi-cli
|
|
17
|
-
|
|
18
|
-
A CLI client for the Gobi collaborative knowledge platform (v0.7.3).
|
|
19
|
-
|
|
20
|
-
## Prerequisites
|
|
21
|
-
|
|
22
|
-
Verify the CLI is installed:
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
gobi --version
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
If not installed:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
npm install -g @gobi-ai/cli
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
Or via Homebrew:
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
brew tap gobi-ai/tap && brew install gobi
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Key Concepts
|
|
41
|
-
|
|
42
|
-
- **Space**: A shared space for a group or community. A logged-in user can be a member of one or more spaces. A space contains threads, sessions, brain updates, and connected vaults.
|
|
43
|
-
- **Vault**: A filetree storage of information and knowledge. A local directory becomes a vault when it contains `.gobi/settings.yaml` with a vault slug and a space slug. Each vault is identified by a slug (e.g. `brave-path-zr962w`).
|
|
44
|
-
- **Brain**: Another name for a vault when referring to its AI-searchable knowledge. You can search brains, ask them questions, and publish a `BRAIN.md` document to configure your vault's brain.
|
|
45
|
-
|
|
46
|
-
## First-Time Setup
|
|
47
|
-
|
|
48
|
-
The CLI requires three setup steps: authentication, vault initialization, and space selection.
|
|
49
|
-
|
|
50
|
-
### Step 1: Initialize (Login + Vault)
|
|
51
|
-
|
|
52
|
-
```bash
|
|
53
|
-
gobi init
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
This is an **interactive** command that:
|
|
57
|
-
1. Logs in automatically if not already authenticated (opens a browser URL for Google OAuth)
|
|
58
|
-
2. Prompts the user to select an existing vault or create a new one
|
|
59
|
-
3. Writes `.gobi/settings.yaml` in the current directory with the chosen vault slug
|
|
60
|
-
4. Creates a `BRAIN.md` file if one doesn't exist
|
|
61
|
-
|
|
62
|
-
### Step 2: Select a Space
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
gobi space warp
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
This is an **interactive** command that prompts the user to select a space from their available spaces, then saves it to `.gobi/settings.yaml`.
|
|
69
|
-
|
|
70
|
-
After both steps, `.gobi/settings.yaml` will contain:
|
|
71
|
-
```yaml
|
|
72
|
-
vaultSlug: brave-path-zr962w
|
|
73
|
-
selectedSpaceSlug: cmds
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### Standalone Login
|
|
77
|
-
|
|
78
|
-
If the user only needs to log in (without vault setup):
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
gobi auth login
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
Check auth status anytime:
|
|
85
|
-
|
|
86
|
-
```bash
|
|
87
|
-
gobi auth status
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
**Important for agents**: Before running any `space` command, check if `.gobi/settings.yaml` exists in the current directory with both `vaultSlug` and `selectedSpaceSlug`. If the vault is missing, guide the user through `gobi init`. If only the space is missing, guide the user through `gobi space warp`. These commands require user input (interactive prompts), so the agent cannot run them silently.
|
|
91
|
-
|
|
92
|
-
## Gobi Space — Community Channel
|
|
93
|
-
|
|
94
|
-
`gobi space` is the main interface for interacting with the user's Gobi community. When the user asks about what's happening, what others are discussing, or wants to engage with their community — use `gobi space` commands. Think of it as the user's community feed and communication hub.
|
|
95
|
-
|
|
96
|
-
- When the user wants to explore or catch up on what's happening in their space, invoke `/gobi:space-explore`.
|
|
97
|
-
- When the user wants to share or post learnings from the current session, invoke `/gobi:space-share`.
|
|
98
|
-
|
|
99
|
-
## Gobi Brain — Knowledge Management
|
|
100
|
-
|
|
101
|
-
`gobi brain` commands manage your vault's brain: search across all spaces, ask brains questions, and publish/unpublish your BRAIN.md. Public brains are accessible at `https://gobispace.com/@{vaultSlug}`.
|
|
102
|
-
|
|
103
|
-
## Gobi Session — Conversations
|
|
104
|
-
|
|
105
|
-
`gobi session` commands manage your conversations: list, read, and reply to sessions.
|
|
106
|
-
|
|
107
|
-
## Important: JSON Mode
|
|
108
|
-
|
|
109
|
-
For programmatic/agent usage, always pass `--json` as a **global** option (before the subcommand) to get structured JSON output:
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
gobi --json space list-threads
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
or
|
|
116
|
-
|
|
117
|
-
```bash
|
|
118
|
-
gobi --json session list
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
JSON responses have the shape `{ "success": true, "data": ... }` on success or `{ "success": false, "error": "..." }` on failure.
|
|
122
|
-
|
|
123
|
-
## Space Slug Override
|
|
124
|
-
|
|
125
|
-
`gobi space` commands use the space from `.gobi/settings.yaml`. Override it with a parent-level flag:
|
|
126
|
-
|
|
127
|
-
```bash
|
|
128
|
-
gobi space --space-slug <slug> list-threads
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
For `gobi brain list-updates`, you can filter by space with a subcommand option:
|
|
132
|
-
|
|
133
|
-
```bash
|
|
134
|
-
gobi brain list-updates --space-slug <slug>
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
Note: `--space-slug` is not available on other `brain` subcommands or on `session` commands.
|
|
138
|
-
|
|
139
|
-
## Available Commands
|
|
140
|
-
|
|
141
|
-
- `gobi auth` — Authentication commands.
|
|
142
|
-
- `gobi auth login` — Log in to Gobi. Opens a browser URL for Google OAuth, then polls until authentication is complete.
|
|
143
|
-
- `gobi auth status` — Check whether you are currently authenticated with Gobi.
|
|
144
|
-
- `gobi auth logout` — Log out of Gobi and remove stored credentials.
|
|
145
|
-
- `gobi init` — Log in (if needed) and select or create the vault for the current directory.
|
|
146
|
-
- `gobi space` — Space commands (threads, replies).
|
|
147
|
-
- `gobi space list` — List spaces you are a member of.
|
|
148
|
-
- `gobi space warp` — Select the active space. Pass a slug to warp directly, or omit for interactive selection.
|
|
149
|
-
- `gobi space list-topics` — List topics in a space, ordered by most recent content linkage.
|
|
150
|
-
- `gobi space list-topic-threads` — List threads tagged with a topic in a space (cursor-paginated).
|
|
151
|
-
- `gobi space get-thread` — Get a thread and its replies (paginated).
|
|
152
|
-
- `gobi space list-threads` — List threads in a space (paginated).
|
|
153
|
-
- `gobi space create-thread` — Create a thread in a space.
|
|
154
|
-
- `gobi space edit-thread` — Edit a thread. You must be the author.
|
|
155
|
-
- `gobi space delete-thread` — Delete a thread. You must be the author.
|
|
156
|
-
- `gobi space create-reply` — Create a reply to a thread in a space.
|
|
157
|
-
- `gobi space edit-reply` — Edit a reply. You must be the author.
|
|
158
|
-
- `gobi space delete-reply` — Delete a reply. You must be the author.
|
|
159
|
-
- `gobi brain` — Brain commands (search, ask, publish, unpublish, updates).
|
|
160
|
-
- `gobi brain search` — Search public brains by text and semantic similarity.
|
|
161
|
-
- `gobi brain ask` — Ask a brain a question. Creates a targeted session (1:1 conversation).
|
|
162
|
-
- `gobi brain publish` — Upload BRAIN.md to the vault root on webdrive. Triggers post-processing (brain sync, metadata update, Discord notification).
|
|
163
|
-
- `gobi brain unpublish` — Delete BRAIN.md from the vault on webdrive.
|
|
164
|
-
- `gobi brain list-updates` — List recent brain updates. Without --space-slug, lists all updates for you. With --space-slug, lists updates for that space. Use --mine to show only updates by you.
|
|
165
|
-
- `gobi brain post-update` — Post a brain update for a vault.
|
|
166
|
-
- `gobi brain edit-update` — Edit a published brain update. You must be the author.
|
|
167
|
-
- `gobi brain delete-update` — Delete a published brain update. You must be the author.
|
|
168
|
-
- `gobi session` — Session commands (get, list, reply).
|
|
169
|
-
- `gobi session get` — Get a session and its messages (paginated).
|
|
170
|
-
- `gobi session list` — List all sessions you are part of, sorted by most recent activity.
|
|
171
|
-
- `gobi session reply` — Send a human reply to a session you are a member of.
|
|
172
|
-
- `gobi sense` — Sense commands (activities, transcriptions).
|
|
173
|
-
- `gobi sense activities` — Fetch activity records within a time range.
|
|
174
|
-
- `gobi sense transcriptions` — Fetch transcription records within a time range.
|
|
175
|
-
- `gobi sync` — Sync local vault files with Gobi Webdrive.
|
|
176
|
-
- `gobi update` — Update gobi-cli to the latest version.
|
|
177
|
-
|
|
178
|
-
## Reference Documentation
|
|
179
|
-
|
|
180
|
-
- [gobi auth](references/auth.md)
|
|
181
|
-
- [gobi init](references/init.md)
|
|
182
|
-
- [gobi space](references/space.md)
|
|
183
|
-
- [gobi brain](references/brain.md)
|
|
184
|
-
- [gobi session](references/session.md)
|
|
185
|
-
- [gobi sense](references/sense.md)
|
|
186
|
-
- [gobi sync](references/sync.md)
|
|
187
|
-
- [gobi update](references/update.md)
|
|
188
|
-
|
|
189
|
-
## Discovering Options
|
|
190
|
-
|
|
191
|
-
Run `--help` on any command for details:
|
|
192
|
-
|
|
193
|
-
```bash
|
|
194
|
-
gobi --help
|
|
195
|
-
gobi auth --help
|
|
196
|
-
gobi space --help
|
|
197
|
-
gobi brain --help
|
|
198
|
-
gobi session --help
|
|
199
|
-
gobi sense --help
|
|
200
|
-
gobi sync --help
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
## Configuration Files
|
|
204
|
-
|
|
205
|
-
| Path | Description |
|
|
206
|
-
|------|-------------|
|
|
207
|
-
| `~/.gobi/credentials.json` | Stored authentication tokens (auto-managed) |
|
|
208
|
-
| `.gobi/settings.yaml` | Per-project vault and space configuration |
|
|
209
|
-
| `BRAIN.md` | Brain document with YAML frontmatter, published via `gobi brain publish` |
|
|
210
|
-
|
|
211
|
-
## Environment Variables
|
|
212
|
-
|
|
213
|
-
| Variable | Default | Description |
|
|
214
|
-
|----------|---------|-------------|
|
|
215
|
-
| `GOBI_BASE_URL` | `https://api.joingobi.com` | API server URL |
|
|
216
|
-
| `GOBI_WEBDRIVE_BASE_URL` | `https://webdrive.joingobi.com` | File storage URL |
|