History

Matt Gibson c4ff8f99dc Multi root workspace tweaks (#2858 ) * Ignore jest for workspaces without tests (for now) * Add jest as recommended extension * Set eslint and prettier file paths We can't do this on a multi-folder workspace level because the path depths are not identical between folders * fix tsconfig extends for * Simplify bitwarden-licensed web tsconfig This tsconfig isn't needed to build, since we do that through webpack and the web client. It's only needed as hints to IDEs * Remove unintended change * linter		2022-06-13 21:39:36 -05:00
..
.vscode	Multi root workspace tweaks (#2858 )	2022-06-13 21:39:36 -05:00
config	Move CLI to apps/cli	2022-05-25 10:57:15 +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
spec	Migrate cli to jest (#2759 )	2022-05-31 16:29:10 +02:00
src	[EC-177] Update Key Connector error handling (#2748 )	2022-05-26 11:16:05 +10:00
stores	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
.eslintrc.json	[EC-239] CLI cleanup (#2745 )	2022-05-25 21:36:30 +02:00
.gitignore	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
.npmignore	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
README.md	Update README and CONTRIBUTING to point to contributing.bitwarden.com (#2771 )	2022-06-13 17:34:07 +10:00
jest.config.js	Add support for migrated jslib (#2826 )	2022-06-03 18:01:07 +02:00
package-lock.json	[PS-801] Re-add dependencies to the cli (#2878 )	2022-06-13 15:50:11 +02:00
package.json	[PS-801] Re-add dependencies to the cli (#2878 )	2022-06-13 15:50:11 +02:00
tsconfig.json	Add support for migrated jslib (#2826 )	2022-06-03 18:01:07 +02:00
tsconfig.spec.json	Migrate cli to jest (#2759 )	2022-05-31 16:29:10 +02:00
webpack.config.js	[PS-801] Re-add dependencies to the cli (#2878 )	2022-06-13 15:50:11 +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
```
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/.