From cc07ef81e69bb4104534558b7796d1af0128afd7 Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Fri, 18 May 2018 11:49:28 -0400 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b8588642de..5dc11d4898 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,40 @@ -The Bitwarden CLI is written with TypeScript and Node.js. The CLI can be run on Windows, macOS, and Linux distributions. +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. # Download/Install -You can install the CLI two different ways: +You can install the Bitwarden CLI multiple 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. +**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** + +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://bitwarden.com/#download) on our website. + +# Documentation + +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. + +Additionally, you can run the `--help` option on a specific command to learn more about it specifically. For example: + +```bash +bw list --help +bw create --help +``` # Build/Run @@ -27,6 +50,7 @@ You can install the CLI two different ways: **Run the app** ```bash +npm run sub:init npm install npm run build:watch ```