create-colonel 0.1.0 → 0.1.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 +55 -0
- package/package.json +1 -1
- package/template/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# create-colonel
|
|
2
|
+
|
|
3
|
+
Scaffold a new Colonel app from the command line.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun create colonel my-app
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Alternative entry points:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
bunx create-colonel my-app
|
|
15
|
+
npx create-colonel my-app
|
|
16
|
+
npm create colonel@latest my-app
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Then run your new app:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
cd my-app
|
|
23
|
+
bun run start
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## What It Does
|
|
27
|
+
|
|
28
|
+
- Copies the app template into a new folder.
|
|
29
|
+
- Sets the generated `package.json` name from the folder name.
|
|
30
|
+
- Installs dependencies automatically.
|
|
31
|
+
- Prints next-step commands.
|
|
32
|
+
|
|
33
|
+
## Requirements
|
|
34
|
+
|
|
35
|
+
- Bun installed on your machine.
|
|
36
|
+
- `@coloneldev/framework` published and available on npm.
|
|
37
|
+
|
|
38
|
+
## Local Development
|
|
39
|
+
|
|
40
|
+
From this monorepo, you can run the generator directly:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
bun packages/create-colonel/src/cli.ts my-app
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
When run inside this repository, the CLI auto-links the local framework package for easier development.
|
|
47
|
+
|
|
48
|
+
## Publishing
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
cd packages/create-colonel
|
|
52
|
+
npm publish --access public
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Package: `create-colonel`
|
package/package.json
CHANGED