命令参考

在本指南中，我们介绍框架核心与官方包随附的所有命令的用法。你也可以使用 node ace list 命令或 node ace <command-name> --help 命令查看命令帮助。

node ace list

serve

serve 使用 @adonisjs/assembler 包在开发环境中启动 AdonisJS 应用。你可以选择监视文件变化，并在每次文件变化时重启 HTTP 服务器。

node ace serve --hmr

serve 命令会作为子进程启动开发服务器（通过 bin/server.ts 文件）。如果你想向子进程传递 node 参数 ，可以在命令名称之前定义它们。

node ace --no-warnings --inspect serve --hmr

以下是你可以传递给 serve 命令的可用选项列表。或者，使用 --help 标志查看命令的帮助。

build

build 命令使用 @adonisjs/assembler 包来创建你的 AdonisJS 应用的生产构建。生成构建会执行以下步骤。

另请参阅： 创建生产构建 。

node ace build

以下是你可以传递给 build 命令的可用选项列表。或者，使用 --help 标志查看命令的帮助。

add

add 命令将 npm install <package-name> 和 node ace configure 命令结合在一起。因此，你无需运行两条独立的命令，而是可以使用 add 命令一次性安装并配置包。

add 命令会自动检测你的应用所使用的包管理器，并使用它来安装包。不过，你始终可以使用 --package-manager CLI 标志选择特定的包管理器。

# Install and configure the @adonisjs/lucid package
node ace add @adonisjs/lucid

# Install the package as a development dependency and configure it
node ace add my-dev-package --dev

如果包可以通过标志进行配置，你可以将它们直接传递给 add 命令。每一个未知的标志都会被向下传递给 configure 命令。

node ace add @adonisjs/lucid --db=sqlite

--verbose

启用详细模式以显示包安装与配置日志。

--force

向下传递给 configure 命令。在配置包时强制覆盖文件。详见 configure 命令。

--package-manager

定义用于安装包的包管理器。其值必须为 npm、pnpm、bun 或 yarn。

--dev

将包作为开发依赖安装。

configure

在包安装后对其进行配置。该命令接受包名作为第一个参数。

node ace configure @adonisjs/lucid

--verbose

启用详细模式以显示包安装日志。

--force

AdonisJS 的 stub 系统不会覆盖现有文件。例如，如果你配置了 @adonisjs/lucid 包，而你的应用已经有一个 config/database.ts 文件，配置过程将不会覆盖现有的配置文件。

不过，你可以使用 --force 标志强制覆盖文件。

eject

从给定包中弹出 stub 到你应用的 stubs 目录。在以下示例中，我们将 make/controller stub 复制到我们的应用中以进行修改。

另请参阅： 自定义 stub

# Copy stub from @adonisjs/core package
node ace eject make/controller

# Copy stub from @adonisjs/bouncer package
node ace eject make/policy --pkg=@adonisjs/bouncer

generate:key

生成一个密码学安全的随机密钥，并作为 APP_KEY 环境变量写入 .env 文件。

另请参阅： 应用密钥

node ace generate:key

--show

在终端上显示密钥，而不是将其写入 .env 文件。默认情况下，密钥会被写入 env 文件。

--force

当你的应用在生产环境中运行时，generate:key 命令不会将密钥写入 .env 文件。不过，你可以使用 --force 标志覆盖此行为。

make:controller

创建一个新的 HTTP 控制器类。控制器创建在 app/controllers 目录中，并使用以下命名约定。

• 形式：plural
• 后缀：controller
• 类名示例：UsersController
• 文件名示例：users_controller.ts

node ace make:controller users

你还可以生成带有自定义操作名称的控制器，如下例所示。

# Generates controller with "index", "show", and "store" methods
node ace make:controller users index show store

--singular

强制控制器名称为单数形式。

--resource

生成一个带有对资源执行 CRUD 操作所需方法的控制器。

--api

--api 标志与 --resource 标志类似。不过，它不会定义 create 和 edit 方法，因为它们用于显示表单。

make:middleware

创建一个新的用于 HTTP 请求的中间件。中间件存储在 app/middleware 目录中，并使用以下命名约定。

• 形式：singular
• 后缀：middleware
• 类名示例：BodyParserMiddleware
• 文件名示例：body_parser_middleware.ts

node ace make:middleware bodyparser

--stack

通过显式定义栈来跳过 中间件栈 选择提示。其值必须为 server、named 或 router。

node ace make:middleware bodyparser --stack=router

make:event

创建一个新的事件类。事件存储在 app/events 目录中，并使用以下命名约定。

• 形式：NA
• 后缀：NA
• 类名示例：OrderShipped
• 文件名示例：order_shipped.ts
• 建议：你必须围绕某个操作的声明周期来命名事件。例如：MailSending、MailSent、RequestCompleted 等。

node ace make:event orderShipped

make:validator

创建一个新的 VineJS 验证器文件。验证器存储在 app/validators 目录中，每个文件可以导出多个验证器。

• 形式：singular
• 后缀：NA
• 文件名示例：user.ts
• 建议：你必须围绕应用的资源来创建验证器文件。

# A validator for managing a user
node ace make:validator user

# A validator for managing a post
node ace make:validator post

--resource

创建一个带有用于 create 和 update 操作的预定义验证器的验证器文件。

node ace make:validator post --resource

make:listener

创建一个新的事件监听器类。监听器类存储在 app/listeners 目录中，并使用以下命名约定。

• 形式：NA
• 后缀：NA
• 类名示例：SendShipmentNotification
• 文件名示例：send_shipment_notification.ts
• 建议：事件监听器必须以其所执行的操作命名。例如，发送发货通知邮件的监听器应命名为 SendShipmentNotification。

node ace make:listener sendShipmentNotification

--event

在创建事件监听器的同时生成一个事件类。

node ace make:listener sendShipmentNotification --event=shipment_received

make:service

创建一个新的服务类。服务类存储在 app/services 目录中，并使用以下命名约定。

• 形式：singular
• 后缀：service
• 类名示例：InvoiceService
• 文件名示例：invoice_service.ts

node ace make:service invoice

make:exception

创建一个新的 自定义异常类 。异常存储在 app/exceptions 目录中。

• 形式：NA
• 后缀：exception
• 类名示例：CommandValidationException
• 文件名示例：command_validation_exception.ts

node ace make:exception commandValidation

make:command

创建一个新的 Ace 命令。默认情况下，命令存储在应用根目录下的 commands 目录中。

当你尝试执行任何 Ace 命令时，AdonisJS 会自动导入此目录中的命令。你可以在文件名前加 _ 前缀，以便在此目录中存储非 Ace 命令的附加文件。

• 形式：NA
• 后缀：NA
• 类名示例：ListRoutes
• 文件名示例：list_routes.ts
• 建议：命令必须以其所执行的操作命名。例如 ListRoutes、MakeController 和 Build。

node ace make:command listRoutes

make:view

创建一个新的 Edge.js 模板文件。模板创建在 resources/views 目录中。

• 形式：NA
• 后缀：NA
• 文件名示例：posts/view.edge
• 建议：你必须将某个资源的模板分组放在一个子目录中。例如：posts/list.edge、posts/create.edge 等。

node ace make:view posts/create
node ace make:view posts/list

make:provider

创建一个 服务提供者文件 。提供者存储在应用根目录下的 providers 目录中，并使用以下命名约定。

• 形式：singular
• 后缀：provider
• 类名示例：AppProvider
• 文件名示例：app_provider.ts

node ace make:provider app

--environments

定义应导入该提供者的环境。 了解更多关于应用环境

node ace make:provider app -e=web -e=console

make:preload

创建一个新的 预加载文件 。预加载文件存储在 start 目录中。

node ace make:preload view

--environments

定义应导入该预加载文件的环境。 了解更多关于应用环境

node ace make:preload view app -e=web -e=console

make:test

在 tests/<suite> 目录中创建一个新的测试文件。

• 形式：NA
• 后缀：.spec
• 文件名示例：posts/list.spec.ts、posts/update.spec.ts

node ace make:test --suite=unit

--suite

定义你要为其创建测试文件的套件。否则，命令会显示一个提示以便选择套件。

make:mail

在 app/mails 目录中创建一个新的邮件类。邮件类带有 Notification 关键字后缀。不过，你可以使用 --intent CLI 标志定义一个自定义后缀。

• 形式：NA
• 后缀：Intent
• 类名示例：ShipmentNotification
• 文件名示例：shipment_notification.ts

node ace make:mail shipment
# ./app/mails/shipment_notification.ts

--intent

为邮件定义一个自定义 intent。

node ace make:mail shipment --intent=confirmation
# ./app/mails/shipment_confirmation.ts

node ace make:mail storage --intent=warning
# ./app/mails/storage_warning.ts

make:policy

创建一个新的 Bouncer 策略类。策略存储在 app/policies 文件夹中，并使用以下命名约定。

• 形式：singular
• 后缀：policy
• 类名示例：PostPolicy
• 文件名示例：post_policy.ts

node ace make:policy post

inspect:rcfile

在合并默认值后查看 adonisrc.ts 文件的内容。你可以使用此命令检查可用的配置选项，并根据你的应用需求覆盖它们。

另请参阅： AdonisRC 文件

node ace inspect:rcfile

list:routes

查看你的应用已注册的路由列表。该命令会以 console 环境启动你的 AdonisJS 应用。

node ace list:routes

此外，如果你使用的是我们的 官方 VSCode 扩展 ，你也可以从 VSCode 活动栏中查看路由列表。

--json

以 JSON 字符串形式查看路由。输出将是一个对象数组。

--table

在 CLI 表格中查看路由。默认情况下，我们以紧凑、美观的列表形式显示路由。

--middleware

筛选路由列表，并包含使用所提及中间件的那些路由。你可以使用 * 关键字来包含使用一个或多个中间件的路由。

--ignore-middleware

筛选路由列表，并包含未使用所提及中间件的那些路由。你可以使用 * 关键字来包含不使用任何中间件的路由。

env:add

env:add 命令允许你向 .env、.env.example 文件添加新的环境变量，并且还会在 start/env.ts 文件中定义验证规则。

你只需运行命令，它就会提示你输入变量名、值和验证规则。或者你也可以将它们作为参数传递。

# Will prompt for the variable name, value, and validation rules
node ace env:add

# Define the variable name, value, and validation rule
node ace env:add MY_VARIABLE value --type=string

--type

定义环境变量的类型。其值必须为以下之一：string、boolean、number、enum。

--enum-values

当类型为 enum 时，定义环境变量的允许值。

node ace env:add MY_VARIABLE foo --type=enum --enum-values=foo --enum-values=bar