nxSee schema
Schema for internal use only

Please do not extend this schema as it is part of Nx internal usage.

nx:set-up-ai-agents

Sets up the Nx MCP & rule files for common AI Agents.

Usage

1nx generate set-up-ai-agents ... 2

By default, Nx will search for set-up-ai-agents in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g nx:set-up-ai-agents ... 2

Show what will be generated without writing to disk:

1nx g set-up-ai-agents ... --dry-run 2

Options

directory

Required
string
Default: .

Directory where the AI agent configuration files will be generated

agents

Array<string>
Default: [claude,gemini,codex,cursor,copilot]
Accepted values: claude, gemini, codex, cursor, copilot

The agents to setup Nx configuration for.

packageVersion

string
Default: latest

The version of the package to use

writeNxCloudRules

boolean
Default: false

Whether to write Nx Cloud rules