| name | gobi-core |
| description | Core Gobi CLI: authentication (login/logout/status), space selection (gobi space warp/list), and CLI updates (gobi update). Use when the user needs to authenticate or update the CLI. Vault setup is in the gobi-vault skill; file sync is also in gobi-vault. |
| allowed-tools | Bash(gobi:*) |
| metadata | {"author":"gobi-ai","version":"2.0.43"} |
gobi-core
Core CLI commands for the Gobi collaborative knowledge platform (v2.0.43).
Prerequisites
Verify the CLI is installed:
gobi --version
If not installed:
npm install -g @gobi-ai/cli
Or via Homebrew:
brew tap gobi-ai/tap && brew install gobi
Key Concepts
- Vault: A filetree-backed knowledge home. A local directory becomes a vault when it contains
.gobi/settings.yaml with a vaultSlug. Each vault has a slug (e.g. brave-path-zr962w); public profile is configured by a PUBLISH.md document at the vault root and pushed via gobi vault publish.
- Space Post: A post inside a community space.
- Space: A shared community knowledge area. A user can be a member of one or more spaces; each space contains posts, replies, and connected vaults.
- Artifact: A versioned, human-owned creation (image, video, gif, markdown, or note) attached to posts. Its revisions form a draft/published tree (at most one published). See the gobi-artifact skill.
Setup steps (run only what you need)
There is no gobi init command — each setup step is its own command, and you only run the ones the workflow demands.
| Step | Command | Unlocks |
|---|
| 1. Log in | gobi auth login | All authenticated commands |
| 2. Configure a vault for this directory | gobi vault init | Every gobi vault … command; also lets <scope> artifact create --auto-attachments resolve that vault automatically |
| 3. Pick an active space for this directory | gobi space warp | Every gobi space … post/reply/feed command without needing --space-slug |
After step 2 + step 3, .gobi/settings.yaml looks like:
vaultSlug: brave-path-zr962w
selectedSpaceSlug: cmds
gobi vault init and gobi space warp are both interactive — they prompt the user, so an agent can't run them silently. Send the user the command and let them complete the prompt.
Check auth status anytime:
gobi auth status
Pre-reqs by command family
| Command family | Needs vault in .gobi? | Needs space in .gobi? | Per-call override |
|---|
auth …, update, media …, personal artifact/activities/conversations … | no | no | – |
space artifact … / space activities … / space conversations … | no | yes | parent --space-slug <slug> |
vault publish / unpublish / sync | yes | no | none — must run gobi vault init first |
vault init | no (it sets it up) | no | – |
space list / warp [slug] / get [slug] | no | no | – |
space list-topics / feed / list-posts / get-post / create-post / edit-post / delete-post / create-reply / edit-reply / delete-reply / list-topic-posts | no | yes | parent --space-slug <slug> |
personal feed / list-posts / get-post / create-post / edit-post / delete-post / create-reply / edit-reply / delete-reply | no | no | – |
When a command needs vault or space and neither .gobi nor an override flag provides it, the CLI prints a one-line warning before the command runs (e.g. Vault not set. Run 'gobi vault init' first, or pass --vault-slug.). The warning is suppressed under --json.
Important: JSON Mode
For programmatic/agent usage, always pass --json as a top-level option (before the subcommand) to get structured JSON output:
gobi --json space list
JSON responses have the shape { "success": true, "data": ... } on success or { "success": false, "error": "..." } on failure. Pagination metadata (pagination: { hasMore, nextCursor }) ships alongside data on list endpoints.
Available Commands
gobi auth — Authentication commands.
gobi auth login — Log in to Gobi. Opens a browser URL for Google OAuth, then polls until authentication is complete.
gobi auth status — Check whether you are currently authenticated with Gobi.
gobi auth logout — Log out of Gobi and remove stored credentials.
gobi space list — List spaces you are a member of.
gobi space warp — Select the active space. Pass a slug to warp directly, or omit for interactive selection.
gobi update — Update gobi-cli to the latest version.
Vault setup (gobi vault init) and file sync (gobi vault sync) live in the gobi-vault skill.
Confirm before mutating
auth login / auth logout are explicit user-driven commands; they prompt the user themselves and don't need an extra confirmation layer. update upgrades the CLI binary — fine to run without extra confirmation.
Read-only commands (auth status, space list) run without confirmation.
Reference Documentation
Configuration Files
| Path | Description |
|---|
~/.gobi/credentials.json | Stored authentication tokens (auto-managed) |
.gobi/settings.yaml | Per-project vault and space configuration |
PUBLISH.md | Vault profile document with YAML frontmatter, published via gobi vault publish |
Environment Variables
| Variable | Default | Description |
|---|
GOBI_BASE_URL | https://api.joingobi.com | API server URL |
GOBI_WEBDRIVE_BASE_URL | https://webdrive.joingobi.com | File storage URL |
GOBI_WEB_BASE_URL | https://gobispace.com | Public web URL (used when assembling shareable links) |