@meltstudio/meltctl 1.1.1 → 1.3.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 +154 -0
- package/dist/commands/project/init.js +9 -5
- package/dist/index.js +8 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# @meltstudio/meltctl
|
|
2
|
+
|
|
3
|
+
CLI tool for Melt's AI-assisted development workflow. Initialize projects with Cursor AI commands and streamline your development process.
|
|
4
|
+
|
|
5
|
+
## 🚀 Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Install globally
|
|
9
|
+
npm install -g @meltstudio/meltctl
|
|
10
|
+
|
|
11
|
+
# Initialize your project
|
|
12
|
+
cd your-project
|
|
13
|
+
meltctl project init
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## 📋 What It Does
|
|
17
|
+
|
|
18
|
+
`meltctl` sets up your project with:
|
|
19
|
+
|
|
20
|
+
- **`.cursor/commands/`** - 8 AI-powered Cursor commands for your workflow
|
|
21
|
+
- **`.melt/`** - Project templates, memory, and outputs structure
|
|
22
|
+
|
|
23
|
+
## 🤖 Cursor AI Commands
|
|
24
|
+
|
|
25
|
+
After running `meltctl project init`, you get these commands in Cursor:
|
|
26
|
+
|
|
27
|
+
### Core Workflow Commands
|
|
28
|
+
|
|
29
|
+
- **`/melt-plan`** - Create detailed implementation plans
|
|
30
|
+
- **`/melt-test-plan`** - Generate test strategy and test files
|
|
31
|
+
- **`/melt-docs`** - Update project documentation
|
|
32
|
+
- **`/melt-implement`** - Execute implementation with best practices
|
|
33
|
+
- **`/melt-pr`** - Create pull request with proper description
|
|
34
|
+
- **`/melt-review`** - Review code for quality and compliance
|
|
35
|
+
- **`/melt-complete`** - Complete story and handle deployment
|
|
36
|
+
|
|
37
|
+
### Specialized Commands
|
|
38
|
+
|
|
39
|
+
- **`/melt-debug`** - Systematic debugging with AI assistance
|
|
40
|
+
|
|
41
|
+
## 🎯 Usage
|
|
42
|
+
|
|
43
|
+
### Initialize a New Project
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
meltctl project init
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
This command:
|
|
50
|
+
- Creates necessary directories
|
|
51
|
+
- Installs Cursor command templates
|
|
52
|
+
- Sets up project structure for AI-assisted development
|
|
53
|
+
- Supports both shell (sh/bash/zsh) and PowerShell environments
|
|
54
|
+
|
|
55
|
+
### Update Project (Coming Soon)
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
meltctl project update
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Updates your project templates to the latest version.
|
|
62
|
+
|
|
63
|
+
## 💡 Example Workflow
|
|
64
|
+
|
|
65
|
+
1. **Plan Your Feature**
|
|
66
|
+
```
|
|
67
|
+
# In Cursor, use:
|
|
68
|
+
/melt-plan
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
2. **Generate Tests**
|
|
72
|
+
```
|
|
73
|
+
/melt-test-plan
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
3. **Implement**
|
|
77
|
+
```
|
|
78
|
+
/melt-implement
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
4. **Create PR**
|
|
82
|
+
```
|
|
83
|
+
/melt-pr
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## 🛠️ Requirements
|
|
87
|
+
|
|
88
|
+
- Node.js 22+ (works with Node.js 18+ but 22+ recommended)
|
|
89
|
+
- [Cursor IDE](https://cursor.sh) for using the AI commands
|
|
90
|
+
- Git repository (recommended)
|
|
91
|
+
|
|
92
|
+
## 📚 Documentation
|
|
93
|
+
|
|
94
|
+
For comprehensive documentation, visit:
|
|
95
|
+
- [Documentation Site](https://melt-development-prompts.vercel.app)
|
|
96
|
+
- [Getting Started Guide](https://melt-development-prompts.vercel.app/getting-started)
|
|
97
|
+
- [Developer Workflow](https://melt-development-prompts.vercel.app/workflows)
|
|
98
|
+
|
|
99
|
+
## 🏗️ Project Structure
|
|
100
|
+
|
|
101
|
+
After initialization, your project will have:
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
your-project/
|
|
105
|
+
├── .cursor/
|
|
106
|
+
│ └── commands/ # Cursor AI command templates
|
|
107
|
+
│ ├── melt-plan.md
|
|
108
|
+
│ ├── melt-test-plan.md
|
|
109
|
+
│ ├── melt-docs.md
|
|
110
|
+
│ ├── melt-implement.md
|
|
111
|
+
│ ├── melt-pr.md
|
|
112
|
+
│ ├── melt-review.md
|
|
113
|
+
│ ├── melt-complete.md
|
|
114
|
+
│ └── melt-debug.md
|
|
115
|
+
└── .melt/
|
|
116
|
+
├── memory/ # Project context and state
|
|
117
|
+
├── outputs/ # Generated plans and implementations
|
|
118
|
+
│ ├── plans/
|
|
119
|
+
│ ├── implementations/
|
|
120
|
+
│ └── reviews/
|
|
121
|
+
├── scripts/ # Utility scripts
|
|
122
|
+
└── templates/ # Custom templates
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## 🤝 Contributing
|
|
126
|
+
|
|
127
|
+
This tool is part of the Melt Development Process. For issues or contributions:
|
|
128
|
+
- [GitHub Repository](https://github.com/MeltStudio/melt-development-prompts)
|
|
129
|
+
- [Report Issues](https://github.com/MeltStudio/melt-development-prompts/issues)
|
|
130
|
+
|
|
131
|
+
## 📦 What's Included
|
|
132
|
+
|
|
133
|
+
- Domain-driven development templates
|
|
134
|
+
- React 2025 patterns and standards
|
|
135
|
+
- TypeScript strict mode configurations
|
|
136
|
+
- Comprehensive testing strategies
|
|
137
|
+
- Accessibility compliance checks
|
|
138
|
+
- Performance optimization patterns
|
|
139
|
+
|
|
140
|
+
## ⚡ Benefits
|
|
141
|
+
|
|
142
|
+
- **40% faster development** with AI assistance
|
|
143
|
+
- **Consistent code quality** across teams
|
|
144
|
+
- **Built-in best practices** and standards
|
|
145
|
+
- **Systematic debugging** approach
|
|
146
|
+
- **Streamlined PR process**
|
|
147
|
+
|
|
148
|
+
## 📄 License
|
|
149
|
+
|
|
150
|
+
MIT © Melt Studio
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
Made with ❤️ by [Melt Studio](https://meltstudio.co) for developers who ship fast without sacrificing quality.
|
|
@@ -74,11 +74,15 @@ export async function initCommand(options = {}) {
|
|
|
74
74
|
console.log(` • ${chalk.cyan('.melt/templates/')}`);
|
|
75
75
|
console.log();
|
|
76
76
|
console.log('Next steps:');
|
|
77
|
-
console.log(' 1. Start using Cursor commands:');
|
|
78
|
-
console.log(` • ${chalk.cyan('/melt-
|
|
79
|
-
console.log(` • ${chalk.cyan('/melt-plan')} -
|
|
80
|
-
console.log(` • ${chalk.cyan('/melt-
|
|
81
|
-
console.log(` • ${chalk.cyan('/melt-
|
|
77
|
+
console.log(' 1. Start using Cursor commands (8 commands available):');
|
|
78
|
+
console.log(` • ${chalk.cyan('/melt-plan')} - Create detailed implementation plans`);
|
|
79
|
+
console.log(` • ${chalk.cyan('/melt-test-plan')} - Generate test strategy and test files`);
|
|
80
|
+
console.log(` • ${chalk.cyan('/melt-docs')} - Update project documentation`);
|
|
81
|
+
console.log(` • ${chalk.cyan('/melt-implement')} - Execute implementation with best practices`);
|
|
82
|
+
console.log(` • ${chalk.cyan('/melt-pr')} - Create pull request with proper description`);
|
|
83
|
+
console.log(` • ${chalk.cyan('/melt-review')} - Review code for quality and compliance`);
|
|
84
|
+
console.log(` • ${chalk.cyan('/melt-complete')} - Complete story and handle deployment`);
|
|
85
|
+
console.log(` • ${chalk.cyan('/melt-debug')} - Systematic debugging with AI assistance`);
|
|
82
86
|
console.log(' 2. Customize templates in .melt/templates/');
|
|
83
87
|
console.log(` 3. Use utility scripts in .melt/scripts/${selectedShell}/`);
|
|
84
88
|
outro(chalk.green('Happy coding with Melt! 🚀'));
|
package/dist/index.js
CHANGED
|
@@ -1,12 +1,19 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { Command } from '@commander-js/extra-typings';
|
|
3
|
+
import { readFileSync } from 'fs';
|
|
4
|
+
import { join, dirname } from 'path';
|
|
5
|
+
import { fileURLToPath } from 'url';
|
|
3
6
|
import { initCommand } from './commands/project/init.js';
|
|
4
7
|
import { updateCommand } from './commands/project/update.js';
|
|
8
|
+
// Read version from package.json
|
|
9
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
10
|
+
const __dirname = dirname(__filename);
|
|
11
|
+
const packageJson = JSON.parse(readFileSync(join(__dirname, '../package.json'), 'utf8'));
|
|
5
12
|
const program = new Command();
|
|
6
13
|
program
|
|
7
14
|
.name('meltctl')
|
|
8
15
|
.description('CLI tool for Melt development process automation')
|
|
9
|
-
.version(
|
|
16
|
+
.version(packageJson.version);
|
|
10
17
|
// Project management commands
|
|
11
18
|
const projectCommand = program
|
|
12
19
|
.command('project')
|
package/package.json
CHANGED