Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-12-21 16:18:28 +01:00
Code Issues Projects Releases Wiki Activity
6896ef2392
bitwarden-browser/apps/cli
History
Justin Baur c91f9146da
[PM-9978] Add State Logging Options (#10251) 
* Add `DebugOptions` to Definitions

* Respect Debug Options

* Configure DI
2024-07-29 13:21:21 +00:00
..
.vscode Multi root workspace tweaks (#2858) 2022-06-13 21:39:36 -05:00
config [PM-8391] turn on enableCipherKeyEncryption flag (#9362) 2024-06-18 12:11:10 -05: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-9978] Add State Logging Options (#10251) 2024-07-29 13:21:21 +00:00
stores Update CLI storefronts to use bitwarden licensed artifacts (#9827) 2024-06-26 16:01:05 -04: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-2328] Fix jest deprecations (#5483) 2023-05-22 20:19:16 +02:00
package.json [deps] Tools: Update jsdom to v24 (#10257) 2024-07-25 13:35:06 +02:00
README.md Update the README to mention the discrepancy with homebrew (#9856) 2024-06-28 10:59:28 -04:00
test.setup.ts [EC-423] Fix unit tests (#3265) 2022-08-11 11:35:08 +10:00
tsconfig.json [PM-9170] generator library migrations (#9812) 2024-06-27 12:16:04 -04:00
tsconfig.spec.json [EC-423] Fix unit tests (#3265) 2022-08-11 11:35:08 +10:00
webpack.config.js Remove clean-webpack-plugin (#8240) 2024-03-12 18:02:47 +01: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

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/.