Skip to content

examples.md

Latest commit

 

History

History
62 lines (43 loc) · 4.98 KB

examples.md

File metadata and controls

62 lines (43 loc) · 4.98 KB
Raw

Example plugins for dal

Ports of pi extensions as dal Starlark plugins, plus original dal plugins with no pi counterpart. Each port keeps its behavior. pi-specific UI becomes data. Copy the example nearest to your extension, then edit it. Each example is one directory with a plugin.star and a README.md. The MIT license for the pi ports is under pi's license below the table.

Install one example

Run these commands from the repository root of a source checkout. Replace hello with any name from the table.

d="${XDG_DATA_HOME:-$HOME/.local/share}/dal/plugins/hello"; mkdir -p "$d"
cp -r examples/plugins/hello/. "$d/"

Add the name to plugins in dal.toml:

plugins = ["hello"]

Start dal. A plugin runs with your permissions, so read it before you install it. Three examples take settings: env-read, mcp, and permission-gate. The Settings section of each page lists them. See Plugins for every construct that an example uses.

The examples

The port column links to the source in a checkout. Read a page in the manual with dalgon docs dal://examples/<name>. It holds the README and every file of the example.

port pi origin what it shows manual page
hello pi examples/extensions/hello.ts the smallest shape dal://examples/hello
todo pi todo.ts a tool with state dal://examples/todo
subagent pi subagent/index.ts bounded child sessions dal://examples/subagent
ask pi questionnaire.ts questions to the user dal://examples/ask
mcp the shape of pi-mcp-adapter MCP calls through mcp.call and plugin settings dal://examples/mcp
permission-gate pi permission-gate.ts a tool_call hook and settings dal://examples/permission-gate
plan-mode the shape of pi-plan-mode a command that toggles saved state dal://examples/plan-mode
git-checkpoint pi git-checkpoint.ts listing and restoring checkpoints through tools.exec dal://examples/git-checkpoint
handoff pi handoff.ts child session notes saved to state dal://examples/handoff
skill-pack pi dynamic-resources skills only dal://examples/skill-pack
fetch original to dal HTTP fetch through net.fetch, with dal.err failures dal://examples/fetch
steer original to dal steering or waking the turn through turn.steer and turn.wake dal://examples/steer
review-rules original to dal stream and always-apply rules through dal.rule dal://examples/review-rules
locate original to dal file search and read through tools.search and tools.read dal://examples/locate
session-log original to dal session_start and turn_end hooks with state dal://examples/session-log
env-read original to dal one allowed variable through env.read and plugin settings dal://examples/env-read

pi's license

The pi ports carry pi's MIT license. This is the notice that goes with them.

This product includes Starlark translations of examples of pi (https://github.com/earendil-works/pi), Copyright (c) 2025 Mario Zechner, used under the MIT License.

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.

Next