Nx llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/nx/llms-txt) # Nx llms.txt Browse Nx documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. nx.dev/llms.txt [Raw llms.txt](https://nx.dev/docs/llms.txt) [Raw llms-full.txt](https://nx.dev/llms-full.txt) Copy Markdown [](https://nx.dev/llms.txt) llms.txt Quickstart Quickstart with Nx Getting Started Getting Started Integrate Nx with your Coding Assistant Editor Integration Installation What is Nx? Smart Monorepo Build System & CI Nx Cloud Setting Up CI Start a New Project Add to an Existing Project Tutorials Building and Testing Angular Apps in Nx Caching Tasks Configuring Tasks Crafting Your Nx Workspace Gradle Tutorial Managing Dependencies Building and Testing React Apps in Nx Reducing Configuration Boilerplate Running Tasks Building and Testing TypeScript Packages in Nx Understanding Your Workspace Core Concepts Core Concepts Publishable and Buildable Nx Libraries CI Concepts Building Blocks of Fast CI Cache Security Heartbeat and Main Job Completion Handling Parallelization and Distribution Reduce Wasted Time in CI Architectural Decisions Code Ownership Dependency Management Strategies Folder Structure Monorepo vs Polyrepo Project Dependency Rules Project Size What is a Monorepo? Executors and Configurations How Caching Works Inferred Tasks (Project Crystal) Mental Model Nx Daemon What Are Nx Plugins? Sync Generators What is a Task Pipeline Managing Configuration Files TypeScript Project Linking Features Features Automate Updating Dependencies Cache Task Results Orchestration & CI with Nx Cloud Run Only Tasks Affected by a PR Dedicated Compute Cluster Distribute Task Execution (Nx Agents) Docker Layer Caching Docker Read-Through Cache Dynamically Allocate Agents Identify and Re-run Flaky Tasks GitHub Actions integration npm Read-Through Cache Remote Caching (Nx Replay) Resource Usage Task Sandboxing AI-Powered Self-Healing CI Automatically Split Slow Tasks by File (Atomizer) Enforce Module Boundaries Enhance Your AI Coding Agent Explore your Workspace Generate Code Manage Releases Run Tasks Guides Guides Adopting Nx Adding Nx to your Existing Project Adding Nx to NPM/Yarn/PNPM Workspace Migrating from Turborepo to Nx Import an Existing Project into an Nx Workspace Manual Migration of Existing Code Bases Preserving Git Histories when Migrating Projects to Nx Prepare Applications for Deployment via CI Nx vs Bazel Nx vs Blacksmith Nx vs Buildkite Nx vs Depot Nx vs Develocity Nx vs Turborepo Nx vs Vite+ Enforce Module Boundaries Ban Dependencies with Certain Tags Ban External Imports Tag in Multiple Dimensions Tags Allow List Guides Install Nx in a Non-JavaScript Repository Update Your Global Nx Installation Nx Cloud Guides Nx CLI and CI Access Tokens Bring Your Own Compute Reduce the Number of Affected Projects in a CI Pipeline Execution Enable AI Features Enable End to End Encryption Fix sandbox violations Connecting Nx Cloud to your existing Google identity provider Optimize Your Time to Green (TTG) Nx Cloud and Personal Access Tokens Recording Non-Nx Commands Setting Up CI for Nx Cloud Source Control Integration Azure DevOps Integration Bitbucket Integration GitHub App Permissions GitLab Integration Set Up Bun with Mise on CI Nx Console Nx Console Generate Command Nx Console Migrate UI Nx Console & Nx Cloud Integration Nx Console Project Details View Nx Console Run Command Nx Console Telemetry Troubleshoot Nx Console Issues Nx Release Automate GitHub Releases Automate GitLab Releases Automatically Version with Conventional Commits Build Before Versioning Configuring Version Prefix for Dependencies Configure Changelog Format Configure Custom Registries Customize Conventional Commit Types File Based Versioning (Version Plans) Programmatic API Publish in CI/CD Using Nx Release with Rust Release Docker Images Release Groups Release TypeScript/JavaScript Packages to NPM Release Projects Independently Update Dependents Update Your Local Registry Setup to use Nx Release Updating Version References in Manifest Files Tasks & Caching Change Cache Location Configure Inputs for Task Caching Configure Outputs for Task Caching Migrate to Inferred Tasks (Project Crystal) Defining a Task Pipeline Pass Args to Commands Reduce Repetitive Configuration Run Root-Level NPM Scripts with Nx Running Custom Commands Run Tasks in Parallel Self-hosted remote cache Skip Task Caching Terminal UI Workspace Watching Tips and Tricks Advanced Update Process Disable Graph Links Created from Analyzing Source Files Configuring Browser Support Bun Workspaces: Setup, Commands, and Best Practices Define Environment Variables Optimize Testing with Feature-Based Testing Identify Dependencies Between Folders Include All package.json Files as Projects Including Assets in Your Build Keep Nx Versions in Sync Migrate nx imports to @nx/devkit npm Workspaces: Setup, Commands, and Best Practices pnpm Workspaces: Setup, Commands, and Best Practices Convert from a Standalone Repository to a Monorepo Using Yarn Plug'n'Play with Nx Yarn Workspaces: Setup, Commands, and Best Practices Extending Nx Extending Nx Compose Executors Composing Generators Creating an Install Package Create a Custom Plugin Preset Create a Sync Generator CreateNodes API Compatibility Creating Files with a Generator Extending Nx with Plugins Write a Simple Executor Local Generators Migration Generators Modifying Files with a Generator Enforce Organizational Best Practices with a Local Plugin Write a Performant Project Graph Plugin Extending the Project Graph Publish Your Nx Plugin Hook into the Task Running Lifecycle Integrate a New Tool with a Tooling Plugin Technologies Technologies Angular Angular with Rsbuild createServer - @nx/angular-rsbuild/ssr Nx with Angular Rsbuild Angular with Rspack Angular Rspack Compiler Angular Rspack Compiler angular-rspack-compiler createConfig - @nx/angular-rspack createServer - @nx/angular-rspack/ssr Guides Getting Started - Angular Rspack Handling Configurations Build-time Internationalization (i18n) with Angular Rspack Migrate Angular with Webpack to Rspack Nx with Angular Rspack angular-rspack @nx/angular Executors @nx/angular Generators Guides Nx and Angular Versions Advanced Angular Micro Frontends with Dynamic Module Federation Module Federation with Server-Side Rendering Nx and the Angular CLI Nx Devkit and Angular Devkit Setup Incremental Builds for Angular Applications Using Environment Variables in Angular Applications Using Tailwind CSS with Angular Nx with Angular angular Angular Migration Migrating an Angular CLI Project to Nx @nx/angular Migrations Build Tools Docker Nx with Docker docker @nx/docker Migrations ESBuild @nx/esbuild Executors @nx/esbuild Generators Nx with esbuild esbuild @nx/esbuild Migrations Rollup @nx/rollup Executors @nx/rollup Generators Nx with Rollup rollup @nx/rollup Migrations Rsbuild @nx/rsbuild Generators Nx with Rsbuild rsbuild @nx/rsbuild Migrations Rspack @nx/rspack Executors @nx/rspack Generators Nx with Rspack rspack @nx/rspack Migrations Vite @nx/vite Executors @nx/vite Generators Guides Configure Vite on your Nx workspace Nx with Vite vite @nx/vite Migrations Webpack @nx/webpack Executors @nx/webpack Generators Guides Configure Webpack in your Nx workspace Webpack plugins Nx with Webpack webpack @nx/webpack Migrations .NET @nx/dotnet Generators Guides Incremental Builds for .NET Projects Migrate from @nx-dotnet/core to @nx/dotnet Nx with .NET dotnet @nx/dotnet Migrations ESLint ESLint Plugin Guides Dependency Checks ESLint Rule Enforce Module Boundaries ESLint Rule ESLint Plugin eslint-plugin @nx/eslint-plugin Migrations @nx/eslint Executors @nx/eslint Generators Guides Custom Workspace ESLint Rules Configuring ESLint with TypeScript Migrate from .eslintrc to ESLint Flat Config Nx with ESLint eslint @nx/eslint Migrations Java Gradle @nx/gradle Executors @nx/gradle Generators Nx with Gradle gradle @nx/gradle Migrations Nx with Java Maven @nx/maven Executors @nx/maven Generators Nx with Maven maven @nx/maven Migrations Module Federation Concepts Faster Builds with Module Federation Manage Library Versions with Module Federation What is Micro Frontend Architecture? Module Federation and Nx Nx Module Federation Technical Overview Module Federation Consumer and Provider (v23+) Guides Creating a Module Federation Host Creating a Module Federation Remote Federate a Module NxModuleFederationDevServerPlugin NxModuleFederationPlugin Using Tailwind CSS with Module Federation Nx with Module Federation module-federation @nx/module-federation Migrations Vite Module Federation Node.js Express @nx/express Generators Nx with Express express @nx/express Migrations @nx/node Generators Guides Set Up Application Proxies Bundling Projects for Deployment Pruning Projects for Deployment Deploying AWS Lambda Functions in Node.js Deploying a Node App to Fly.io Add and Deploy Netlify Edge Functions with Node Wait for Tasks Nx with Node.js node @nx/node Migrations NestJS @nx/nest Generators Nx with Nest.js nest @nx/nest Migrations React @nx/react Executors Expo @nx/expo Executors @nx/expo Generators Nx with Expo expo @nx/expo Migrations @nx/react Generators Guides Adding Images, Fonts, and Files Deploying Next.js Applications to Vercel Module Federation with Server-Side Rendering React Compiler with Nx React Router with Nx Using Environment Variables in React Applications Using Tailwind CSS with React Nx with React react @nx/react Migrations Next.js @nx/next Executors @nx/next Generators Guides How to configure Next.js plugins Nx with Next.js next @nx/next Migrations React Native @nx/react-native Executors @nx/react-native Generators Nx with React Native react-native @nx/react-native Migrations Remix @nx/remix Executors @nx/remix Generators Nx with Remix remix @nx/remix Migrations Test Tools Cypress @nx/cypress Executors @nx/cypress Generators Guides Cypress Component Testing Using setupNodeEvents with Cypress preset Migrating to Cypress V11 Nx with Cypress cypress @nx/cypress Migrations Detox @nx/detox Executors @nx/detox Generators Nx with Detox detox @nx/detox Migrations Jest @nx/jest Executors @nx/jest Generators Nx with Jest jest @nx/jest Migrations Playwright @nx/playwright Executors @nx/playwright Generators Guides Merge Atomized Playwright Outputs Nx with Playwright playwright @nx/playwright Migrations Storybook @nx/storybook Executors @nx/storybook Generators Guides Angular - Configuring styles and preprocessor options Angular - Set up Compodoc for Storybook on Nx Storybook best practices for making the most out of Nx How Storybook is configured on your Nx workspace How to configure Webpack and Vite for Storybook Publishing Storybook - One main Storybook instance for all projects Publishing Storybook - One Storybook instance per scope Publishing Storybook - One main Storybook instance using Storybook Composition Set up Storybook for Angular Projects Set up Storybook for React Projects Set up Storybook for Vue and Nuxt Projects Setting up Storybook Composition with Nx Setting up Storybook Interaction Tests with Nx Upgrading Storybook Nx with Storybook storybook @nx/storybook Migrations Vitest @nx/vitest Executors @nx/vitest Generators Guides Migrating to @nx/vitest from @nx/vite Testing Without Building Dependencies Nx with Vitest vitest @nx/vitest Migrations TypeScript @nx/js Executors @nx/js Generators Guides Compile TypeScript Libraries to Multiple Formats Define Secondary Entry Points for TypeScript Packages Enable TypeScript Batch Mode JavaScript and TypeScript Switch to Workspaces and Project References Use TypeScript 7.0 alongside TypeScript 6.0 Nx with TypeScript js @nx/js Migrations Vue @nx/vue Generators Nx with Vue vue @nx/vue Migrations Nuxt @nx/nuxt Generators Guides Deploying Nuxt applications to Vercel Nx with Nuxt nuxt @nx/nuxt Migrations Reference References Angular Benchmarks Large Next.js Apps Made Faster with Nx Nx Agents at Scale TSC Batch Mode Conformance Create a Conformance Rule @nx/conformance - Executors @nx/conformance - Generators Overview of the Nx Conformance Plugin Test a Conformance Rules Cypress Deprecated affected:graph - CLI command Angular Schematics and Builders As Provided vs. Derived Generator Path Options Cacheable Operations Deprecating Custom Tasks Runner Global Implicit Dependencies Integrated Repos vs. Package-Based Repos vs. Standalone Apps Legacy Cache NPM Scope print-affected - CLI command Rescoping Packages from @nrwl to @nx Runtime Cache Inputs Deprecation notice: self-hosted remote cache packages Extending the Project Graph (v1 API) Workspace Executors Workspace Generators workspace.json Detox .NET Nx Environment Variables ESBuild ESLint Nx Glossary Inputs and Named Inputs Java Jest Module Federation Node Nx Cloud References Cloud Commands Assignment Rules Configuring the Cloud Runner Nx Cloud Credit Pricing Reference Custom images for Nx Agents Creating Custom Steps Launch Template Examples Launch Templates Enterprise Release Notes Nx Console Settings Reference nx.json Reference Nx MCP Server Reference .nxignore Reference Code Owners @nx/owners - Generators Overview of the Nx Owners Plugin Playwright Nx Powerpack End User License Agreement Project Configuration React Nx Release Schedule and Support Policy Rollup Rsbuild Rspack Storybook Telemetry TypeScript Vite Vitest Vue Webpack Enterprise Enterprise Activate Enterprise License Configure Conformance Rules in Nx Cloud Run Language-Agnostic Conformance Rules Custom Workflows Define Code Ownership at the Project Level Publish Conformance Rules to Nx Cloud Single Tenant BitBucket Cloud Auth BitBucket Data Center Auth GitHub Auth GitLab Auth Azure SAML Auth Custom GitHub App Okta SAML Auth Single Tenant Nx Cloud Hosting Troubleshooting Troubleshooting Understanding "CI Execution Failed" Troubleshoot Nx Console Issues Fix Nx Commands Failing in Claude Code Sandbox Profiling Performance Resolve Circular Dependencies Troubleshoot Cache Misses Troubleshoot Convert to Inferred Migration Troubleshoot Nx Installations Unknown Local Cache Error how-nx-works How Nx Works knowledge-base Knowledge Base Angular Benchmarks Comparisons Continuous Integration Creating Releases Cypress .NET ESLint Extending Nx Installation and updates Module Federation Node Nx Console Organizational Decisions Playwright React Recipes Storybook Tasks & Caching Troubleshooting TypeScript Vite Vitest Vue Webpack platform-features Platform Features Code Organization Enforce Module Boundaries Enterprise Conformance Reference Single Tenant Maintenance Orchestration & CI Release & Publishing technologies-tools Technologies & Tools Build Tools .NET Frameworks & Libraries Java (JVM) Node Test Tools Devkit API Reference (@nx/devkit) @nx/devkit Overview addDependenciesToPackageJson addProjectConfiguration AggregateCreateNodesError applyChangesToString AsyncIteratorExecutor cacheDir ChangeType convertNxExecutor convertNxGenerator CreateDependencies CreateDependenciesContext CreateMetadata CreateMetadataContext CreateNodes CreateNodesContext CreateNodesContextV2 createNodesFromFiles CreateNodesFunction CreateNodesFunctionV2 CreateNodesResult CreateNodesResultArray CreateNodesResultV2 CreateNodesV2 createProjectFileMapUsingProjectGraph createProjectGraphAsync CustomHasher defaultTasksRunner DefaultTasksRunnerOptions DependencyType detectPackageManager DynamicDependency ensurePackage Executor ExecutorContext ExecutorsJson ExpandedPluginConfiguration extractLayoutDirectory FileChange FileData FileMap formatFiles generateFiles Generator GeneratorCallback GeneratorsJson getDependencyVersionFromPackageJson getOutputsForTargetAndConfiguration getPackageManagerCommand getPackageManagerVersion getProjects getWorkspaceLayout glob globAsync GraphJson Hash hashArray Hasher HasherContext ImplicitDependency ImplicitDependencyEntry ImplicitJsonSubsetDependency installPackagesTask isDaemonEnabled isWorkspacesEnabled joinPathFragments JsonParseOptions JsonSerializeOptions logger Migration MigrationReturnObject MigrationsJson mockSchematicsForTesting moveFilesToNewDirectory names ngcli_adapter Overview normalizePath NX_VERSION NxAffectedConfig NxJsonConfiguration NxPlugin NxPluginV2 NxScopedHost offsetFromRoot Optional output OverwriteStrategy PackageManager parseJson parseTargetString PluginConfiguration PostTasksExecution PostTasksExecutionContext PreTasksExecution PreTasksExecutionContext ProjectConfiguration ProjectFileMap ProjectGraph ProjectGraphDependency ProjectGraphExternalNode ProjectGraphProjectNode ProjectsConfigurations ProjectsMetadata ProjectType PromiseExecutor RawProjectGraphDependency readCachedProjectGraph readJson readJsonFile readNxJson readProjectConfiguration readProjectsConfigurationFromProjectGraph readTargetOptions RemoteCache removeDependenciesFromPackageJson removeProjectConfiguration reverse runExecutor runTasksInSerial serializeJson StaleProjectGraphCacheError StaticDependency StringChange StringDeletion StringInsertion stripIndents stripJsonComments Target TargetConfiguration TargetDefaultArrayEntry TargetDefaultEntry TargetDefaultFilter TargetDefaults TargetDefaultValue TargetDependencyConfig targetToTargetString Task TaskGraph TaskGraphExecutor TaskHasher TaskResult TaskResults toJS ToJSOptions Tree updateJson updateNxJson updateProjectConfiguration updateTsConfigsToJs validateDependency visitNotIgnoredFiles Workspace WorkspaceJsonConfiguration workspaceLayout workspaceRoot wrapAngularDevkitSchematic writeJson writeJsonFile ## What is Nx's llms.txt? Nx publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Nx offers and where to find details. Pass Spec 15 Sections 780 Links 130.0 KB Size ~33.3k Tokens Sections: Quickstart · Getting Started · Core Concepts · Features · Guides · Extending Nx · and 9 more ## Add Nx Docs to Your AI Assistant Select your tool to see how to add Nx's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://nx.dev/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Nx Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 3 notes ## Frequently Asked Questions Where is Nx's llms.txt file? Nx publishes its llms.txt at https://nx.dev/llms.txt. This file provides a structured, markdown-formatted index of Nx's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Nx's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Nx's documentation so it can provide better code suggestions and answers about Nx. What does Nx's llms.txt contain? Nx's llms.txt contains 15 sections and 780 documentation links in 130.0 KB (~33.3k tokens). Key sections include Quickstart, Getting Started, Core Concepts, Features, Guides, Extending Nx. How many tokens does Nx's llms.txt use? The concise llms.txt index is approximately 33.3k tokens (130.0 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Nx? Nx is an AI-first monorepo platform that connects your editor to CI. It helps you deliver fast without breaking things by optimizing builds, scaling CI, and fixing failed PRs.. Nx's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Nx. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Knock Documentation](https://mdream.dev/llms-txt/nx/llms-txt/knock) [The JavaScript Oxidation Compiler The JavaScript Oxidation Compiler](https://mdream.dev/llms-txt/nx/llms-txt/oxc) [Tamagui Complete Documentation Tamagui is a complete UI solution for React Native and Web, with a fully-featured UI kit, styling engine, and optimizing compiler.](https://mdream.dev/llms-txt/nx/llms-txt/tamagui) [GitBook Documentation](https://mdream.dev/llms-txt/nx/llms-txt/gitbook) [Baeldung on Ops](https://mdream.dev/llms-txt/nx/llms-txt/baeldung-on-ops) [Appwrite Appwrite® - complete cloud infrastructure for your web, mobile and AI apps. Including Auth, Databases, Storage, Functions, Messaging, Hosting, Realtime and more](https://mdream.dev/llms-txt/nx/llms-txt/appwrite) [openmediavault](https://mdream.dev/llms-txt/nx/llms-txt/openmediavault) [Prefect](https://mdream.dev/llms-txt/nx/llms-txt/prefect) [View all 99 projects ](https://mdream.dev/llms-txt/nx/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/nx/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/nx/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)