mirror of https://github.com/bitwarden/browser.git synced 2024-12-22 16:29:09 +01:00

History

Bernd Schoolmann 2e6031eee9 Increase heap size for builds (#12483 ) * Increase heap size for builds * Add cross-env to cli * Add cross-env to desktop * Update apps/web/package.json Co-authored-by: Justin Baur <19896123+justindbaur@users.noreply.github.com> --------- Co-authored-by: Justin Baur <19896123+justindbaur@users.noreply.github.com>		2024-12-20 17:36:04 +01:00
..
.vscode	Multi root workspace tweaks (#2858 )	2022-06-13 21:39:36 -05:00
config	[PM-11290] Enable SDK (#11378 )	2024-10-07 13:56:02 +02:00
examples	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
scripts	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
src	[PM-16217] Remove wasm timeout (#12476 )	2024-12-20 13:54:52 +01:00
stores	Allow cli snap to access home and removable-media (#5577 )	2024-10-25 10:39:09 +02:00
.eslintrc.json	[EC-239] CLI cleanup (#2745 )	2022-05-25 21:36:30 +02:00
.npmignore	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
jest.config.js	[PM-11766] Introduce SDK client (#10974 )	2024-10-07 13:20:50 +02:00
package.json	Increase heap size for builds (#12483 )	2024-12-20 17:36:04 +01:00
README.md	Remove `[CLI]()` from `README.md`. (#12189 )	2024-12-09 16:41:13 +00:00
test.setup.ts	[EC-423] Fix unit tests (#3265 )	2022-08-11 11:35:08 +10:00
tsconfig.json	Typescript-strict-plugin (#12235 )	2024-12-09 20:58:50 +01:00
tsconfig.spec.json	[EC-423] Fix unit tests (#3265 )	2022-08-11 11:35:08 +10:00
webpack.config.js	[PM-11766] Introduce SDK client (#10974 )	2024-10-07 13:20:50 +02:00

README.md

Bitwarden Command-line Interface

The Bitwarden CLI is a powerful, full-featured command-line interface (CLI) tool to access and manage a Bitwarden vault. The CLI is written with TypeScript and Node.js and can be run on Windows, macOS, and Linux distributions.

Developer Documentation

Please refer to the CLI section of the Contributing Documentation for build instructions, recommended tooling, code style tips, and lots of other great information to get you started.

User Documentation

Download/Install

You can install the Bitwarden CLI multiple different ways:

NPM

If you already have the Node.js runtime installed on your system, you can install the CLI using NPM. NPM makes it easy to keep your installation updated and should be the preferred installation method if you are already using Node.js.

npm install -g @bitwarden/cli

Native Executable

We provide natively packaged versions of the CLI for each platform which have no requirements on installing the Node.js runtime. You can obtain these from the downloads section in the documentation.

Other Package Managers

Chocolatey
```
choco install bitwarden-cli
```
Homebrew
```
brew install bitwarden-cli
```
⚠️ The homebrew version is not recommended for all users.

Homebrew pulls the CLI's GPL build and does not include device approval commands for Enterprise SSO customers.
Snap
```
sudo snap install bw
```

Help Command

The Bitwarden CLI is self-documented with --help content and examples for every command. You should start exploring the CLI by using the global --help option:

bw --help

This option will list all available commands that you can use with the CLI.

Additionally, you can run the --help option on a specific command to learn more about it:

bw list --help
bw create --help

Help Center

We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.