bitwarden-estensione-browser/apps/cli/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

85 lines
2.7 KiB
Markdown
Raw Normal View History

2022-05-25 21:36:30 +02:00
[![Github Workflow build on master](https://github.com/bitwarden/clients/actions/workflows/build-cli.yml/badge.svg?branch=master)](https://github.com/bitwarden/clients/actions/workflows/build-cli.yml?query=branch:master)
2018-05-15 14:00:27 +02:00
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
# Bitwarden Command-line Interface
2018-05-25 22:15:29 +02:00
[![Platforms](https://imgur.com/AnTLX0S.png "Platforms")](https://help.bitwarden.com/article/cli/#download--install)
2018-05-15 14:00:27 +02:00
2018-05-18 17:49:28 +02:00
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.
2018-05-15 14:08:31 +02:00
2018-07-19 16:50:35 +02:00
![CLI](https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/cli-macos.png "CLI")
2018-05-18 18:06:59 +02:00
2018-05-24 13:58:58 +02:00
## Download/Install
2018-05-15 14:08:31 +02:00
2018-05-18 17:49:28 +02:00
You can install the Bitwarden CLI multiple different ways:
2018-05-15 14:08:31 +02:00
2018-05-18 17:49:28 +02:00
**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.
```bash
npm install -g @bitwarden/cli
```
**Native Executable**
2018-05-24 13:57:44 +02:00
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.
2018-05-23 22:45:11 +02:00
**Other Package Managers**
- [Chocolatey](https://chocolatey.org/packages/bitwarden-cli)
2018-05-25 22:16:14 +02:00
```powershell
2018-05-23 22:45:11 +02:00
choco install bitwarden-cli
```
2018-05-28 14:56:25 +02:00
- [Homebrew](https://formulae.brew.sh/formula/bitwarden-cli)
2018-05-23 22:45:11 +02:00
```bash
2018-05-28 14:56:25 +02:00
brew install bitwarden-cli
2018-05-23 22:45:11 +02:00
```
2018-05-25 22:16:14 +02:00
- [Snap](https://snapcraft.io/bw)
```bash
sudo snap install bw
```
2018-05-18 17:49:28 +02:00
2018-05-24 13:58:58 +02:00
## Documentation
2018-05-18 17:49:28 +02:00
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:
```bash
bw --help
```
This option will list all available commands that you can use with the CLI.
2018-05-18 18:13:49 +02:00
Additionally, you can run the `--help` option on a specific command to learn more about it:
2018-05-18 17:49:28 +02:00
```bash
bw list --help
bw create --help
```
2018-05-15 14:00:27 +02:00
2018-05-18 17:51:48 +02:00
**Detailed Documentation**
We provide detailed documentation and examples for using the CLI in our help center at https://help.bitwarden.com/article/cli/.
2018-05-24 13:58:58 +02:00
## Build/Run
2018-05-15 14:00:27 +02:00
**Requirements**
- [Node.js](https://nodejs.org) v16.13.1.
- Testing is done against Node 16, other versions may work, but are not guaranteed.
- NPM v8
2018-05-15 14:00:27 +02:00
**Run the app**
```bash
npm install
2019-03-21 13:29:28 +01:00
npm run sub:init # initialize the git submodule for jslib
2018-05-15 14:00:27 +02:00
npm run build:watch
```
You can then run commands from the `./build` folder:
```bash
node ./build/bw.js login
```