Skip to content

Commit 9927ab8

Browse files
committed
Enhance README with OpenCode plugin details
1 parent 51c73fd commit 9927ab8

1 file changed

Lines changed: 68 additions & 3 deletions

File tree

README.md

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
<a href="#zed">Zed</a> &nbsp;·&nbsp;
1818
<a href="#neovim">NeoVim</a> &nbsp;·&nbsp;
1919
<a href="#claude-code">Claude Code</a> &nbsp;·&nbsp;
20-
<a href="#codex">Codex</a>
20+
<a href="#codex">Codex</a> &nbsp;·&nbsp;
21+
<a href="#opencode">OpenCode</a>
2122
</p>
2223

2324
<p align="center">
@@ -365,6 +366,58 @@ This saves your key, installs heartbeat hooks, and enables the `codex_hooks` fea
365366

366367
---
367368

369+
### OpenCode
370+
371+
#### Installation
372+
373+
Add the plugin to your `opencode.json`:
374+
375+
```json
376+
{
377+
"plugin": ["opencode-devglobe"]
378+
}
379+
```
380+
381+
OpenCode installs it automatically on startup via npm.
382+
383+
#### Setup
384+
385+
Restart OpenCode and ask:
386+
387+
```
388+
setup devglobe with my key YOUR_API_KEY
389+
```
390+
391+
Get your API key at [devglobe.xyz](https://devglobe.xyz) — sign in, then open your **profile settings**.
392+
393+
#### Features
394+
395+
| Feature | Description |
396+
|---------|-------------|
397+
| **Live heartbeat** | Hooks into `tool.execute.after` and `file.edited` events. Sends a heartbeat at most once per minute. |
398+
| **Language detection** | Detects the language from exact file paths provided by OpenCode tool calls. |
399+
| **Git integration** | Detects your repo from the git remote. |
400+
| **Anonymous mode** | **Enabled by default.** Hides your exact location — placed on a random city in your country (from a database of 152,000+ cities worldwide). |
401+
| **Repo sharing** | Ask "share my repo on devglobe" to toggle (disabled by default). |
402+
403+
#### Commands
404+
405+
Just ask in natural language — the plugin registers tools that the AI agent calls on your behalf:
406+
407+
| What you say | Tool | Description |
408+
|--------------|------|-------------|
409+
| "setup devglobe with key X" | `devglobe_setup` | Configure API key and create settings |
410+
| "enable anonymous mode" | `devglobe_anonymous` | Toggle anonymous mode |
411+
| "share my repo on devglobe" | `devglobe_share_repo` | Toggle repo sharing |
412+
| "set my devglobe status to X" | `devglobe_status` | Set a status message on the globe |
413+
| "check devglobe" | `devglobe_check` | Verify installation |
414+
415+
#### Requirements
416+
417+
- [OpenCode](https://github.com/anomalyco/opencode)
418+
419+
---
420+
368421
## The Globe
369422

370423
On [devglobe.xyz](https://devglobe.xyz), you'll find:
@@ -391,7 +444,7 @@ On [devglobe.xyz](https://devglobe.xyz), you'll find:
391444

392445
**What we NEVER touch:** source code, file contents, file names, folder paths, keystrokes, commit messages, Git branches, environment variables, SSH keys. Your IP is used once for geolocation then discarded — never sent to DevGlobe.
393446

394-
**API keys** are stored in your OS keychain (VS Code SecretStorage, JetBrains PasswordSafe) or local config file (Zed, NeoVim, Claude Code, Codex).
447+
**API keys** are stored in your OS keychain (VS Code SecretStorage, JetBrains PasswordSafe) or local config file (Zed, NeoVim, Claude Code, Codex, OpenCode).
395448

396449
**Network:** HTTPS only (TLS 1.2+), no intermediary server, Content Security Policy on webviews, Row Level Security on the database. No telemetry.
397450

@@ -485,6 +538,18 @@ ln -s "$(pwd)" ~/.codex/skills/codex-plugin
485538

486539
Then in Codex: `$devglobe setup YOUR_API_KEY`
487540

541+
### OpenCode
542+
543+
```bash
544+
cd opencode-plugin
545+
npm install && npm run build
546+
```
547+
548+
Then in your `opencode.json`:
549+
```json
550+
{"plugin": ["file:///path/to/devglobe-extension/opencode-plugin/dist/index.js"]}
551+
```
552+
488553
---
489554

490555
## Contributing
@@ -503,7 +568,7 @@ Contributions are welcome — fixes, new features, documentation.
503568
If you like DevGlobe, help us spread the word!
504569

505570
<p align="center">
506-
<a href="https://twitter.com/intent/tweet?text=I%20just%20discovered%20DevGlobe%20%E2%80%94%20a%20free%20open-source%203D%20globe%20that%20shows%20developers%20coding%20in%20real%20time.%20Extensions%20for%20VS%20Code%2C%20JetBrains%2C%20Zed%2C%20NeoVim%2C%20Claude%20Code%20%26%20Codex.&url=https%3A%2F%2Fgithub.com%2FNako0%2Fdevglobe-extension"><img src="https://img.shields.io/badge/Share_on-X%20(Twitter)-000000?style=for-the-badge&logo=x" alt="Share on X" /></a>&nbsp;
571+
<a href="https://twitter.com/intent/tweet?text=I%20just%20discovered%20DevGlobe%20%E2%80%94%20a%20free%20open-source%203D%20globe%20that%20shows%20developers%20coding%20in%20real%20time.%20Extensions%20for%20VS%20Code%2C%20JetBrains%2C%20Zed%2C%20NeoVim%2C%20Claude%20Code%2C%20Codex%20%26%20OpenCode.&url=https%3A%2F%2Fgithub.com%2FNako0%2Fdevglobe-extension"><img src="https://img.shields.io/badge/Share_on-X%20(Twitter)-000000?style=for-the-badge&logo=x" alt="Share on X" /></a>&nbsp;
507572
<a href="https://www.reddit.com/submit?url=https%3A%2F%2Fgithub.com%2FNako0%2Fdevglobe-extension&title=DevGlobe%20%E2%80%94%20See%20developers%20coding%20in%20real%20time%20on%20a%203D%20globe"><img src="https://img.shields.io/badge/Share_on-Reddit-FF4500?style=for-the-badge&logo=reddit&logoColor=white" alt="Share on Reddit" /></a>&nbsp;
508573
<a href="https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fgithub.com%2FNako0%2Fdevglobe-extension&t=DevGlobe%20%E2%80%94%20See%20developers%20coding%20in%20real%20time%20on%20a%203D%20globe"><img src="https://img.shields.io/badge/Share_on-Hacker%20News-F0652F?style=for-the-badge&logo=ycombinator&logoColor=white" alt="Share on HN" /></a>&nbsp;
509574
<a href="https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fgithub.com%2FNako0%2Fdevglobe-extension"><img src="https://img.shields.io/badge/Share_on-LinkedIn-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white" alt="Share on LinkedIn" /></a>

0 commit comments

Comments
 (0)