bitwarden-estensione-browser/apps/cli
Oscar Hinton 2126ac414c
[EC-236] Add CLI dependencies to root package.json (#2816)
2022-06-03 20:11:47 +02:00
..
.vscode Move CLI to apps/cli 2022-05-25 10:57:15 +02: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 [EC-239] CLI cleanup (#2745) 2022-05-25 21:36:30 +02:00
jest.config.js Add support for migrated jslib (#2826) 2022-06-03 18:01:07 +02:00
package.json [EC-236] Add CLI dependencies to root package.json (#2816) 2022-06-03 20:11:47 +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 [EC-236] Add CLI dependencies to root package.json (#2816) 2022-06-03 20:11:47 +02:00

README.md

Github Workflow build on master Join the chat at https://gitter.im/bitwarden/Lobby

Bitwarden Command-line Interface

Platforms

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.

CLI

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

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 v16.13.1.
    • Testing is done against Node 16, other versions may work, but are not guaranteed.
  • NPM v8

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