Hello tool¶
The hello tool is the smallest example of each thing a tool can add: a command, a monitor colour rule, a panel and a decoder. It is for tool authors who want to see the whole API surface in one short script.
What it does¶
/hello [name]answersHello <name> from the imported hello-tool!, orHello world …without a name.- A colour rule tints stations with an
OEprefix in the packet monitor, with the--st-usertoken. - A panel shows a line of text and a
sandboxedbadge. - A ROT13 decoder in Tools → Decode rotates letters by 13.
It reaches nothing outside its sandbox. Its manifest name is hello-tool; its folder is tools/hello/.
Permissions¶
| Permission | Why |
|---|---|
command |
Registers /hello |
monitor |
Adds the monitor colour rule |
panel |
Shows the panel |
decoder |
Adds the ROT13 decoder |
Version and tool API¶
| Manifest name | hello-tool |
| Version | 1.0.0 |
| Tool API | 1.0, the minimum it needs |
| Author | OE8APR |
| Shows on | web, terminal |
| Commands | The operator's alone |
| Licence | MIT |
| In the project registry | Listed, as version 1.0.0 |
| Source | tools/hello/ |
Next¶
- Write your first tool: build a tool of your own.
- The sandbox API: every call the hello tool makes.