ziku 0.20.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/README.md +188 -0
- package/dist/hash-DonjAgHQ.mjs +3 -0
- package/dist/index.mjs +3788 -0
- package/dist/merge-DFEjeYIq.mjs +3 -0
- package/dist/modules-DkQe-r1d.mjs +3 -0
- package/dist/patterns-C3oCRYgX.mjs +3 -0
- package/dist/template-BLwXZEZq.mjs +3 -0
- package/package.json +68 -0
package/README.md
ADDED
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<br>
|
|
3
|
+
<h1 align="center">ziku</h1>
|
|
4
|
+
<p align="center">
|
|
5
|
+
A bi-directional dev environment template that evolves with you.
|
|
6
|
+
</p>
|
|
7
|
+
<br>
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/ziku"><img src="https://img.shields.io/npm/v/ziku?color=a1b858&label=" alt="npm version"></a>
|
|
10
|
+
<a href="https://www.npmjs.com/package/ziku"><img src="https://img.shields.io/npm/dm/ziku?color=50a36f&label=" alt="npm downloads"></a>
|
|
11
|
+
<a href="https://github.com/tktcorporation/.github/blob/main/LICENSE"><img src="https://img.shields.io/github/license/tktcorporation/.github?color=blue&label=" alt="license"></a>
|
|
12
|
+
</p>
|
|
13
|
+
<br>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
> _berm_ — a shaped, maintained buffer zone between structures. Like a ziku bridges terrain, this tool bridges the gap between your template and your projects.
|
|
17
|
+
|
|
18
|
+
## Why
|
|
19
|
+
|
|
20
|
+
Templates go stale the moment you scaffold them. Each project improves upon the original — better configs, new workflows, refined settings — but those improvements never flow back.
|
|
21
|
+
|
|
22
|
+
**ziku** solves this with bi-directional sync:
|
|
23
|
+
|
|
24
|
+
- **`init`** — Pull the latest template into your project
|
|
25
|
+
- **`push`** — Push your improvements back to the template
|
|
26
|
+
- **`diff`** — See what's changed
|
|
27
|
+
|
|
28
|
+
Your template stays alive, fed by every project that uses it.
|
|
29
|
+
|
|
30
|
+
<!-- USAGE:START -->
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# Apply template to current directory
|
|
36
|
+
npx ziku
|
|
37
|
+
|
|
38
|
+
# Apply to a specific directory
|
|
39
|
+
npx ziku ./my-project
|
|
40
|
+
|
|
41
|
+
# Push your improvements back
|
|
42
|
+
npx ziku push -m "Add new workflow"
|
|
43
|
+
|
|
44
|
+
# Check what's different
|
|
45
|
+
npx ziku diff
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
<!-- USAGE:END -->
|
|
49
|
+
|
|
50
|
+
<!-- FEATURES:START -->
|
|
51
|
+
|
|
52
|
+
## Modules
|
|
53
|
+
|
|
54
|
+
Pick what you need:
|
|
55
|
+
|
|
56
|
+
- **Root** - MCP, mise, and other root-level config files
|
|
57
|
+
- **DevContainer** - VS Code DevContainer with Docker-in-Docker
|
|
58
|
+
- **GitHub** - GitHub Actions and labeler workflows
|
|
59
|
+
- **Claude** - Claude Code project settings
|
|
60
|
+
|
|
61
|
+
<!-- FEATURES:END -->
|
|
62
|
+
|
|
63
|
+
<!-- COMMANDS:START -->
|
|
64
|
+
|
|
65
|
+
## Commands
|
|
66
|
+
|
|
67
|
+
### `init`
|
|
68
|
+
|
|
69
|
+
Apply dev environment template to your project
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
Apply dev environment template to your project (ziku vdev)
|
|
73
|
+
|
|
74
|
+
USAGE `ziku [OPTIONS] [DIR]`
|
|
75
|
+
|
|
76
|
+
ARGUMENTS
|
|
77
|
+
|
|
78
|
+
`DIR="."` Target directory
|
|
79
|
+
|
|
80
|
+
OPTIONS
|
|
81
|
+
|
|
82
|
+
`--force` Overwrite existing files
|
|
83
|
+
`-y, --yes` Select all modules (non-interactive mode)
|
|
84
|
+
`-m, --modules` Comma-separated module IDs to apply (non-interactive)
|
|
85
|
+
`-s, --overwrite-strategy` Overwrite strategy: overwrite, skip, or prompt (non-interactive)
|
|
86
|
+
`--from` Template source as owner/repo (e.g., my-org/my-templates)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### `push`
|
|
90
|
+
|
|
91
|
+
Push local changes to the template repository as a PR
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
Push local changes to the template repository as a PR (push)
|
|
95
|
+
|
|
96
|
+
USAGE `push [OPTIONS] [DIR]`
|
|
97
|
+
|
|
98
|
+
ARGUMENTS
|
|
99
|
+
|
|
100
|
+
`DIR="."` Project directory
|
|
101
|
+
|
|
102
|
+
OPTIONS
|
|
103
|
+
|
|
104
|
+
`-n, --dryRun` Preview only, don't create PR
|
|
105
|
+
`-m, --message` PR title
|
|
106
|
+
`-y, -f, --yes` Skip confirmation prompts
|
|
107
|
+
`--edit` Edit PR title and description before creating
|
|
108
|
+
`-p, --prepare` Generate a manifest file for AI-agent friendly workflow (no PR created)
|
|
109
|
+
`-e, --execute` Execute push using the manifest file generated by --prepare
|
|
110
|
+
`--files` Comma-separated file paths to include in PR (non-interactive file selection for AI agents)
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### `diff`
|
|
114
|
+
|
|
115
|
+
Show differences between local and template
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
Show differences between local and template (diff)
|
|
119
|
+
|
|
120
|
+
USAGE `diff [OPTIONS] [DIR]`
|
|
121
|
+
|
|
122
|
+
ARGUMENTS
|
|
123
|
+
|
|
124
|
+
`DIR="."` Project directory
|
|
125
|
+
|
|
126
|
+
OPTIONS
|
|
127
|
+
|
|
128
|
+
`-v, --verbose` Show detailed diff
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### `ai-docs`
|
|
132
|
+
|
|
133
|
+
Show documentation for AI coding agents
|
|
134
|
+
|
|
135
|
+
```
|
|
136
|
+
Show documentation for AI coding agents (ai-docs)
|
|
137
|
+
|
|
138
|
+
USAGE `ai-docs `
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
<!-- COMMANDS:END -->
|
|
142
|
+
|
|
143
|
+
<!-- AI_AGENTS:START -->
|
|
144
|
+
|
|
145
|
+
## For AI Agents
|
|
146
|
+
|
|
147
|
+
AI coding agents can use the non-interactive workflow:
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
# 1. Generate manifest file
|
|
151
|
+
npx ziku push --prepare
|
|
152
|
+
|
|
153
|
+
# 2. Edit .devenv-push-manifest.yaml to select files and set PR details
|
|
154
|
+
|
|
155
|
+
# 3. Create PR from manifest
|
|
156
|
+
npx ziku push --execute
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
For detailed documentation, run:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
npx ziku ai-docs
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
<!-- AI_AGENTS:END -->
|
|
166
|
+
|
|
167
|
+
<!-- FILES:START -->
|
|
168
|
+
|
|
169
|
+
## What You Get
|
|
170
|
+
|
|
171
|
+
Files generated based on selected modules:
|
|
172
|
+
|
|
173
|
+
- **Root (`./`)** — MCP, mise, and other root-level config files
|
|
174
|
+
- **`.devcontainer/`** — VS Code DevContainer with Docker-in-Docker
|
|
175
|
+
- **`.github/`** — GitHub Actions and labeler workflows
|
|
176
|
+
- **`.claude/`** — Claude Code project settings
|
|
177
|
+
|
|
178
|
+
> See [`.devenv/modules.jsonc`](./.devenv/modules.jsonc) for the full list of tracked file patterns.
|
|
179
|
+
|
|
180
|
+
<!-- FILES:END -->
|
|
181
|
+
|
|
182
|
+
## Contributing
|
|
183
|
+
|
|
184
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
185
|
+
|
|
186
|
+
## License
|
|
187
|
+
|
|
188
|
+
[MIT](./LICENSE) License © [tktcorporation](https://github.com/tktcorporation)
|