Skip to content

Commit 0321f60

Browse files
authored
add callouts encouraging use of nx commands for client builds (#697)
* add callouts encouraging use of nx commands for client builds * add periods to tip titles
1 parent b2f9f95 commit 0321f60

File tree

4 files changed

+59
-0
lines changed

4 files changed

+59
-0
lines changed

docs/getting-started/clients/browser/index.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,22 @@ Before you start, you must complete the [Clients repository setup instructions](
1010

1111
## Build instructions
1212

13+
:::tip Nx commands are preferred.
14+
15+
We now recommend using Nx commands for building projects. For the browser extension:
16+
17+
```bash
18+
# Build and watch (chrome is the default)
19+
npx nx serve browser
20+
# Build and watch for specific browsers
21+
npx nx serve browser --configuration=firefox-dev
22+
npx nx serve browser --configuration=safari-dev
23+
```
24+
25+
For complete Nx documentation and all available commands, see
26+
[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md).
27+
:::
28+
1329
1. Build and run the extension:
1430

1531
```bash

docs/getting-started/clients/cli/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@ Before you start, you must complete the [Clients repository setup instructions](
1717

1818
## Build instructions
1919

20+
:::tip Nx commands are preferred.
21+
22+
We now recommend using Nx commands for building projects. For the cli:
23+
24+
```bash
25+
# Build and watch (GPL)
26+
npx nx serve cli --configuration=oss-dev
27+
# Build and watch (Bitwarden)
28+
npx nx serve cli --configuration=commercial-dev
29+
```
30+
31+
For complete Nx documentation and all available commands, see
32+
[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md).
33+
:::
34+
2035
Build and run:
2136

2237
<Bitwarden>

docs/getting-started/clients/desktop/index.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ These are available as additional dependencies in the Visual Studio Installer.
3737
</TabItem>
3838
</Tabs>
3939

40+
:::tip Nx commands are preferred.
41+
42+
We now recommend using Nx commands for building projects. For desktop:
43+
44+
```bash
45+
# Build and serve (including the native module)
46+
npx nx serve desktop
47+
```
48+
49+
For complete Nx documentation and all available commands, see
50+
[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md).
51+
:::
52+
4053
## Build native module
4154

4255
The desktop application relies on a native module written in rust, which needs to be compiled

docs/getting-started/clients/web-vault/index.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,21 @@ mkcert -cert-file dev-server.local.pem -key-file dev-server.local.pem localhost
2828

2929
## Build instructions
3030

31+
:::tip Nx commands are preferred.
32+
33+
We now recommend using Nx commands for building projects. For web:
34+
35+
```bash
36+
# Build and watch (GPL)
37+
npx nx serve web --configuration=oss-dev
38+
# Build and watch (Bitwarden)
39+
npx nx serve web --configuration=commercial-dev
40+
```
41+
42+
For complete Nx documentation and all available commands, see
43+
[Using Nx to Build Projects](https://github.com/bitwarden/clients/blob/main/docs/using-nx-to-build-projects.md).
44+
:::
45+
3146
<!-- prettier-ignore-start -->
3247

3348
1. Build and run the Web Vault.

0 commit comments

Comments
 (0)