UNPKG

@bitwarden/cli/README.md

Version:

2.88 kBMarkdownView Raw

1[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/cli?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/cli)
2[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
3
4# Bitwarden Command-line Interface
5
6[![Platforms](https://imgur.com/ion0Mkf.png "Platforms")](https://help.bitwarden.com/article/cli/#download--install)
7
8The 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.
9
10![CLI](https://imgur.com/MPPu112.png "CLI")
11
12## Download/Install
13
14You can install the Bitwarden CLI multiple different ways:
15
16**NPM**
17
18If 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.
19
20```bash
21npm install -g @bitwarden/cli
22```
23
24**Native Executable**
25
26We 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](https://help.bitwarden.com/article/cli/#download--install) in the documentation.
27
28**Other Package Managers**
29
30- [Chocolatey](https://chocolatey.org/packages/bitwarden-cli)
31  ```bash
32  choco install bitwarden-cli
33  ```
34- Homebrew - *coming soon*
35  ```bash
36  brew install bitwarden
37  ```
38
39## Documentation
40
41The 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:
42
43```bash
44bw --help
45```
46
47This option will list all available commands that you can use with the CLI.
48
49Additionally, you can run the `--help` option on a specific command to learn more about it:
50
51```bash
52bw list --help
53bw create --help
54```
55
56**Detailed Documentation**
57
58We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.
59
60## Build/Run
61
62**Requirements**
63
64- [Node.js](https://nodejs.org/)
65
66**Run the app**
67
68```bash
69npm run sub:init
70npm install
71npm run build:watch
72```
73
74You can then run commands from the `./build` folder:
75
76```bash
77node ./build/bw.js login
78```
79
80## Contribute
81
82Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
83
84Security 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`](SECURITY.md) file.

1	`[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/cli?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/cli)`
2	`[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)`
3
4	`# Bitwarden Command-line Interface`
5
6	`[![Platforms](https://imgur.com/ion0Mkf.png "Platforms")](https://help.bitwarden.com/article/cli/#download--install)`
7
8	`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.`
9
10	`![CLI](https://imgur.com/MPPu112.png "CLI")`
11
12	`## Download/Install`
13
14	`You can install the Bitwarden CLI multiple different ways:`
15
16	`NPM`
17
18	`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.`
19
20	```bash
21	`npm install -g @bitwarden/cli`
22	```
23
24	`Native Executable`
25
26	`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](https://help.bitwarden.com/article/cli/#download--install) in the documentation.`
27
28	`Other Package Managers`
29
30	`- [Chocolatey](https://chocolatey.org/packages/bitwarden-cli)`
31	```bash
32	`choco install bitwarden-cli`
33	```
34	`- Homebrew - coming soon`
35	```bash
36	`brew install bitwarden`
37	```
38
39	`## Documentation`
40
41	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:
42
43	```bash
44	`bw --help`
45	```
46
47	`This option will list all available commands that you can use with the CLI.`
48
49	Additionally, you can run the `--help` option on a specific command to learn more about it:
50
51	```bash
52	`bw list --help`
53	`bw create --help`
54	```
55
56	`Detailed Documentation`
57
58	`We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.`
59
60	`## Build/Run`
61
62	`Requirements`
63
64	`- [Node.js](https://nodejs.org/)`
65
66	`Run the app`
67
68	```bash
69	`npm run sub:init`
70	`npm install`
71	`npm run build:watch`
72	```
73
74	You can then run commands from the `./build` folder:
75
76	```bash
77	`node ./build/bw.js login`
78	```
79
80	`## Contribute`
81
82	Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
83
84	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`](SECURITY.md) file.