From e9034ea6fe06331200d68c96b3c950591979c40f Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Wed, 20 Mar 2019 16:43:48 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index cd60bd35..6da5577d 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,31 @@ The application is written using Electron with Angular and installs on Windows, ![Directory Connector](https://raw.githubusercontent.com/bitwarden/brand/master/screenshots/directory-connector-macos.png "Dashboard") +## Command-line Interface + +A command-line interface tool is also available for the Bitwarden Directory Connector. The Directory Connector CLI (`bwdc`) is written with TypeScript and Node.js and can also be run on Windows, macOS, and Linux distributions. + +## CLI Documentation + +The Bitwarden Directory Connector 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 +bwdc --help +``` + +This option will list all available commands that you can use with the Directory Connector CLI. + +Additionally, you can run the `--help` option on a specific command to learn more about it: + +``` +bwdc test --help +bwdc config --help +``` + +**Detailed Documentation** + +We provide detailed documentation and examples for using the Directory Connector CLI in our help center at https://help.bitwarden.com/article/directory-sync/#command-line-interface. + # Build/Run **Requirements** From 1e698ba81bb7c0fdd82848be19955686fa9db8ca Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Wed, 20 Mar 2019 16:44:41 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6da5577d..1f6ad325 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ bwdc config --help We provide detailed documentation and examples for using the Directory Connector CLI in our help center at https://help.bitwarden.com/article/directory-sync/#command-line-interface. -# Build/Run +## Build/Run **Requirements** @@ -73,7 +73,7 @@ You can then run commands from the `./build-cli` folder: node ./build-cli/bwdc.js --help ``` -# Contribute +## 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.