Sitelet
https://nx.dev/docs/reference/devkit/workspaceRoot
Skip to content
Docs
v23
v23
✓
v22
v21
v20
v19
Blog
Resources
Learn
Webinars
Nx Video Courses
Newsletter
Community
Discord
Books
Case Studies
Whitepapers
Events
Nx Live
Company
About Us
Customers
Partners
Nx Cloud
Pricing
Enterprise
Search
Ctrl
K
Cancel
Contact
Try Nx Cloud for Free
GitHub
YouTube
X
Discord
Select theme
Dark
Light
Auto
Getting Started
Technologies
Knowledge Base
Reference
Templates
Getting started
Intro to Nx
Installation
Start a new project
Add to existing project
AI integrations
CI setup
Editor setup
Tutorials
Crafting your workspace
Managing dependencies
Configuring tasks
Running tasks
Caching tasks
Understanding your workspace
Reducing boilerplate
How Nx works
Mental model
How caching works
Task pipeline configuration
Types of configuration
Nx plugins
Building blocks of fast CI
Platform features
Run tasks
Cache task results
Enhance your coding agent
Multi-language support
Code organization
Explore graph
Generate code
Sync generators
Enforce module boundaries
Overview
Ban dependencies with tags
Ban external imports
Tag multiple dimensions
Tags allow list
Continuous integration (CI)
Overview
Run affected tasks
Remote caching
Distribute task execution (Nx Agents)
Self-healing CI
Release & publishing
Nx Release overview
Publish in CI/CD
Automatic versioning with conventional commits
Customize conventional commit types
Configure changelog format
Configure custom registries
Configure version prefix
File-based versioning (version plans)
Release groups
Release projects independently
Build before versioning
Update dependents
Updating version references
Update local registry setup
Programmatic API
Maintenance
Automate updating dependencies
Advanced update process
Automate importing projects
Manual migrations
Preserving Git histories
Enterprise
Conformance
Configure conformance rules in Nx Cloud
Publish conformance rules to Nx Cloud
Owners
Custom workflows
Activate license
Single tenant
Overview
Auth GitHub
Auth GitLab
Auth Bitbucket
Auth Bitbucket Data Center
Custom GitHub app
Okta SAML
Azure SAML
Conformance reference
Overview
Create conformance rule
Test conformance rule
Generators
Executors
Enterprise release notes
Frameworks & libraries
TypeScript
Angular
Angular Rspack
Angular Rsbuild
React
Next.js
Remix
React Native
Expo
Vue
Nuxt
Module Federation
ESLint
Oxlint
Node
Node.js
Express
Nest
Java (JVM)
Java
Gradle
Maven
.NET
.NET
Build tools
Webpack
Vite
Rollup
ESBuild
Rspack
Rsbuild
Docker
Test tools
Cypress
Vitest
Jest
Playwright
Storybook
Detox
Plugin registry
Nx Commands
Glossary
Releases
Changelog
create-nx-workspace
nx.json
Project configuration
Inputs
Environment variables
nxignore
Nx Daemon
Code formatting
Nx MCP
Nx Console settings
Nx Cloud CLI
CI configuration file
Telemetry
Nx Cloud credit pricing
Deprecations
.NET
Generators
Migrations
Angular
Angular Generators
Angular Executors
Angular Migrations
Cypress
Generators
Executors
Migrations
Detox
Generators
Executors
Migrations
Devkit
Overview
ngcli_adapter
Overview
NxScopedHost
createBuilderContext
mockSchematicsForTesting
wrapAngularDevkitSchematic
AggregateCreateNodesError
AsyncIteratorExecutor
ChangeType
CreateDependencies
CreateDependenciesContext
CreateMetadata
CreateMetadataContext
CreateNodes
CreateNodesContext
CreateNodesContextV2
CreateNodesFunction
CreateNodesFunctionV2
CreateNodesResult
CreateNodesResultArray
CreateNodesResultV2
CreateNodesV2
CustomHasher
DefaultTasksRunnerOptions
DependencyType
DynamicDependency
Executor
ExecutorContext
ExecutorsJson
ExpandedPluginConfiguration
FileChange
FileData
FileMap
Generator
GeneratorCallback
GeneratorsJson
GraphJson
Hash
Hasher
HasherContext
ImplicitDependency
ImplicitDependencyEntry
ImplicitJsonSubsetDependency
JsonParseOptions
JsonSerializeOptions
Migration
MigrationReturnObject
MigrationsJson
NX_VERSION
NxAffectedConfig
NxJsonConfiguration
NxPlugin
NxPluginV2
Optional
OverwriteStrategy
PackageManager
PluginConfiguration
PostTasksExecution
PostTasksExecutionContext
PreTasksExecution
PreTasksExecutionContext
ProjectConfiguration
ProjectFileMap
ProjectGraph
ProjectGraphDependency
ProjectGraphExternalNode
ProjectGraphProjectNode
ProjectType
ProjectsConfigurations
ProjectsMetadata
PromiseExecutor
RawProjectGraphDependency
RemoteCache
StaleProjectGraphCacheError
StaticDependency
StringChange
StringDeletion
StringInsertion
Target
TargetConfiguration
TargetDefaultArrayEntry
TargetDefaultEntry
TargetDefaultFilter
TargetDefaultValue
TargetDefaults
TargetDependencyConfig
Task
TaskGraph
TaskGraphExecutor
TaskHasher
TaskResult
TaskResults
ToJSOptions
Tree
Workspace
WorkspaceJsonConfiguration
addDependenciesToPackageJson
addProjectConfiguration
applyChangesToString
cacheDir
convertNxExecutor
convertNxGenerator
createNodesFromFiles
createProjectFileMapUsingProjectGraph
createProjectGraphAsync
defaultTasksRunner
detectPackageManager
ensurePackage
extractLayoutDirectory
formatFiles
generateFiles
getDependencyVersionFromPackageJson
getOutputsForTargetAndConfiguration
getPackageManagerCommand
getPackageManagerVersion
getProjects
getWorkspaceLayout
glob
globAsync
hashArray
installPackagesTask
isDaemonEnabled
isWorkspacesEnabled
joinPathFragments
logger
moveFilesToNewDirectory
names
normalizePath
offsetFromRoot
output
parseJson
parseTargetString
readCachedProjectGraph
readJson
readJsonFile
readNxJson
readProjectConfiguration
readProjectsConfigurationFromProjectGraph
readTargetOptions
removeDependenciesFromPackageJson
removeProjectConfiguration
reverse
runExecutor
runTasksInSerial
serializeJson
stripIndents
stripJsonComments
targetToTargetString
toJS
updateJson
updateNxJson
updateProjectConfiguration
updateTsConfigsToJs
validateDependency
visitNotIgnoredFiles
workspaceLayout
workspaceRoot
writeJson
writeJsonFile
ESBuild
Generators
Executors
ESLint
ESLint Generators
ESLint Executors
ESLint Migrations
Java
Gradle Generators
Gradle Executors
Gradle Migrations
Maven Generators
Maven Executors
Maven Migrations
Jest
Generators
Executors
Migrations
Module Federation
Migrations
Node
Node Generators
Node Migrations
Express Generators
Nest Generators
Nest Migrations
Nx
Overview
nx Generators
nx Executors
nx Migrations
Oxlint
Oxlint Generators
Playwright
Generators
Executors
Migrations
Plugin
Overview
@nx/plugin Generators
React
React Generators
React Executors
React Migrations
Next.js Generators
Next.js Executors
Next.js Migrations
Remix Generators
Remix Executors
Remix Migrations
React Native Generators
React Native Executors
React Native Migrations
Expo Generators
Expo Executors
Expo Migrations
Rollup
Generators
Executors
Migrations
Rsbuild
Generators
Migrations
Rspack
Generators
Executors
Migrations
Storybook
Generators
Executors
Migrations
TypeScript
Generators
Executors
Migrations
Vite
Generators
Executors
Migrations
Vitest
Generators
Executors
Migrations
Vue
Vue Generators
Vue Migrations
Nuxt Generators
Nuxt Migrations
Web
Overview
@nx/web Generators
@nx/web Executors
@nx/web Migrations
Webpack
Generators
Executors
Migrations
Workspace
Overview
@nx/workspace Generators
@nx/workspace Migrations
GitHub
YouTube
X
Discord
Select theme
Dark
Light
Auto
29.4k
Give us a Star!
Contact
Login
Reference
Devkit
workspaceRoot
workspaceRoot
•
workspaceRoot
:
string
The root of the workspace
