create-absolutejs 0.1.10 → 0.2.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
CHANGED
|
@@ -1,15 +1,135 @@
|
|
|
1
1
|
# create-absolutejs
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A CLI tool to scaffold new AbsoluteJS projects quickly and effortlessly.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
Scaffold a new project called `<project-name>`:
|
|
4
8
|
|
|
5
9
|
```bash
|
|
6
|
-
bun
|
|
10
|
+
bun create absolutejs my-app
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Alternatively, using npm, Yarn, or pnpm:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm create absolutejs my-app
|
|
17
|
+
yarn create absolutejs my-app
|
|
18
|
+
pnpm create absolutejs my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
By default, the CLI will interactively prompt you for any missing configuration values. You can also supply flags to skip those prompts:
|
|
22
|
+
|
|
23
|
+
- To skip **all** optional prompts and use `none` for every optional configuration:
|
|
24
|
+
```bash
|
|
25
|
+
bun create absolutejs my-app --skip
|
|
26
|
+
```
|
|
27
|
+
- To skip **one** optional prompt without providing a real value, pass `none` to that flag:
|
|
28
|
+
```bash
|
|
29
|
+
bun create absolutejs my-app --auth none --engine none
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Options
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
Usage: create-absolute [options] [project-name]
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Arguments
|
|
39
|
+
|
|
40
|
+
- `project-name`
|
|
41
|
+
Name of the application to create. If omitted, you'll be prompted to enter one.
|
|
42
|
+
|
|
43
|
+
### Options
|
|
44
|
+
|
|
45
|
+
- `--help`, `-h`
|
|
46
|
+
Show the help message and exit.
|
|
47
|
+
- `--debug`, `-d`
|
|
48
|
+
Display a summary of the project configuration after creation.
|
|
49
|
+
- `--angular <name>`
|
|
50
|
+
Directory name for an Angular frontend.
|
|
51
|
+
- `--assets <name>`
|
|
52
|
+
Directory name for your static assets.
|
|
53
|
+
- `--auth <provider|none>`
|
|
54
|
+
Preconfigured auth plugin or `none` to skip auth setup.
|
|
55
|
+
- `--build <dir>`
|
|
56
|
+
Output directory for build artifacts.
|
|
57
|
+
- `--database <name>`
|
|
58
|
+
Directory name for your database files.
|
|
59
|
+
- `--directory <default|custom>`
|
|
60
|
+
Directory-naming strategy: `default` or `custom`.
|
|
61
|
+
- `--engine <engine|none>`
|
|
62
|
+
Database engine (`postgresql` | `mysql` | `sqlite` | `mongodb` | `redis` | `singlestore` | `cockroachdb` | `mssql`) or `none`.
|
|
63
|
+
- `--frontend <framework>`
|
|
64
|
+
Frontend framework(s) to include: one or more of `react`, `svelte`, `html`, `htmx`, `vue`, `angular`.
|
|
65
|
+
- `--git`
|
|
66
|
+
Initialize a Git repository.
|
|
67
|
+
- `--host <provider|none>`
|
|
68
|
+
Database host provider (`neon` | `planetscale` | `supabase` | `turso` | `vercel` | `upstash` | `atlas`) or `none`.
|
|
69
|
+
- `--html <name>`
|
|
70
|
+
Directory name for an HTML frontend.
|
|
71
|
+
- `--htmx <name>`
|
|
72
|
+
Directory name for an HTMX frontend.
|
|
73
|
+
- `--lang <ts|js>`
|
|
74
|
+
Language: `ts` or `js`.
|
|
75
|
+
- `--lts`
|
|
76
|
+
Use the latest published versions of required packages.
|
|
77
|
+
- `--npm`
|
|
78
|
+
Use the package manager that invoked this command to install dependencies.
|
|
79
|
+
- `--orm <drizzle|prisma|none>`
|
|
80
|
+
ORM to configure: `drizzle`, `prisma`, or `none`.
|
|
81
|
+
- `--plugin <plugin>`
|
|
82
|
+
Elysia plugin(s) to include (can be specified multiple times), or `none` to skip plugins.
|
|
83
|
+
- `--quality <eslint+prettier|biome>`
|
|
84
|
+
Code quality tool: `eslint+prettier` or `biome`.
|
|
85
|
+
- `--react <name>`
|
|
86
|
+
Directory name for a React frontend.
|
|
87
|
+
- `--script <ts|js|none>`
|
|
88
|
+
HTML scripting option: `ts`, `js`, or `none`.
|
|
89
|
+
- `--skip`
|
|
90
|
+
Skip **all** non-required prompts and use `none` for every optional configuration.
|
|
91
|
+
- `--svelte <name>`
|
|
92
|
+
Directory name for a Svelte frontend.
|
|
93
|
+
- `--tailwind`
|
|
94
|
+
Include Tailwind CSS setup.
|
|
95
|
+
- `--tailwind-input <path>`
|
|
96
|
+
Path to your Tailwind CSS entry file.
|
|
97
|
+
- `--tailwind-output <path>`
|
|
98
|
+
Path for the generated Tailwind CSS bundle.
|
|
99
|
+
- `--vue <name>`
|
|
100
|
+
Directory name for a Vue frontend.
|
|
101
|
+
|
|
102
|
+
## Directory Configuration
|
|
103
|
+
|
|
104
|
+
Choose between the **default** layout (pre-configured folder names) or **custom**, which prompts you to specify each directory name yourself:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
bun create absolutejs my-app --directory custom
|
|
7
108
|
```
|
|
8
109
|
|
|
9
|
-
|
|
110
|
+
## Debug & LTS Flags
|
|
111
|
+
|
|
112
|
+
- `--debug`, `-d`
|
|
113
|
+
After scaffolding, prints a detailed summary of your configuration (language, frontends, directories, etc.).
|
|
114
|
+
- `--lts`
|
|
115
|
+
Instructs the CLI to fetch and pin the latest published versions of your dependencies instead of its default pinned versions.
|
|
116
|
+
|
|
117
|
+
## Getting Started
|
|
118
|
+
|
|
119
|
+
Once the scaffold completes, you’re ready to go:
|
|
10
120
|
|
|
11
121
|
```bash
|
|
12
|
-
|
|
122
|
+
cd my-app
|
|
123
|
+
# (If you skipped automated install)
|
|
124
|
+
bun install
|
|
125
|
+
# Then start the dev server
|
|
126
|
+
bun run dev
|
|
13
127
|
```
|
|
14
128
|
|
|
15
|
-
|
|
129
|
+
## Contributing
|
|
130
|
+
|
|
131
|
+
Contributions are welcome! Feel free to open issues or submit pull requests to improve the CLI.
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Licensed under CC BY-NC 4.0.
|