Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions external_plugins/orbtile-start/.zcode-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "orbtile-start",
"description": "Checks whether the Orbtile app is installed and following your ZCode tasks, and tells you the one next step if not. Read-only; sends nothing.",
"description_i18n": {
"en": "Checks whether the Orbtile app is installed and following your ZCode tasks, and tells you the one next step if not. Read-only; sends nothing.",
"zh-CN": "检查 Orbtile 应用是否已安装并在跟踪你的 ZCode 任务;如果没有,告诉你下一步该做什么。只读取本机文件,不发送任何数据。"
},
"version": "0.1.5",
"author": {
"name": "Orbtile Team",
"url": "https://orbtile.com"
},
"homepage": "https://orbtile.com",
"repository": "https://github.com/Orbtile/orbtile-plugins",
"license": "MIT",
"keywords": [
"orbtile",
"keypad",
"status",
"setup"
]
}
21 changes: 21 additions & 0 deletions external_plugins/orbtile-start/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 Orbtile

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
27 changes: 27 additions & 0 deletions external_plugins/orbtile-start/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# orbtile-start for ZCode

[中文](README_CN.md)

A small starter for [Orbtile](https://orbtile.com), the app for macOS and Windows that shows the live state of your coding agents on a keypad.

## What it does

- The `orbtile-status` skill checks this computer: is the Orbtile app installed, is Orbtile's ZCode approval hook on, and is the app running. It tells you the one next step, if any. Ask ZCode to "check my Orbtile setup" or "set up Orbtile for ZCode".
- Once the Orbtile app is installed, there is nothing more to set up: Orbtile follows ZCode tasks from their files. You can then remove this plugin.

## What it runs, reads and sends

- Commands: the skill runs one script, `scripts/orbtile.sh` (macOS and Linux) or `scripts/orbtile.ps1` (Windows), only when you ask.
- Files read: `~/.zcode/cli/config.json` and the usual app folders (`/Applications`, `~/Applications`, `%LOCALAPPDATA%\Orbtile`). On macOS it checks whether a process named Orbtile is running.
- Files written: none.
- Network: none. It sends nothing anywhere and fetches nothing.
- Hooks, MCP servers, agents: none.
- It changes no files or settings. It is not Orbtile: the app sets up its own ZCode hook.

## Requirements

macOS or Windows, where the Orbtile app runs. On macOS it uses `sh`; on Windows it uses PowerShell. On other systems the check says that Orbtile does not run there.

## License

MIT. Made by Orbtile Team. No third-party code or assets.
27 changes: 27 additions & 0 deletions external_plugins/orbtile-start/README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# orbtile-start(ZCode 版)

[English](README.md)

[Orbtile](https://orbtile.com) 的一个小型入门插件。Orbtile 是一款 macOS 和 Windows 应用,在小键盘上实时显示你的编程智能体的状态。

## 功能

- `orbtile-status` 技能会检查本机:Orbtile 应用是否已安装,Orbtile 的 ZCode 审批钩子是否已开启,应用是否正在运行。如有需要,它会告诉你下一步该做什么。你可以让 ZCode“检查我的 Orbtile 设置”或“为 ZCode 设置 Orbtile”。
- 安装 Orbtile 应用后无需其他设置:Orbtile 会通过 ZCode 的任务文件跟踪任务。之后你可以移除本插件。

## 运行、读取和发送的内容

- 命令:只有在你提出要求时,技能才会运行一个脚本:`scripts/orbtile.sh`(macOS 和 Linux)或 `scripts/orbtile.ps1`(Windows)。
- 读取的文件:`~/.zcode/cli/config.json` 以及常见的应用目录(`/Applications`、`~/Applications`、`%LOCALAPPDATA%\Orbtile`)。在 macOS 上,它会检查是否有名为 Orbtile 的进程在运行。
- 写入的文件:无。
- 网络:无。不发送也不获取任何数据。
- 钩子、MCP 服务器、智能体:无。
- 它不会修改任何文件或设置。它不是 Orbtile 本身:Orbtile 应用会自行设置它的 ZCode 钩子。

## 运行要求

macOS 或 Windows(Orbtile 应用支持的系统)。在 macOS 上使用 `sh`,在 Windows 上使用 PowerShell。在其他系统上,检查结果会说明 Orbtile 不支持该系统。

## 许可证

MIT。由 Orbtile Team 制作。不包含第三方代码或素材。
22 changes: 22 additions & 0 deletions external_plugins/orbtile-start/skills/orbtile-status/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: orbtile-status
description: Check whether the Orbtile app is installed and following ZCode, and whether Orbtile's ZCode approval hook is on. Use when the user asks to set up Orbtile, asks about Orbtile or its keypad, asks if the Orbtile hook is working, or asks why their ZCode tasks do not show in Orbtile.
---

# Orbtile setup check

Run this read-only check from this skill's folder and report its result.

On macOS and Linux:

```
sh scripts/orbtile.sh zcode status
```

On Windows:

```
powershell -NoProfile -ExecutionPolicy Bypass -File scripts\orbtile.ps1 zcode status
```

Tell the user the result in a few short lines, using only what the check says. If it lists a next step, give that step and nothing else. The check reads local files only. Do not change any files or settings yourself: the Orbtile app sets up its own ZCode hook.
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Orbtile starter script for Windows shells without sh (Codex runs hooks with cmd.exe on Windows).
# Source of truth: shared/orbtile.ps1. The Codex plugin carries an identical copy (tests check this).
# Same behaviour and wording as shared/orbtile.sh for Codex, Antigravity and ZCode on Windows.
#
# orbtile.ps1 <agent> session-start Session-start hook: at most one line a day pointing to the Orbtile app,
# nothing once the Orbtile app is installed or its hooks are set up.
# orbtile.ps1 <agent> status Plain-text setup check.
# <agent>: codex | antigravity | zcode (all followed by the app without hooks)
#
# Reads local files only. Sends nothing anywhere. Always exits 0 so it can never block a session.

param([string]$Agent = '', [string]$Command = '')
$ErrorActionPreference = 'SilentlyContinue'
$downloadUrl = 'https://orbtile.com/download'

if (($Agent -ne 'codex' -and $Agent -ne 'antigravity' -and $Agent -ne 'zcode') -or ($Command -ne 'session-start' -and $Command -ne 'status')) {
[Console]::Error.WriteLine('usage: orbtile.ps1 codex|antigravity|zcode session-start|status')
exit 0
}

if ($Agent -eq 'codex') {
$agentName = 'Codex'
$codexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE '.codex' }
$configFile = Join-Path $codexHome 'hooks.json'
$pitch = 'Orbtile shows your Codex sessions live on a keypad'
$checkHint = 'ask Codex to check your Orbtile setup'
$doneLine = 'Next step: none. Orbtile is set up; this starter plugin stays quiet and can be removed with: codex plugin remove orbtile-start@orbtile-public'
$hooksOptional = 'Orbtile reads Codex sessions without them'
} elseif ($Agent -eq 'zcode') {
$agentName = 'ZCode'
$configFile = Join-Path $env:USERPROFILE '.zcode\cli\config.json'
$pitch = 'Orbtile shows your ZCode tasks live on a keypad'
$checkHint = 'ask ZCode to check your Orbtile setup'
$doneLine = 'Next step: none. Orbtile is set up. You can remove the orbtile-start plugin from ZCode.'
$hooksOptional = 'Orbtile follows ZCode tasks from their files without them'
} else {
$agentName = 'Antigravity'
$configFile = Join-Path $env:USERPROFILE '.gemini\config\hooks.json'
$pitch = 'Orbtile shows your Antigravity sessions live on a keypad'
$checkHint = 'ask Antigravity to check your Orbtile setup'
$doneLine = 'Next step: none. Orbtile is set up. You can remove the orbtile-start plugin from Antigravity.'
$hooksOptional = 'Orbtile reads Antigravity sessions without them'
}

# Orbtile's hooks for this agent: the Windows app's helper (--orbtile-agent), or the Mac app's script name.
function Get-HookMarker {
if (-not (Test-Path -LiteralPath $configFile)) { return '' }
$text = Get-Content -LiteralPath $configFile -Raw
if ($text -and $text -match "orbtile(-[a-z]+)?-$Agent-hook|--orbtile-agent") { return 'Orbtile hooks' }
return ''
}

# The Windows app keeps its data in %LOCALAPPDATA%\Orbtile.
function Get-AppPath {
if (-not $env:LOCALAPPDATA) { return '' }
$p = Join-Path $env:LOCALAPPDATA 'Orbtile'
if (Test-Path -LiteralPath $p -PathType Container) { return $p }
return ''
}

if ($Command -eq 'session-start') {
# Orbtile follows Codex and Antigravity without hooks: an installed app is a set-up app.
if ((Get-HookMarker) -or (Get-AppPath)) { exit 0 }
# Once a day at most. Without a writable state folder it still shows (the hook runs once per new session).
$today = [string][math]::Floor([DateTimeOffset]::UtcNow.ToUnixTimeSeconds() / 86400)
if ($env:PLUGIN_DATA) {
$stateFile = Join-Path $env:PLUGIN_DATA 'last-shown-day'
$last = Get-Content -LiteralPath $stateFile -TotalCount 1
if ($last -eq $today) { exit 0 }
New-Item -ItemType Directory -Force -Path $env:PLUGIN_DATA | Out-Null
Set-Content -LiteralPath $stateFile -Value $today -Encoding ascii
}
$msg = "${pitch}: $downloadUrl ($checkHint)"
[Console]::Out.WriteLine('{"systemMessage":"' + $msg + '"}')
exit 0
}

# status
$marker = Get-HookMarker
$app = Get-AppPath
[Console]::Out.WriteLine("Orbtile setup check for $agentName")
if ($app) { [Console]::Out.WriteLine("- Orbtile app: found at $app") } else { [Console]::Out.WriteLine('- Orbtile app: not found on this computer') }
if ($marker) { [Console]::Out.WriteLine("- Orbtile's $agentName hooks: on ($marker in $configFile)") }
else { [Console]::Out.WriteLine("- Orbtile's $agentName hooks: off (optional: $hooksOptional)") }
if ($marker -or $app) {
if ($marker -and $Agent -eq 'codex') { [Console]::Out.WriteLine("- Note: Codex runs Orbtile's hooks only after you trust them once in /hooks (Settings > Hooks in the Codex app).") }
[Console]::Out.WriteLine($doneLine)
} else {
[Console]::Out.WriteLine("Next step: download Orbtile from $downloadUrl")
}
exit 0
Loading