mirror of https://github.com/bitwarden/browser.git synced 2024-12-20 16:07:45 +01:00

History

Thomas Rittson b14bb92d78 [AC-2579] Set up bit-cli folder (#9092 ) * Create bit-cli folder with configs * Add bit-cli to workspace * Refactor CLI app structure * services are managed by the ServiceContainer * programs are registered by register(Oss\|Bit)Program * the app is bootstrapped by Main * Reapply changes from #9099 * Reapply changes from #8604 * Reapply changes from #9115		2024-05-15 10:09:24 -04:00
..
.vscode	Multi root workspace tweaks (#2858 )	2022-06-13 21:39:36 -05:00
config	Individual Vault Item Encryption Feature (#6241 )	2023-09-28 08:44:57 -04: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	[AC-2579] Set up bit-cli folder (#9092 )	2024-05-15 10:09:24 -04:00
stores	Update snapcraft.base (#7448 )	2024-01-05 15:15:08 +00: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	[AC-2579] Set up bit-cli folder (#9092 )	2024-05-15 10:09:24 -04:00
README.md	Update urls to match the contributing docs (#4192 )	2022-12-06 11:20:27 +01:00
test.setup.ts	[EC-423] Fix unit tests (#3265 )	2022-08-11 11:35:08 +10:00
tsconfig.json	[PM-5459] Move libs/exporter to libs/tools/ (#7380 )	2024-02-13 14:22:37 -05: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

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