mirror of https://github.com/bitwarden/browser.git synced 2024-12-21 16:18:28 +01:00

History

Rui Tomé c263eacd88 [EC-376] Extract API logic from PolicyService to PolicyApiService (#3203 ) * Added abstractions for PolicyApiService and PolicyService * Added implementations for PolicyApiService and PolicyService * Updated all references to new PolicyApiService and PolicyService * Deleted old PolicyService abstraction and implementation * Fixed CLI import path for policy.service * Fixed main.background.ts policyApiService dependency for policyService * Updated policy-api.service with the correct imports * [EC-376] Sorted methods order in PolicyApiService * [EC-376] Removed unused clearCache method from PolicyService * [EC-376] Added upsert method to PolicyService * [EC-376] PolicyApiService putPolicy method now upserts data to PolicyService		2022-08-08 10:04:36 +01: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	PS-813 Add memory storage to state service (#2892 )	2022-06-27 12:38:12 -05:00
src	[EC-376] Extract API logic from PolicyService to PolicyApiService (#3203 )	2022-08-08 10:04:36 +01: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	Simplify our gitignore files (#2925 )	2022-06-17 15:33:51 +02:00
.npmignore	Move CLI to apps/cli	2022-05-25 10:57:15 +02:00
jest.config.js	PS-813 Add memory storage to state service (#2892 )	2022-06-27 12:38:12 -05:00
package-lock.json	Bumped cli version to 2022.8.0 (#3228 )	2022-08-04 17:21:30 +02:00
package.json	Bumped cli version to 2022.8.0 (#3228 )	2022-08-04 17:21:30 +02:00
README.md	Update README and CONTRIBUTING to point to contributing.bitwarden.com (#2771 )	2022-06-13 17:34:07 +10:00
tsconfig.json	Use NPM workspace (#2874 )	2022-06-14 17:10:53 +02:00
tsconfig.spec.json	Migrate cli to jest (#2759 )	2022-05-31 16:29:10 +02:00
webpack.config.js	Use NPM workspace (#2874 )	2022-06-14 17:10:53 +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/.