@tachles/starter 1.0.0 → 1.0.1
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 +12 -93
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @tachles/starter
|
|
2
2
|
|
|
3
|
-
Official CLI tool for installing
|
|
3
|
+
Official CLI tool for installing Tachles templates.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -20,113 +20,32 @@ npm install -g @tachles/starter
|
|
|
20
20
|
# Basic usage
|
|
21
21
|
npx @tachles/starter <template-id>
|
|
22
22
|
|
|
23
|
-
# With version
|
|
23
|
+
# With specific version
|
|
24
24
|
npx @tachles/starter <template-id>@1.2.0
|
|
25
25
|
|
|
26
|
-
#
|
|
27
|
-
npx @tachles/starter nextjs-prisma-shadcn
|
|
28
|
-
npx @tachles/starter nextjs-prisma-shadcn@1.2.0
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Get Template Information
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
npx @tachles/starter <template-id> --template-help
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
This will display:
|
|
38
|
-
- Template name and description
|
|
39
|
-
- Available configuration options
|
|
40
|
-
- Default values
|
|
41
|
-
- Usage examples
|
|
42
|
-
|
|
43
|
-
### Skip Prompts (Use Defaults)
|
|
44
|
-
|
|
45
|
-
```bash
|
|
26
|
+
# Skip interactive prompts (use defaults)
|
|
46
27
|
npx @tachles/starter <template-id> -y
|
|
47
28
|
```
|
|
48
29
|
|
|
49
|
-
###
|
|
30
|
+
### Options
|
|
50
31
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
# Using @ syntax
|
|
54
|
-
npx @tachles/starter nextjs-prisma-shadcn@1.2.0
|
|
55
|
-
|
|
56
|
-
# Still works with --version flag
|
|
57
|
-
npx @tachles/starter nextjs-prisma-shadcn --version 1.2.0
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
#### Force Refresh from Database (Bypass Cache)
|
|
61
|
-
```bash
|
|
62
|
-
npx @tachles/starter <template-id> --force-refresh
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Use this when:
|
|
66
|
-
- You want the absolute latest version from the database
|
|
67
|
-
- Cache might be stale
|
|
68
|
-
- Testing template updates
|
|
69
|
-
|
|
70
|
-
#### Verbose Mode (Show Cache Information)
|
|
71
|
-
```bash
|
|
72
|
-
npx @tachles/starter <template-id> --verbose
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
Shows:
|
|
76
|
-
- Cache status (HIT/MISS)
|
|
77
|
-
- Cache source (redis/database)
|
|
78
|
-
- Cache age and TTL
|
|
79
|
-
- API response details
|
|
80
|
-
|
|
81
|
-
## Examples
|
|
82
|
-
|
|
83
|
-
```bash
|
|
84
|
-
# Install Next.js + Prisma + shadcn/ui template
|
|
85
|
-
npx @tachles/starter nextjs-prisma-shadcn
|
|
86
|
-
|
|
87
|
-
# Install specific version with @ syntax
|
|
88
|
-
npx @tachles/starter nextjs-prisma-shadcn@1.2.0
|
|
89
|
-
|
|
90
|
-
# Get information about the template first
|
|
91
|
-
npx @tachles/starter nextjs-prisma-shadcn --template-help
|
|
92
|
-
|
|
93
|
-
# Install with default answers
|
|
94
|
-
npx @tachles/starter nextjs-prisma-shadcn -y
|
|
95
|
-
|
|
96
|
-
# Force refresh from database (bypass Redis cache)
|
|
97
|
-
npx @tachles/starter nextjs-prisma-shadcn --force-refresh
|
|
98
|
-
|
|
99
|
-
# Show detailed cache information
|
|
100
|
-
npx @tachles/starter nextjs-prisma-shadcn --verbose
|
|
101
|
-
|
|
102
|
-
# Combine options
|
|
103
|
-
npx @tachles/starter nextjs-prisma-shadcn@1.2.0 -y --verbose
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
# Combine options
|
|
107
|
-
npx @tachles/starter nextjs-prisma-shadcn -y --verbose --force-refresh
|
|
108
|
-
```
|
|
32
|
+
- `-y` - Skip prompts and use default values
|
|
33
|
+
- `--template-help` - Display template information without installing
|
|
109
34
|
|
|
110
35
|
## What It Does
|
|
111
36
|
|
|
112
|
-
1. Fetches template
|
|
113
|
-
2.
|
|
114
|
-
3. Installs packages
|
|
115
|
-
4. Runs commands
|
|
116
|
-
5.
|
|
117
|
-
6. Reports installation statistics
|
|
37
|
+
1. Fetches template configuration from Tachles platform
|
|
38
|
+
2. Prompts for setup options
|
|
39
|
+
3. Installs required packages
|
|
40
|
+
4. Runs initialization commands
|
|
41
|
+
5. Configures environment variables
|
|
118
42
|
|
|
119
43
|
## Requirements
|
|
120
44
|
|
|
121
45
|
- Node.js 18 or higher
|
|
122
46
|
- npm, yarn, or pnpm
|
|
123
47
|
|
|
124
|
-
## Support
|
|
125
|
-
|
|
126
|
-
- Browse Templates: https://your-app.vercel.app/templates
|
|
127
|
-
- Documentation: https://your-app.vercel.app/docs
|
|
128
|
-
- Issues: https://github.com/your-org/tachles-cli/issues
|
|
129
|
-
|
|
130
48
|
## License
|
|
131
49
|
|
|
132
50
|
MIT
|
|
51
|
+
|