zdev-skill 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +13 -0
- package/README.md +76 -0
- package/SKILL.md +148 -0
- package/package.json +23 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
|
2
|
+
Version 2, January 2026
|
|
3
|
+
|
|
4
|
+
Copyright (C) 2026 5hanth
|
|
5
|
+
|
|
6
|
+
Everyone is permitted to copy and distribute verbatim or modified
|
|
7
|
+
copies of this license document, and changing it is allowed as long
|
|
8
|
+
as the name is changed.
|
|
9
|
+
|
|
10
|
+
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
|
11
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
12
|
+
|
|
13
|
+
0. You just DO WHAT THE FUCK YOU WANT TO.
|
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# zdev-skill
|
|
2
|
+
|
|
3
|
+
Agent skill for [zdev](https://github.com/5hanth/zdev) — multi-agent worktree development environment.
|
|
4
|
+
|
|
5
|
+
## What is this?
|
|
6
|
+
|
|
7
|
+
This skill teaches AI coding agents (Claude Code, Clawdbot, etc.) how to use `zdev` for managing isolated development environments with git worktrees, automatic port allocation, and public preview URLs.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
### Claude Code
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx add-skill 5hanth/zdev-skill
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Then in Claude Code:
|
|
18
|
+
```
|
|
19
|
+
/zdev
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### Clawdbot
|
|
23
|
+
|
|
24
|
+
Add to your Clawdbot skills directory:
|
|
25
|
+
```bash
|
|
26
|
+
git clone https://github.com/5hanth/zdev-skill ~/.clawdbot/skills/zdev
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Other Agents
|
|
30
|
+
|
|
31
|
+
Copy the contents of [SKILL.md](./SKILL.md) into your agent's system prompt or context.
|
|
32
|
+
|
|
33
|
+
## Usage
|
|
34
|
+
|
|
35
|
+
Once installed, prompt your agent:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
Use zdev to create a new TanStack Start project called my-app with Convex backend.
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
Use zdev to start a worktree for add-auth feature on ./my-project
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
Run zdev list to show what's currently running.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
Use zdev clean to remove the add-auth worktree after the PR is merged.
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## What the Agent Learns
|
|
54
|
+
|
|
55
|
+
- `zdev create` — Scaffold new TanStack Start projects
|
|
56
|
+
- `zdev init` — Initialize existing projects
|
|
57
|
+
- `zdev start` — Create isolated worktrees with auto port allocation
|
|
58
|
+
- `zdev list` — Check running worktrees
|
|
59
|
+
- `zdev stop` — Stop servers
|
|
60
|
+
- `zdev clean` — Remove worktrees after PR merge
|
|
61
|
+
- `zdev config` — Configure Traefik for public URLs
|
|
62
|
+
|
|
63
|
+
## Requirements
|
|
64
|
+
|
|
65
|
+
- [zdev](https://github.com/5hanth/zdev) CLI installed
|
|
66
|
+
- [Bun](https://bun.sh) runtime
|
|
67
|
+
|
|
68
|
+
## Related
|
|
69
|
+
|
|
70
|
+
- [zdev](https://github.com/5hanth/zdev) — The CLI tool
|
|
71
|
+
- [Clawdbot](https://docs.clawd.bot) — AI agent platform
|
|
72
|
+
- [Claude Code](https://claude.ai) — Anthropic's coding agent
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
[WTFPL](https://en.wikipedia.org/wiki/WTFPL)
|
package/SKILL.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# zdev Skill
|
|
2
|
+
|
|
3
|
+
Use `zdev` to manage isolated development environments when working on features. Each feature gets its own git worktree, ports, and optional public preview URL.
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- `zdev` CLI installed (`bunx zdev` or `bun add -g zdev`)
|
|
8
|
+
- Vite-based frontend project (Convex backend is optional, auto-detected)
|
|
9
|
+
|
|
10
|
+
## Creating a New Project
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Basic TanStack Start project
|
|
14
|
+
zdev create my-app
|
|
15
|
+
|
|
16
|
+
# With Convex backend
|
|
17
|
+
zdev create my-app --convex
|
|
18
|
+
|
|
19
|
+
# Flat structure (no monorepo)
|
|
20
|
+
zdev create my-app --flat
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Creates:
|
|
24
|
+
- TanStack Start app with clean routes
|
|
25
|
+
- `.zdev/setup.sh` for worktree setup
|
|
26
|
+
- Agentation for UI feedback (dev only)
|
|
27
|
+
|
|
28
|
+
## Initializing an Existing Project
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
zdev init /path/to/project
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Creates `.zdev/project.json` with project metadata.
|
|
35
|
+
|
|
36
|
+
## Configuration
|
|
37
|
+
|
|
38
|
+
First-time setup (or to change settings):
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
zdev config --set devDomain=dev.example.com
|
|
42
|
+
zdev config --set traefikConfigDir=/etc/traefik/dynamic
|
|
43
|
+
zdev config --list
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Before Starting Any Feature
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Check what's already running
|
|
50
|
+
zdev list
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
If your feature already exists, just `cd` to the worktree path shown.
|
|
54
|
+
|
|
55
|
+
## Starting a New Feature
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
# Start feature with public URL
|
|
59
|
+
zdev start <feature-name> -p /path/to/project
|
|
60
|
+
|
|
61
|
+
# Start without public URL (local only)
|
|
62
|
+
zdev start <feature-name> -p /path/to/project --local
|
|
63
|
+
|
|
64
|
+
# Start with seed data (Convex projects)
|
|
65
|
+
zdev start <feature-name> -p /path/to/project --seed
|
|
66
|
+
|
|
67
|
+
# Use different base branch
|
|
68
|
+
zdev start <feature-name> -p /path/to/project --base-branch main
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
After starting:
|
|
72
|
+
1. `.zdev/setup.sh` runs automatically (installs deps, etc.)
|
|
73
|
+
2. Note the worktree path (e.g., `~/.zdev/worktrees/project-feature`)
|
|
74
|
+
3. Note the local URL (e.g., `http://localhost:5173`)
|
|
75
|
+
4. Note the public URL if available (e.g., `https://project-feature.dev.example.com`)
|
|
76
|
+
5. `cd` to the worktree path to begin work
|
|
77
|
+
|
|
78
|
+
## While Working
|
|
79
|
+
|
|
80
|
+
You're in an isolated git worktree with its own:
|
|
81
|
+
- Branch (`feature/<name>`)
|
|
82
|
+
- Node modules
|
|
83
|
+
- Convex dev instance (if applicable)
|
|
84
|
+
- Port allocation
|
|
85
|
+
|
|
86
|
+
Work normally. Commit often. Push when ready for review.
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
git add .
|
|
90
|
+
git commit -m "description"
|
|
91
|
+
git push -u origin feature/<name>
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Stopping Work (End of Session)
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
# Stop servers but keep worktree (resume later)
|
|
98
|
+
zdev stop <feature-name> -p /path/to/project --keep
|
|
99
|
+
|
|
100
|
+
# Or just leave it running if you'll be back soon
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Resuming Work
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
# Check status
|
|
107
|
+
zdev list
|
|
108
|
+
|
|
109
|
+
# If stopped, restart
|
|
110
|
+
zdev start <feature-name> -p /path/to/project
|
|
111
|
+
|
|
112
|
+
# If already running, just cd to the worktree
|
|
113
|
+
cd ~/.zdev/worktrees/project-feature
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## After PR is Merged
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# Clean up completely
|
|
120
|
+
zdev clean <feature-name> -p /path/to/project
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
This removes the worktree, Traefik route, and port allocation.
|
|
124
|
+
|
|
125
|
+
## Quick Reference
|
|
126
|
+
|
|
127
|
+
| Task | Command |
|
|
128
|
+
|------|---------|
|
|
129
|
+
| Create new project | `zdev create NAME` |
|
|
130
|
+
| Init existing project | `zdev init PATH` |
|
|
131
|
+
| Configure | `zdev config --list` |
|
|
132
|
+
| See what's running | `zdev list` |
|
|
133
|
+
| Start feature | `zdev start NAME -p PATH` |
|
|
134
|
+
| Stop (keep files) | `zdev stop NAME -p PATH --keep` |
|
|
135
|
+
| Stop (full) | `zdev stop NAME -p PATH` |
|
|
136
|
+
| Remove after merge | `zdev clean NAME -p PATH` |
|
|
137
|
+
|
|
138
|
+
## Troubleshooting
|
|
139
|
+
|
|
140
|
+
**"Feature already exists"** → It's already running. Use `zdev list` to find the worktree path.
|
|
141
|
+
|
|
142
|
+
**"Failed to create worktree: invalid reference"** → Use `--base-branch master` or the correct branch name.
|
|
143
|
+
|
|
144
|
+
**Port conflict** → Specify a port: `zdev start NAME --port 5200`
|
|
145
|
+
|
|
146
|
+
**No public URL** → Run `zdev config --set devDomain=dev.example.com` first.
|
|
147
|
+
|
|
148
|
+
**Convex not working** → Run `bunx convex dev` once in the main project first to select a Convex project.
|
package/package.json
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "zdev-skill",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Agent skill for zdev - multi-agent worktree development",
|
|
5
|
+
"license": "WTFPL",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/5hanth/zdev-skill"
|
|
9
|
+
},
|
|
10
|
+
"keywords": [
|
|
11
|
+
"clawdbot",
|
|
12
|
+
"agent",
|
|
13
|
+
"skill",
|
|
14
|
+
"zdev",
|
|
15
|
+
"worktree",
|
|
16
|
+
"convex",
|
|
17
|
+
"vite"
|
|
18
|
+
],
|
|
19
|
+
"files": [
|
|
20
|
+
"SKILL.md",
|
|
21
|
+
"README.md"
|
|
22
|
+
]
|
|
23
|
+
}
|