Skip to content

Commit 8014e61

Browse files
authored
Merge pull request #628 from sij411/fix/init-docs
Fix `fedify init` documentation to match implementation
2 parents 136de69 + 07ce9e8 commit 8014e61

1 file changed

Lines changed: 14 additions & 34 deletions

File tree

docs/cli.md

Lines changed: 14 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -222,11 +222,11 @@ fedify init my-fedify-project
222222
The above command will start the interactive prompt to initialize a new Fedify
223223
project. It will ask you a few questions to set up the project:
224224

225-
- Package manager: [Deno], [Bun], [npm], [pnpm], or [Yarn]
226225
- Web framework: [Hono], [Elysia], [Express], [Nitro], or [Next.js]
227-
- key–value store: In-memory, [Redis], [PostgreSQL], or [Deno KV] (if Deno)
228-
- Message queue: In-memory, [Redis], [PostgreSQL], [AMQP] (e.g., [RabbitMQ]),
226+
- Package manager: [Deno], [Bun], [npm], [pnpm], or [Yarn]
227+
- Message queue: [Redis], [PostgreSQL], [AMQP] (e.g., [RabbitMQ]),
229228
or [Deno KV] (if Deno)
229+
- Key–value store: [Redis], [PostgreSQL], or [Deno KV] (if Deno)
230230

231231
> [!TIP]
232232
> Projects created with `fedify init` automatically include [`@fedify/lint`]
@@ -260,43 +260,29 @@ interactive prompts:
260260
[`@fedify/lint`]: /manual/lint
261261
[`@fedify/create`]: https://www.npmjs.com/package/@fedify/create
262262

263-
### `-r`/`--runtime`: JavaScript runtime
263+
### `-p`/`--package-manager`: Package manager
264264

265-
You can specify the JavaScript runtime by using the `-r`/`--runtime` option.
266-
The available options are:
265+
You can specify the package manager by using the `-p`/`--package-manager`
266+
option. The available options are:
267267

268268
- `deno`: [Deno]
269-
- `bun`: [Bun]
270-
- `node`: [Node.js]
271-
272-
### `-p`/`--package-manager`: Node.js package manager
273-
274-
If you choose Node.js as the JavaScript runtime, you can specify the package
275-
manager by using the `-p`/`--package-manager` option. The available options
276-
are:
277-
278-
- `npm`: [npm]
279269
- `pnpm`: [pnpm]
270+
- `bun`: [Bun]
280271
- `yarn`: [Yarn]
281-
282-
It's ignored if you choose Deno or Bun as the JavaScript runtime.
272+
- `npm`: [npm]
283273

284274
### `-w`/`--web-framework`: Web framework
285275

286276
You can specify the web framework to integrate with Fedify by using
287277
the `-w`/`--web-framework` option. The available options are:
288278

289-
- `fresh`: [Fresh] (if Deno)
290279
- `hono`: [Hono]
291-
- `express`: [Express] (unless Deno)
292-
- `nitro`: [Nitro] (unless Deno)
280+
- `nitro`: [Nitro]
281+
- `next`: [Next.js]
293282
- `elysia`: [Elysia]
283+
- `express`: [Express]
294284

295-
If it's omitted, no web framework will be integrated.
296-
297-
[Fresh]: https://fresh.deno.dev/
298-
299-
### `-k`/`--kv-store`: key–value store
285+
### `-k`/`--kv-store`: Key–value store
300286

301287
You can specify the key–value store to use by using the `-k`/`--kv-store`
302288
option. The available options are:
@@ -305,22 +291,16 @@ option. The available options are:
305291
- `postgres`: [PostgreSQL]
306292
- `denokv`: [Deno KV] (if Deno)
307293

308-
If it's omitted, the in-memory key–value store (which is for development
309-
purpose) will be used.
310-
311-
### `-q`/`--message-queue`: Message queue
294+
### `-m`/`--message-queue`: Message queue
312295

313-
You can specify the message queue to use by using the `-q`/`--message-queue`
296+
You can specify the message queue to use by using the `-m`/`--message-queue`
314297
option. The available options are:
315298

316299
- `redis`: [Redis]
317300
- `postgres`: [PostgreSQL]
318301
- `amqp`: [AMQP] (e.g., [RabbitMQ])
319302
- `denokv`: [Deno KV] (if Deno)
320303

321-
If it's omitted, the in-process message queue (which is for development purpose)
322-
will be used.
323-
324304
### `--dry-run`: Preview without creating files
325305

326306
*This option is available since Fedify 1.8.0.*

0 commit comments

Comments
 (0)