45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
[](https://ci.appveyor.com/project/bitwarden/cli)
|
|
[](https://travis-ci.org/bitwarden/cli)
|
|
[](https://gitter.im/bitwarden/Lobby)
|
|
|
|
# Bitwarden Command-line Interface
|
|
|
|
<a href="https://bitwarden.com/#download"><img src="https://imgur.com/SLv9paA.png" width="500" height="113"></a>
|
|
|
|
The Bitwarden CLI is written with TypeScript and Node.js. The CLI can be run on Windows, macOS, and Linux distributions.
|
|
|
|
# Download/Install
|
|
|
|
You can install the CLI two different ways:
|
|
|
|
1. If you already have the Node.js runtime installed on your system, you can simply install the CLI using NPM. NPM makes it way to keep your installation updated as well.
|
|
```bash
|
|
npm install -g @bitwarden/cli
|
|
```
|
|
2. We provide natively packaged versions of the CLI for each operating system which have no requirements on installing the Node.js runtime. You can obtain these from the [downloads section](https://bitwarden.com/#download) on our website.
|
|
|
|
# Build/Run
|
|
|
|
**Requirements**
|
|
|
|
- [Node.js](https://nodejs.org/)
|
|
|
|
**Run the app**
|
|
|
|
```bash
|
|
npm install
|
|
npm run build:watch
|
|
```
|
|
|
|
You can then run commands from the `./build` folder:
|
|
|
|
```bash
|
|
node ./build/bw.js login
|
|
```
|
|
|
|
# Contribute
|
|
|
|
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.
|
|
|
|
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.
|