Skip to content

Commit c64c294

Browse files
committed
feat: document custom commands support
Add Custom Commands section to commands.md explaining project-level and global custom commands via .cmd/.help files, resolution order, and link to Magento 2 template as real-world example. Companion to wardenenv/docs#52.
1 parent 670ac1e commit c64c294

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

references/commands.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,18 @@
7171
| `warden doctor [-v]` | Diagnose Warden setup. `-v` for verbose |
7272
| `warden sign-certificate <domain>` | Sign SSL certificate for domain |
7373
| `warden vnc` | VNC access (when enabled) |
74+
75+
## Custom Commands
76+
77+
Add custom commands by placing `<name>.cmd` and `<name>.help` files in:
78+
79+
| Location | Scope |
80+
|----------|-------|
81+
| `<project>/.warden/commands/` | Project only |
82+
| `~/.warden/commands/` | All projects (global) |
83+
84+
**Resolution order:** project → global → built-in (project commands override global, both override built-in).
85+
86+
The `.help` file is required for the command to appear in `warden help` output.
87+
88+
Example: [Magento 2 template custom commands](https://github.com/wardenenv/warden-env-magento2/tree/develop/.warden/commands)

0 commit comments

Comments
 (0)