@neural-tools/create 0.1.5 → 0.1.6
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.md +21 -80
- package/README.md +247 -0
- package/package.json +2 -2
package/LICENSE.md
CHANGED
|
@@ -1,80 +1,21 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 Luke Amy
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
### 2. Pro/Enterprise License (Proprietary)
|
|
24
|
-
|
|
25
|
-
The following features require a valid Pro or Enterprise license:
|
|
26
|
-
|
|
27
|
-
**Pro Features:**
|
|
28
|
-
- Vector database integration
|
|
29
|
-
- Semantic caching
|
|
30
|
-
- Fine-tuning workflows
|
|
31
|
-
- Cloud deployment templates (AWS/GCP)
|
|
32
|
-
- Premium templates and examples
|
|
33
|
-
- GitHub automation features
|
|
34
|
-
|
|
35
|
-
**Enterprise Features:**
|
|
36
|
-
- White-label support
|
|
37
|
-
- Custom integrations
|
|
38
|
-
- Priority support
|
|
39
|
-
- SLA guarantees
|
|
40
|
-
- Team collaboration features
|
|
41
|
-
|
|
42
|
-
These features are proprietary and may not be used without a valid license key purchased from neural-tools.dev.
|
|
43
|
-
|
|
44
|
-
### License Terms
|
|
45
|
-
|
|
46
|
-
1. **Free Tier**: You may use the free tier features for any purpose, including commercial use, under the MIT License terms.
|
|
47
|
-
|
|
48
|
-
2. **Pro/Enterprise**: You must purchase a license to access Pro or Enterprise features. Each license is:
|
|
49
|
-
- Per-user for individual licenses
|
|
50
|
-
- Per-organization for team/enterprise licenses
|
|
51
|
-
- Non-transferable without written consent
|
|
52
|
-
- Subject to the terms at neural-tools.dev/terms
|
|
53
|
-
|
|
54
|
-
3. **Source Code**: This repository is private. You may not:
|
|
55
|
-
- Redistribute the source code
|
|
56
|
-
- Create derivative works for redistribution
|
|
57
|
-
- Reverse engineer Pro/Enterprise features
|
|
58
|
-
- Remove or circumvent license checks
|
|
59
|
-
|
|
60
|
-
4. **Support**: Support is provided based on your license tier:
|
|
61
|
-
- Free: Community support only
|
|
62
|
-
- Pro: Email support (48-hour response)
|
|
63
|
-
- Enterprise: Priority support with SLA
|
|
64
|
-
|
|
65
|
-
### Warranty Disclaimer
|
|
66
|
-
|
|
67
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
68
|
-
|
|
69
|
-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
70
|
-
|
|
71
|
-
### Contact
|
|
72
|
-
|
|
73
|
-
For licensing inquiries:
|
|
74
|
-
- Email: licensing@neural-tools.dev
|
|
75
|
-
- Website: https://neural-tools.dev/pricing
|
|
76
|
-
- Support: support@neural-tools.dev
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
**Last Updated:** January 2025
|
|
1
|
+
# MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Luke Amy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
# @neural-tools/create
|
|
2
|
+
|
|
3
|
+
> Scaffold a new Neural Tools workspace
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@neural-tools/create)
|
|
6
|
+
[](../../LICENSE.md)
|
|
7
|
+
|
|
8
|
+
Quick project scaffolding for Neural Tools. Creates a new workspace with all necessary configuration and structure.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
### Using npx (Recommended)
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx @neural-tools/create my-workspace
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
### Using npm
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm create @neural-tools my-workspace
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Interactive Mode
|
|
25
|
+
|
|
26
|
+
Run without arguments for an interactive setup:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx @neural-tools/create
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
You'll be prompted for:
|
|
33
|
+
- Project name
|
|
34
|
+
- Description
|
|
35
|
+
- Template selection
|
|
36
|
+
- Package manager preference
|
|
37
|
+
|
|
38
|
+
## What Gets Created
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
my-workspace/
|
|
42
|
+
├── .gitignore
|
|
43
|
+
├── package.json
|
|
44
|
+
├── pnpm-workspace.yaml # If using pnpm
|
|
45
|
+
├── README.md
|
|
46
|
+
├── apps/ # MCP servers go here
|
|
47
|
+
│ └── .gitkeep
|
|
48
|
+
├── claude/
|
|
49
|
+
│ ├── commands/ # Slash commands
|
|
50
|
+
│ │ └── README.md
|
|
51
|
+
│ └── agents/ # Specialized agents
|
|
52
|
+
│ └── README.md
|
|
53
|
+
└── src/ # Your application code
|
|
54
|
+
└── index.ts
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Templates
|
|
58
|
+
|
|
59
|
+
Choose from pre-configured templates:
|
|
60
|
+
|
|
61
|
+
### Basic (Default)
|
|
62
|
+
Minimal setup with essential configuration.
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx @neural-tools/create my-workspace --template basic
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Full
|
|
69
|
+
Complete setup with examples and all features configured.
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npx @neural-tools/create my-workspace --template full
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### MCP
|
|
76
|
+
Optimized for MCP server development.
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
npx @neural-tools/create my-workspace --template mcp
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Monorepo
|
|
83
|
+
Pnpm workspace with multiple packages.
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npx @neural-tools/create my-workspace --template monorepo
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Command Options
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npx @neural-tools/create <project-name> [options]
|
|
93
|
+
|
|
94
|
+
Options:
|
|
95
|
+
-t, --template <name> Template to use (basic, full, mcp, monorepo)
|
|
96
|
+
-p, --package-manager <pm> Package manager (npm, pnpm, yarn)
|
|
97
|
+
--skip-install Skip dependency installation
|
|
98
|
+
--skip-git Skip git initialization
|
|
99
|
+
-h, --help Display help
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Examples
|
|
103
|
+
|
|
104
|
+
### Create with specific template
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
npx @neural-tools/create my-ai-tools --template full
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Use pnpm
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
npx @neural-tools/create my-workspace -p pnpm
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Skip installation
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
npx @neural-tools/create my-workspace --skip-install
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Complete custom setup
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
npx @neural-tools/create my-workspace \
|
|
126
|
+
--template monorepo \
|
|
127
|
+
--package-manager pnpm \
|
|
128
|
+
--skip-git
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## After Creation
|
|
132
|
+
|
|
133
|
+
Once your workspace is created:
|
|
134
|
+
|
|
135
|
+
### 1. Navigate to project
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
cd my-workspace
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 2. Generate an MCP server
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
npx neural-tools generate mcp github \
|
|
145
|
+
--description "GitHub integration"
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### 3. Generate a Claude command
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
npx neural-tools generate command search \
|
|
152
|
+
--description "Search project files"
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### 4. Start developing
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
npm run dev
|
|
159
|
+
# or
|
|
160
|
+
pnpm dev
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## Project Structure Details
|
|
164
|
+
|
|
165
|
+
### `/apps`
|
|
166
|
+
Contains generated MCP servers. Each server is a standalone application with its own dependencies and configuration.
|
|
167
|
+
|
|
168
|
+
### `/claude/commands`
|
|
169
|
+
Slash commands for Claude Code. These are markdown files that define custom commands you can use in Claude.
|
|
170
|
+
|
|
171
|
+
### `/claude/agents`
|
|
172
|
+
Specialized Claude agents with specific capabilities and system prompts.
|
|
173
|
+
|
|
174
|
+
### `/src`
|
|
175
|
+
Your application source code. The template includes a basic TypeScript setup.
|
|
176
|
+
|
|
177
|
+
## Configuration
|
|
178
|
+
|
|
179
|
+
The created project includes:
|
|
180
|
+
|
|
181
|
+
- **TypeScript** configuration
|
|
182
|
+
- **ESLint** setup (optional)
|
|
183
|
+
- **Prettier** configuration (optional)
|
|
184
|
+
- **Git** initialization
|
|
185
|
+
- **Package scripts** for common tasks
|
|
186
|
+
- **.gitignore** with sensible defaults
|
|
187
|
+
|
|
188
|
+
## Package Scripts
|
|
189
|
+
|
|
190
|
+
The generated `package.json` includes useful scripts:
|
|
191
|
+
|
|
192
|
+
```json
|
|
193
|
+
{
|
|
194
|
+
"scripts": {
|
|
195
|
+
"dev": "tsc --watch",
|
|
196
|
+
"build": "tsc",
|
|
197
|
+
"clean": "rm -rf dist",
|
|
198
|
+
"generate:mcp": "neural-tools generate mcp",
|
|
199
|
+
"generate:command": "neural-tools generate command"
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
## Requirements
|
|
205
|
+
|
|
206
|
+
- Node.js 18+
|
|
207
|
+
- npm, pnpm, or yarn
|
|
208
|
+
|
|
209
|
+
## Development
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
# Clone repository
|
|
213
|
+
git clone https://github.com/MacLeanLuke/neural-tools.git
|
|
214
|
+
cd neural-tools/packages/create-ai-toolkit
|
|
215
|
+
|
|
216
|
+
# Install dependencies
|
|
217
|
+
pnpm install
|
|
218
|
+
|
|
219
|
+
# Build
|
|
220
|
+
pnpm build
|
|
221
|
+
|
|
222
|
+
# Test locally
|
|
223
|
+
node dist/index.js my-test-project
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
## Dependencies
|
|
227
|
+
|
|
228
|
+
- [@neural-tools/core](../core) - Core utilities
|
|
229
|
+
- commander - CLI framework
|
|
230
|
+
- inquirer - Interactive prompts
|
|
231
|
+
- execa - Process execution
|
|
232
|
+
- fs-extra - File operations
|
|
233
|
+
- degit - Template cloning
|
|
234
|
+
|
|
235
|
+
## Contributing
|
|
236
|
+
|
|
237
|
+
Contributions are welcome! See the [main repository](https://github.com/MacLeanLuke/neural-tools) for guidelines.
|
|
238
|
+
|
|
239
|
+
## License
|
|
240
|
+
|
|
241
|
+
MIT - See [LICENSE.md](../../LICENSE.md) for details.
|
|
242
|
+
|
|
243
|
+
## Links
|
|
244
|
+
|
|
245
|
+
- [Documentation](https://neural-tools.com/docs/create.html)
|
|
246
|
+
- [GitHub](https://github.com/MacLeanLuke/neural-tools)
|
|
247
|
+
- [npm](https://www.npmjs.com/package/@neural-tools/create)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@neural-tools/create",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "Scaffold a new Neural Tools workspace",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"fs-extra": "^11.2.0",
|
|
37
37
|
"picocolors": "^1.0.0",
|
|
38
38
|
"degit": "^2.8.4",
|
|
39
|
-
"@neural-tools/core": "0.1.
|
|
39
|
+
"@neural-tools/core": "0.1.6"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"@types/fs-extra": "^11.0.4",
|