New Nx Repository
✨ Your new, shiny Nx workspace is ready ✨.
Learn more about this workspace setup and its capabilities or run npx nx graph to visually explore what was created. Now, let's get you up to speed!
Finish your Nx platform setup
🚀 Finish setting up your workspace to get faster builds with remote caching, distributed task execution, and self-healing CI. Learn more about Nx Cloud.
Generate a library```sh
npx nx g @nx/js:lib packages/pkg1 --publishable --importPath=@my-org/pkg1
## Run tasks
To build the library use:```sh
npx nx build pkg1
To run any task with Nx use:```sh
npx nx <target> <project-name>
These targets are either inferred automatically or defined in the `project.json` or `package.json` files.
More about running tasks in the docs »
## Versioning and releasing
To version and release the library use```
npx nx release
Pass --dry-run to see what would happen without actually releasing the library.
Learn more about Nx release »
Keep TypeScript project references up to date
Nx automatically updates TypeScript project references in tsconfig.json files to ensure they remain accurate based on your project dependencies (import or require statements). This sync is automatically done when running tasks such as build or typecheck, 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:```sh
npx nx sync
You 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:```sh
npx nx sync:check
Learn more about nx sync
Nx Cloud
Nx Cloud ensures a fast and scalable CI pipeline. It includes features such as:
- Remote caching
- Task distribution across multiple machines
- Automated e2e test splitting
- Task flakiness detection and rerunning
Set up CI (non-Github Actions CI)
Note: This is only required if your CI provider is not GitHub Actions.
Use the following command to configure a CI workflow for your workspace:sh
npx nx g ci-workflow
Learn more about Nx on CI
Install Nx Console
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.
Install Nx Console »
Useful links
Learn more:
- Learn more about this workspace setup
- Learn about Nx on CI
- Releasing Packages with Nx release
- What are Nx plugins?
And join the Nx community:
- Discord
- Follow us on X or LinkedIn
- Our Youtube channel
- Our blog
