✨ Your new, shiny Nx workspace has been successfully created! ✨.
Learn more about this workspace setup and the @aws/nx-plugin. Now, let's get you up to speed!
Nx Console is an editor extension that enriches your developer experience. It lets you run tasks, generate code, and improves code autocompletion in your IDE. It is available for VSCode and IntelliJ.
The following list of generators are what is currently available in the @aws/nx-plugin:
-
connection: Integrates a source project with a target project
-
license: Add LICENSE files and configure source code licence headers
-
py#api: Create a Python API
-
py#lambda-function: Adds a lambda function to a python project
-
py#mcp-server: Generate a Python Model Context Protocol (MCP) server for providing context to Large Language Models
-
py#project: Generates a Python project
-
py#agent: Add an AI Agent to a Python project
-
terraform#project: Generates a Terraform project
-
ts#docs: Generates a documentation site
-
ts#infra: Generates a cdk application
-
ts#lambda-function: Generate a TypeScript lambda function
-
ts#mcp-server: Generate a TypeScript Model Context Protocol (MCP) server for providing context to Large Language Models
-
ts#nx-generator: Generator for adding an Nx Generator to an existing TypeScript project
-
ts#nx-plugin: Generate an Nx Plugin of your own! Build custom generators automatically made available for AI vibe-coding via MCP
-
ts#project: Generates a TypeScript project
-
ts#website: Generates a website application
-
ts#website#auth: Adds auth to an existing website
-
ts#agent: Add an AI Agent to a TypeScript project
-
ts#api: Create a TypeScript API
-
ts#rdb: Create a relational database project
-
ts#dynamodb: Create a DynamoDB project
You also have the option of using additional commmunity plugins as needed.
pnpm nx g @aws/nx-plugin:<generator-name>Alternatively you can use the Nx IDE plugin to invoke your generators.
Refer to the full documentation for additional guidance for each generator.
pnpm nx build <project-name>pnpm nx run-many --target build --all
# or
pnpm buildpnpm nx <target> <project-name>pnpm nx run-many --target lint --configuration=fix --all
# or
pnpm lintpnpm nx run-many --target test --all --updateThese targets are either inferred automatically or defined in the project.json or package.json files.
More about running tasks in the Nx docs »
Nx automatically updates TypeScript project references in tsconfig.json files to ensure they remain accurate based on your project dependencies (import statements). This sync is automatically done when running tasks such as build, which require updated references to function correctly.
To manually trigger the process to sync the project graph dependencies information to the TypeScript project references, run the following command:
pnpm nx syncYou can enforce that the TypeScript project references are always in the correct state when running in CI by adding a step to your CI job configuration that runs the following command:
pnpm nx sync:checkUse the following command to configure a CI workflow for your workspace:
pnpm nx g ci-workflowLearn more: