Skip to content

Fix fedify init documentation to match implementation #628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sij411 wants to merge 1 commit into
base: 2.0-maintenance
Choose a base branch
from
+14 −34
Open

Fix fedify init documentation to match implementation #628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 14 additions & 34 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,11 +222,11 @@ fedify init my-fedify-project
The above command will start the interactive prompt to initialize a new Fedify
project. It will ask you a few questions to set up the project:

- Package manager: [Deno], [Bun], [npm], [pnpm], or [Yarn]
- Web framework: [Hono], [Elysia], [Express], [Nitro], or [Next.js]
- key–value store: In-memory, [Redis], [PostgreSQL], or [Deno KV] (if Deno)
- Message queue: In-memory, [Redis], [PostgreSQL], [AMQP] (e.g., [RabbitMQ]),
Comment on lines -227 to -228
Copy link
Member

@dahlia dahlia Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@2chanhaeng Do you know why we don't have in-memory options anymore?

- Package manager: [Deno], [Bun], [npm], [pnpm], or [Yarn]
- Message queue: [Redis], [PostgreSQL], [AMQP] (e.g., [RabbitMQ]),
or [Deno KV] (if Deno)
- Key–value store: [Redis], [PostgreSQL], or [Deno KV] (if Deno)

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

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

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

- `deno`: [Deno]
- `bun`: [Bun]
- `node`: [Node.js]

### `-p`/`--package-manager`: Node.js package manager

If you choose Node.js as the JavaScript runtime, you can specify the package
manager by using the `-p`/`--package-manager` option. The available options
are:

- `npm`: [npm]
- `pnpm`: [pnpm]
- `bun`: [Bun]
- `yarn`: [Yarn]

It's ignored if you choose Deno or Bun as the JavaScript runtime.
- `npm`: [npm]
Comment on lines 268 to +272
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The order of package managers in this list is inconsistent with the summary list on line 226. To avoid confusion, both lists should have the same order, and ideally match the order from the codebase (packages/init/src/json/pm.json: deno, bun, npm, yarn, pnpm). Please update both lists for consistency.

Suggested change
- `deno`: [Deno]
- `bun`: [Bun]
- `node`: [Node.js]
### `-p`/`--package-manager`: Node.js package manager
If you choose Node.js as the JavaScript runtime, you can specify the package
manager by using the `-p`/`--package-manager` option. The available options
are:
- `npm`: [npm]
- `pnpm`: [pnpm]
- `bun`: [Bun]
- `yarn`: [Yarn]
It's ignored if you choose Deno or Bun as the JavaScript runtime.
- `npm`: [npm]
- `deno`: [Deno]
- `bun`: [Bun]
- `npm`: [npm]
- `yarn`: [Yarn]
- `pnpm`: [pnpm]


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

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

- `fresh`: [Fresh] (if Deno)
- `hono`: [Hono]
- `express`: [Express] (unless Deno)
- `nitro`: [Nitro] (unless Deno)
- `nitro`: [Nitro]
- `next`: [Next.js]
- `elysia`: [Elysia]
- `express`: [Express]
Comment on lines 279 to +283
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The order of web frameworks in this list is inconsistent with the summary list on line 225 (Hono, Elysia, Express, Nitro, Next.js), which seems to correctly reflect the order in packages/init/src/webframeworks.ts. For consistency, please reorder this list to match.

Suggested change
- `hono`: [Hono]
- `express`: [Express] (unless Deno)
- `nitro`: [Nitro] (unless Deno)
- `nitro`: [Nitro]
- `next`: [Next.js]
- `elysia`: [Elysia]
- `express`: [Express]
- `hono`: [Hono]
- `elysia`: [Elysia]
- `express`: [Express]
- `nitro`: [Nitro]
- `next`: [Next.js]


If it's omitted, no web framework will be integrated.

[Fresh]: https://fresh.deno.dev/

### `-k`/`--kv-store`: key–value store
### `-k`/`--kv-store`: Key–value store

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

If it's omitted, the in-memory key–value store (which is for development
purpose) will be used.

### `-q`/`--message-queue`: Message queue
### `-m`/`--message-queue`: Message queue

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

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

If it's omitted, the in-process message queue (which is for development purpose)
will be used.

### `--dry-run`: Preview without creating files

*This option is available since Fedify 1.8.0.*
Expand Down
Loading