CLI commands¶
Every command that the published packages register, read from the commands' own
definitions. Run them from the application root with vendor/bin/naf <command>; install
naf/cli and the package that provides the command first. vendor/bin/naf command:list
shows the commands of your installation. Generated by tools/gen_reference.py.
naf/cli¶
Version v0.2.4 · Console commands
| Command | Purpose | Arguments | Options |
|---|---|---|---|
command:list |
List all registered commands. | — | — |
plugins:debug |
Displays plugin boot order, declared prerequisites and absent optional targets. | — | — |
route:debug |
Displays current routes for an application. | — | — |
naf/alexa¶
Version v0.1.1 · Alexa+ MCP server
| Command | Purpose | Arguments | Options |
|---|---|---|---|
alexa:doctor |
Check local Alexa server configuration and store-listing metadata. | — | --server-only |
alexa:setup |
Register Alexa OAuth clients; optionally migrate OAuth tables and export addon.json. | — | --migrate, --manifest=… |
naf/board¶
Version v0.1.9 · Nafinity
| Command | Purpose | Arguments | Options |
|---|---|---|---|
nafinity:admin |
Grant the admin role to an existing account, while nobody holds it yet. | email (optional) |
--force |
nafinity:assets:check |
Compare published package assets with their sources; optional --package=vendor/name. | — | --package=… |
nafinity:assets:publish |
Copy registered package assets into the public directory; optional --package=vendor/name. | — | --package=… |
nafinity:assets:remove |
Delete previously published package assets; optional --package=vendor/name. | — | --package=… |
nafinity:grant-default |
Give accounts that hold no role at all the one an ordinary account has. | — | — |
nafinity:mail:check |
Check IMAP TLS/login/folder and the integration account without importing or sending mail. | — | — |
nafinity:mail:poll |
Append authorized replies to known cases; --rescan revisits retained messages. | — | --rescan |
nafinity:mail:smtp:check |
Verify the configured naf/mail SMTP TLS connection and login without sending mail. | — | — |
nafinity:migrations:rename |
Repoints recorded migrations after a namespace rename; shows the plan unless --apply is given. | — | --from=…, --to=…, --apply |
nafinity:seed |
Create local demo accounts and projects once; refuses production. | — | — |
nafinity:user |
Create an account, reading its password from standard input. | email (optional), name (optional) |
--admin |
naf/cms¶
Version v0.0.3 · NafCMS
| Command | Purpose | Arguments | Options |
|---|---|---|---|
ai:tools:debug |
Show which CMS tools the local AI routing layer selects for a phrase. | phrase |
--area=…, --mode=…, --capability=…, --content-type=…, --page-id=…, --layout-id=…, --theme-id=…, --limit=… (-l), --keyword, --json, --help |
db:create |
Create the configured MySQL database if it does not exist. | — | --force, --help |
docs:check |
Check whether README.md auto documentation blocks match NafCMS registries. | — | --help |
docs:sync |
Regenerate README.md auto documentation blocks from NafCMS registries. | — | --help |
install:database |
Create the database (if missing) and run all pending migrations. | — | --force, --help |
integrity:check |
Check block type, block view, and page template registry invariants. | — | --help |
make:block |
Create a host block type and its view. | id |
— |
make:plugin |
Create a Composer plugin skeleton. | id |
--path=… |
make:template |
Create a host page template. | id |
— |
nafcms:agents:install |
Create the host AGENTS.md without overwriting user-owned instructions. | — | --update, --help |
nafcms:assets:check |
Report missing, outdated, stale, or conflicting published assets. | — | — |
nafcms:assets:publish |
Publish versioned NafCMS assets into the host public directory. | — | — |
nafcms:assets:remove |
Remove only unchanged assets owned by the NafCMS publish manifest. | — | — |
seed:fake-data |
Insert demo articles, categories, tags, an admin user, and ensure the role/permission matrix is in place. | — | --help |
user:create |
Create the first installation administrator. | username (optional), email (optional), role (optional) |
--firstname=… (-f), --lastname=… (-l), --password-file=… (-p), --help |
naf/database¶
Version v0.2.4 · Database
| Command | Purpose | Arguments | Options |
|---|---|---|---|
db:migrate |
Execute migrations in either direction. | direction |
--name=… (-n) |
db:migration:create |
Create a skeleton migration in your application. | — | — |
naf/mcp¶
Version v0.2.7 · MCP tools
| Command | Purpose | Arguments | Options |
|---|---|---|---|
mcp:token:create |
Create a Bearer token for the MCP Streamable HTTP endpoint. | name (optional) |
--scope=… (-s), --expires=… (-e), --help |
mcp:token:list |
List stored MCP Bearer tokens without exposing token secrets. | — | --help |
mcp:token:revoke |
Revoke a stored MCP Bearer token by id. | id |
--help |
naf/oauth-client¶
Version v0.2.4 · OAuth client
| Command | Purpose | Arguments | Options |
|---|---|---|---|
oauth:discover |
Read a configured provider's metadata and print the callback URL to register with it. | provider (optional) |
— |
oauth:doctor |
Verify dependencies, connection, user model, tables, URLs and each configured login. | — | — |
naf/oauth-server¶
Version v0.2.6 · OAuth authorization server
| Command | Purpose | Arguments | Options |
|---|---|---|---|
oauth:client:create |
Register an application that may ask people to sign in with this server. | name |
--redirect=… (-r), --scope=… (-s), --grant=… (-g), --public (-p) |
oauth:client:list |
Show the registered applications, their kind and what they may ask for. | — | — |
oauth:client:rotate-secret |
Issue a new secret for a client, keeping the old one valid for a while. | client |
--overlap=… (-o), --now (-n) |
oauth:keys:generate |
Create the signing key, or rotate to a new one. Old keys stay published. | — | — |
oauth:keys:prune |
Remove rotated-out keys whose tokens have all expired. | — | --older-than=… (-o) |
oauth:server:doctor |
Verify the issuer, connection, schema, keys, scopes, login route and clients. | — | — |
oauth:server:setup |
Create the signing key if there is none, and say what is left to do. | — | — |
naf/queue¶
Version v0.2.5 · Queues and workers
| Command | Purpose | Arguments | Options |
|---|---|---|---|
queue:consume |
Run the queue worker | — | --once, --verbose (-v), --channel=…, --channels=…, --max-jobs=…, --max-runtime=… |
queue:retry-failed |
Retry failed jobs | — | --keep |
naf/rbac¶
Version v0.1.4 · Roles and permissions
| Command | Purpose | Arguments | Options |
|---|---|---|---|
rbac:sync |
Write the roles installed packages declare, without overwriting local changes. | — | --reapply |
naf/schedule¶
Version v0.2.4 · Scheduled jobs
| Command | Purpose | Arguments | Options |
|---|---|---|---|
schedule:list |
List scheduled jobs and their next run time. | — | --from=…, --no-sort |
schedule:ticker |
Execute recurring tasks with cron syntax. | — | --max-jobs=…, --max-runtime=…, --workers=…, --once |
naf/websocket¶
Version v0.1.1 · WebSocket notifications
| Command | Purpose | Arguments | Options |
|---|---|---|---|
websocket:serve |
Accept browser connections and fan out what the application publishes. | — | --address, --seconds |