Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/getting-started/clients/browser/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,22 @@ 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
Expand Down
15 changes: 15 additions & 0 deletions docs/getting-started/clients/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,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 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:

<Bitwarden>
Expand Down
13 changes: 13 additions & 0 deletions docs/getting-started/clients/desktop/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,19 @@ These are available as additional dependencies in the Visual Studio Installer.
</TabItem>
</Tabs>

:::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
Expand Down
15 changes: 15 additions & 0 deletions docs/getting-started/clients/web-vault/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@ 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).
:::

<!-- prettier-ignore-start -->

1. Build and run the Web Vault.
Expand Down