From 47bc4369f5efc2d2168f268b44a92a40f3705110 Mon Sep 17 00:00:00 2001 From: addisonbeck Date: Tue, 14 Oct 2025 11:54:56 -0400 Subject: [PATCH 1/2] add callouts encouraging use of nx commands for client builds --- docs/getting-started/clients/browser/index.md | 15 +++++++++++++++ docs/getting-started/clients/cli/index.md | 14 ++++++++++++++ docs/getting-started/clients/desktop/index.mdx | 12 ++++++++++++ docs/getting-started/clients/web-vault/index.mdx | 13 +++++++++++++ 4 files changed, 54 insertions(+) diff --git a/docs/getting-started/clients/browser/index.md b/docs/getting-started/clients/browser/index.md index 3fb5cc03b..c9dd0c658 100644 --- a/docs/getting-started/clients/browser/index.md +++ b/docs/getting-started/clients/browser/index.md @@ -10,6 +10,21 @@ Before you start, you must complete the [Clients repository setup instructions]( ## Build instructions +:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For the +browser extension: + +```bash +# Build and watch (chrome is the default) +npx nx serve browser +# Build and watch for specific browsers +npx nx serve browser --configuration=firefox-dev +npx nx serve browser --configuration=safari-dev +``` + +For complete Nx documentation and all available commands, see +[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md). +::: + 1. Build and run the extension: ```bash diff --git a/docs/getting-started/clients/cli/index.md b/docs/getting-started/clients/cli/index.md index 36068ba96..96e037d49 100644 --- a/docs/getting-started/clients/cli/index.md +++ b/docs/getting-started/clients/cli/index.md @@ -17,6 +17,20 @@ Before you start, you must complete the [Clients repository setup instructions]( ## Build instructions +:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For the +cli: + +```bash +# Build and watch (GPL) +npx nx serve cli --configuration=oss-dev +# Build and watch (Bitwarden) +npx nx serve cli --configuration=commercial-dev +``` + +For complete Nx documentation and all available commands, see +[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md). +::: + Build and run: diff --git a/docs/getting-started/clients/desktop/index.mdx b/docs/getting-started/clients/desktop/index.mdx index dcb5f33c1..a2d6de5ee 100644 --- a/docs/getting-started/clients/desktop/index.mdx +++ b/docs/getting-started/clients/desktop/index.mdx @@ -37,6 +37,18 @@ These are available as additional dependencies in the Visual Studio Installer. +:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For +desktop: + +```bash +# Build and serve (including the native module) +npx nx serve desktop +``` + +For complete Nx documentation and all available commands, see +[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md). +::: + ## Build native module The desktop application relies on a native module written in rust, which needs to be compiled diff --git a/docs/getting-started/clients/web-vault/index.mdx b/docs/getting-started/clients/web-vault/index.mdx index a1a2f317c..e2af8d0d7 100644 --- a/docs/getting-started/clients/web-vault/index.mdx +++ b/docs/getting-started/clients/web-vault/index.mdx @@ -28,6 +28,19 @@ mkcert -cert-file dev-server.local.pem -key-file dev-server.local.pem localhost ## Build instructions +:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For web: + +```bash +# Build and watch (GPL) +npx nx serve web --configuration=oss-dev +# Build and watch (Bitwarden) +npx nx serve web --configuration=commercial-dev +``` + +For complete Nx documentation and all available commands, see +[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md). +::: + 1. Build and run the Web Vault. From 7c14d6a5b14e153372b29416c98e42a535212d95 Mon Sep 17 00:00:00 2001 From: addisonbeck Date: Tue, 14 Oct 2025 12:04:00 -0400 Subject: [PATCH 2/2] add periods to tip titles --- docs/getting-started/clients/browser/index.md | 5 +++-- docs/getting-started/clients/cli/index.md | 5 +++-- docs/getting-started/clients/desktop/index.mdx | 5 +++-- docs/getting-started/clients/web-vault/index.mdx | 4 +++- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/getting-started/clients/browser/index.md b/docs/getting-started/clients/browser/index.md index c9dd0c658..f292de17b 100644 --- a/docs/getting-started/clients/browser/index.md +++ b/docs/getting-started/clients/browser/index.md @@ -10,8 +10,9 @@ Before you start, you must complete the [Clients repository setup instructions]( ## Build instructions -:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For the -browser extension: +:::tip Nx commands are preferred. + +We now recommend using Nx commands for building projects. For the browser extension: ```bash # Build and watch (chrome is the default) diff --git a/docs/getting-started/clients/cli/index.md b/docs/getting-started/clients/cli/index.md index 96e037d49..9e4917e72 100644 --- a/docs/getting-started/clients/cli/index.md +++ b/docs/getting-started/clients/cli/index.md @@ -17,8 +17,9 @@ Before you start, you must complete the [Clients repository setup instructions]( ## Build instructions -:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For the -cli: +:::tip Nx commands are preferred. + +We now recommend using Nx commands for building projects. For the cli: ```bash # Build and watch (GPL) diff --git a/docs/getting-started/clients/desktop/index.mdx b/docs/getting-started/clients/desktop/index.mdx index a2d6de5ee..f8e80a24b 100644 --- a/docs/getting-started/clients/desktop/index.mdx +++ b/docs/getting-started/clients/desktop/index.mdx @@ -37,8 +37,9 @@ These are available as additional dependencies in the Visual Studio Installer. -:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For -desktop: +:::tip Nx commands are preferred. + +We now recommend using Nx commands for building projects. For desktop: ```bash # Build and serve (including the native module) diff --git a/docs/getting-started/clients/web-vault/index.mdx b/docs/getting-started/clients/web-vault/index.mdx index e2af8d0d7..eee3d30f5 100644 --- a/docs/getting-started/clients/web-vault/index.mdx +++ b/docs/getting-started/clients/web-vault/index.mdx @@ -28,7 +28,9 @@ mkcert -cert-file dev-server.local.pem -key-file dev-server.local.pem localhost ## Build instructions -:::tip Nx commands are preferred We now recommend using Nx commands for building projects. For web: +:::tip Nx commands are preferred. + +We now recommend using Nx commands for building projects. For web: ```bash # Build and watch (GPL)