movementkit-cli 1.0.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 +168 -0
- package/bin/mk.js +4 -0
- package/dist/index.js +4129 -0
- package/package.json +75 -0
package/README.md
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Movement Kit CLI
|
|
2
|
+
|
|
3
|
+
Command-line tool for bootstrapping and managing Movement Kit projects for Movement blockchain development.
|
|
4
|
+
|
|
5
|
+
**Version**: 1.0.0
|
|
6
|
+
|
|
7
|
+
## Overview
|
|
8
|
+
|
|
9
|
+
Movement Kit CLI (`mk`) is a command-line tool for quickly setting up dApp projects on Movement blockchain. Built with Bun and TypeScript, it provides:
|
|
10
|
+
|
|
11
|
+
- 🚀 **Quick Project Setup** - Bootstrap full-stack dApps in seconds
|
|
12
|
+
- 📦 **Kit Management** - Install and update Movement Kit templates
|
|
13
|
+
- 🩺 **Diagnostics** - Health checks for your development environment
|
|
14
|
+
- 🔧 **Claude Code Integration** - Pre-configured prompts and workflows
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Using npm
|
|
20
|
+
npm install -g movementkit-cli
|
|
21
|
+
|
|
22
|
+
# Using bun
|
|
23
|
+
bun add -g movementkit-cli
|
|
24
|
+
|
|
25
|
+
# Using yarn
|
|
26
|
+
yarn global add movementkit-cli
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
After installation:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
mk --version
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Quick Start
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Create a new Movement dApp project
|
|
39
|
+
mk new
|
|
40
|
+
|
|
41
|
+
# Or with options
|
|
42
|
+
mk new --dir my-dapp --kit engineer
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Commands
|
|
46
|
+
|
|
47
|
+
### `mk new`
|
|
48
|
+
|
|
49
|
+
Create a new Movement Kit project.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
mk new # Interactive mode
|
|
53
|
+
mk new --dir my-project # Specify directory
|
|
54
|
+
mk new --kit engineer # Select kit
|
|
55
|
+
mk new -y # Use defaults (non-interactive)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### `mk init`
|
|
59
|
+
|
|
60
|
+
Initialize or update Movement Kit in an existing project.
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
mk init # Interactive mode
|
|
64
|
+
mk init --global # Install globally to ~/.claude
|
|
65
|
+
mk init --fresh # Clean reinstall
|
|
66
|
+
mk init -y # Non-interactive with defaults
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `mk versions`
|
|
70
|
+
|
|
71
|
+
List available Movement Kit versions.
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
mk versions # Show stable versions
|
|
75
|
+
mk versions --all # Include prereleases
|
|
76
|
+
mk versions --limit 20 # Show more versions
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### `mk doctor`
|
|
80
|
+
|
|
81
|
+
Run diagnostics and health checks.
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
mk doctor # Full health check
|
|
85
|
+
mk doctor --fix # Auto-fix issues
|
|
86
|
+
mk doctor --check-only # CI mode (exit 1 on failures)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Global Options
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
mk --help # Show help
|
|
93
|
+
mk --version # Show version
|
|
94
|
+
mk <command> --verbose # Enable verbose logging
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Available Kits
|
|
98
|
+
|
|
99
|
+
| Kit | Description |
|
|
100
|
+
|-----|-------------|
|
|
101
|
+
| `engineer` | Full dApp development kit with contracts, backend, and frontend |
|
|
102
|
+
|
|
103
|
+
## Project Structure
|
|
104
|
+
|
|
105
|
+
After running `mk new`, your project will have:
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
my-dapp/
|
|
109
|
+
├── CLAUDE.md # Claude Code configuration
|
|
110
|
+
├── contracts/ # Move smart contracts
|
|
111
|
+
│ ├── Move.toml
|
|
112
|
+
│ └── sources/
|
|
113
|
+
├── backend/ # Express.js API server
|
|
114
|
+
│ ├── package.json
|
|
115
|
+
│ └── src/
|
|
116
|
+
├── frontend/ # React + Vite frontend
|
|
117
|
+
│ ├── package.json
|
|
118
|
+
│ └── src/
|
|
119
|
+
├── docs/ # Documentation and references
|
|
120
|
+
├── plans/ # Architecture plans
|
|
121
|
+
└── templates/ # Code templates
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Claude Code Commands
|
|
125
|
+
|
|
126
|
+
After setup, use these slash commands in Claude Code:
|
|
127
|
+
|
|
128
|
+
| Command | Description |
|
|
129
|
+
|---------|-------------|
|
|
130
|
+
| `/plan` | Create architecture plan |
|
|
131
|
+
| `/cook` | Generate full dApp code |
|
|
132
|
+
| `/cook:contracts` | Generate Move contracts |
|
|
133
|
+
| `/cook:backend` | Generate backend API |
|
|
134
|
+
| `/cook:frontend` | Generate React frontend |
|
|
135
|
+
| `/test` | Run all tests |
|
|
136
|
+
| `/review` | Security audit |
|
|
137
|
+
| `/deploy-full` | Deploy to Movement |
|
|
138
|
+
| `/watzup` | Check project status |
|
|
139
|
+
|
|
140
|
+
## Development
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
# Clone and install
|
|
144
|
+
git clone https://github.com/phatdev-hehe/movement-kit
|
|
145
|
+
cd movement-kit/movementkit-cli
|
|
146
|
+
bun install
|
|
147
|
+
|
|
148
|
+
# Run in development
|
|
149
|
+
bun run dev new --kit engineer
|
|
150
|
+
|
|
151
|
+
# Build
|
|
152
|
+
bun run build
|
|
153
|
+
|
|
154
|
+
# Test
|
|
155
|
+
bun test
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Requirements
|
|
159
|
+
|
|
160
|
+
- **Node.js** 18+
|
|
161
|
+
- **Bun** 1.3.2+ (recommended)
|
|
162
|
+
- **Movement CLI** (optional, for deployment)
|
|
163
|
+
- **Git**
|
|
164
|
+
|
|
165
|
+
## License
|
|
166
|
+
|
|
167
|
+
MIT
|
|
168
|
+
|
package/bin/mk.js
ADDED