mirror of https://github.com/bitwarden/browser.git synced 2024-11-06 09:20:43 +01:00

The browser extension vault (Chrome, Firefox, Opera, Edge, Safari, & more).

angular bitwarden chrome firefox javascript safari typescript webextension webextensions

Go to file

Joseph Flinn e1aaca8a17 adding PACKAGE_VERSION via an env file		2020-12-22 21:23:15 +00:00
.github/workflows	adding PACKAGE_VERSION via an env file	2020-12-22 21:23:15 +00:00
.vscode	chalk and source maps	2018-05-15 10:50:06 -04:00
jslib@2c414ce27a	Response option outputs only json on stdout (#197 )	2020-12-14 11:29:17 -06:00
scripts	bitwarden inc.	2020-02-18 22:36:04 -05:00
src	Response option outputs only json on stdout (#197 )	2020-12-14 11:29:17 -06:00
stores	add network-bind interface to support sso (#168 )	2020-09-23 12:33:12 -04:00
.editorconfig	command structure. debugging	2018-05-12 15:12:28 -04:00
.gitignore	switch to webpack	2018-05-14 23:16:59 -04:00
.gitmodules	move to https submodule	2018-05-16 15:56:31 -04:00
.npmignore	publish to npm	2018-05-15 00:45:42 -04:00
appveyor.yml	Revert "Update pkg to support `open` lib (#167 )"	2020-09-23 10:19:24 -04:00
CONTRIBUTING.md	expand contributing guide	2020-10-28 17:26:29 +10:00
LICENSE.txt	license file	2018-05-23 12:12:18 -04:00
package-lock.json	bump version	2020-12-02 15:38:25 -05:00
package.json	Response option outputs only json on stdout (#197 )	2020-12-14 11:29:17 -06:00
README.md	do it after npm install	2019-03-21 08:29:28 -04:00
SECURITY.md	contributing and security files	2018-05-18 11:53:00 -04:00
tsconfig.json	ignore notifications service	2018-08-20 22:22:17 -04:00
tslint.json	update jslib	2018-06-30 00:24:09 -04:00
webpack.config.js	webpack-node-externals	2019-02-07 23:15:17 -05: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.

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
```

Documentation

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

Detailed Documentation

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

Build/Run

Requirements

Node.js

Run the app

npm install
npm run sub:init # initialize the git submodule for jslib
npm run build:watch

You can then run commands from the ./build folder:

node ./build/bw.js login

Contribute

Code contributions are welcome! Please commit any pull requests against the master branch. Learn more about how to contribute by reading the CONTRIBUTING.md file.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the SECURITY.md file.