@lukoweb/create-apitogo 0.1.92 → 0.1.94

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.
Files changed (3) hide show
  1. package/README.md +21 -79
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -4,10 +4,8 @@ Create a new APIToGo app in seconds with `@lukoweb/create-apitogo`.
4
4
 
5
5
  ### Interactive
6
6
 
7
- You can create a new project interactively by running:
8
-
9
7
  ```bash
10
- npm create @lukoweb/apitogo@latest
8
+ npx @lukoweb/create-apitogo@latest
11
9
  # or
12
10
  yarn create @lukoweb/apitogo
13
11
  # or
@@ -16,96 +14,40 @@ pnpm create @lukoweb/apitogo
16
14
  bunx @lukoweb/create-apitogo
17
15
  ```
18
16
 
19
- You will be asked for the name of your project, and then whether you want to create a TypeScript
20
- project:
21
-
22
- ```bash
23
- ✔ Would you like to use TypeScript? … No / Yes
24
- ```
25
-
26
- Select **Yes** to install the necessary types/dependencies and create a new TS project.
17
+ You will be asked for the project name, TypeScript, and ESLint. Example files are not
18
+ prompted; they stay off unless you pass `--include-examples`.
27
19
 
28
20
  ### Non-interactive
29
21
 
30
- You can also pass command line arguments to set up a new project non-interactively. See
31
- `@lukoweb/create-apitogo --help`:
32
-
33
22
  ```bash
34
- Usage: @lukoweb/create-apitogo [project-directory] [options]
35
-
36
- Options:
37
- -V, --version output the version number
38
- --ts, --typescript
39
-
40
- Initialize as a TypeScript project. (default)
41
-
42
- --js, --javascript
43
-
44
- Initialize as a JavaScript project.
45
-
46
- --eslint
47
-
48
- Initialize with ESLint config.
49
-
50
- --with-examples
51
-
52
- Include starter example files (sample docs and OpenAPI spec). Default is an empty dev-portal site.
53
-
54
- --import-alias <alias-to-configure>
55
-
56
- Specify import alias to use (default "@/*").
57
-
58
- --use-npm
59
-
60
- Explicitly tell the CLI to bootstrap the application using npm
61
-
62
- --use-pnpm
63
-
64
- Explicitly tell the CLI to bootstrap the application using pnpm
65
-
66
- --use-yarn
67
-
68
- Explicitly tell the CLI to bootstrap the application using Yarn
69
-
70
- --use-bun
71
-
72
- Explicitly tell the CLI to bootstrap the application using Bun
73
-
74
- -e, --example [name]|[github-url]
75
-
76
- An example to bootstrap the app with. You can use an example name
77
- from the official Zudoku repo or a GitHub URL. The URL can use
78
- any branch and/or subdirectory
79
-
80
- --example-path <path-to-example>
81
-
82
- In a rare case, your GitHub URL might contain a branch name with
83
- a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar).
84
- In this case, you must specify the path to the example separately:
85
- --example-path foo/bar
86
-
87
- --reset-preferences
88
-
89
- Explicitly tell the CLI to reset any stored preferences
90
-
91
- --skip-install
92
-
93
- Explicitly tell the CLI to skip installing packages
23
+ npx @lukoweb/create-apitogo@latest my-portal --typescript --eslint
24
+ ```
94
25
 
95
- --yes
26
+ | Flag | Effect |
27
+ | --- | --- |
28
+ | `--typescript` / `--ts` | TypeScript project (default if you skip prompts in CI) |
29
+ | `--javascript` / `--js` | JavaScript project |
30
+ | `--eslint` | Add ESLint config |
31
+ | `--no-eslint` | Skip ESLint config |
32
+ | `--include-examples` | Add starter docs and a sample OpenAPI spec (off by default) |
33
+ | `--skip-install` | Do not run the package manager after scaffolding |
34
+ | `--use-npm` / `--use-pnpm` / `--use-yarn` / `--use-bun` | Force a package manager |
96
35
 
97
- Use previous preferences or defaults for all options that were not
98
- explicitly specified, without prompting.
36
+ `--with-examples` is an alias for `--include-examples`.
99
37
 
100
- -h, --help display help for command
38
+ ```bash
39
+ npx @lukoweb/create-apitogo@latest my-portal --javascript --no-eslint
40
+ npx @lukoweb/create-apitogo@latest my-portal --typescript --eslint --include-examples
101
41
  ```
102
42
 
43
+ See `npx @lukoweb/create-apitogo --help` for the full list (`--example`, `--skip-install`, …).
44
+
103
45
  ### Why use Create APIToGo App?
104
46
 
105
47
  `@lukoweb/create-apitogo` allows you to create a new APIToGo app within seconds. It includes a
106
48
  number of benefits:
107
49
 
108
- - **Interactive Experience**: Running `npm create @lukoweb/apitogo@latest` (with no arguments)
50
+ - **Interactive Experience**: Running `npx @lukoweb/create-apitogo@latest` (with no arguments)
109
51
  launches an interactive experience that guides you through setting up a project.
110
52
  - **Zero Dependencies**: Initializing a project is as quick as one second. Create APIToGo App has
111
53
  zero dependencies.