Skip to content
Bureau Works API Command Line Interface and NodeJS module
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
README.md Added My Account URL to specificy where to get an API KEY Sep 21, 2018
cli.js Reformatted to spaces instead of tabs; added an option to provide lan… Feb 23, 2019
config.json
index.js Fix typo in bwx config Mar 5, 2019
package-lock.json
package.json

README.md

Bureau Works API Command Line Interface and NodeJS module

This repository contains a JavaScript library that can be used to access the Bureau Works API. It also includes a CLI written in NodeJS that facilitates API calls from the command line.

Requirements

You need a Bureau Works account and API KEY. Please visit https://www.bureauworks.com to get yours!

You will also need NodeJS and git installed in your environment.

For API reference, please visit https://dev.bureau.works

Installation

Clone this repository:

$ git clone https://github.com/bureauworks/cli.git

Install dependencies

$ npm i

Make the CLI friends with your shell environment

$ chmod +x cli.js

Run the Configuration once - this will create a config.json file in your ~/.bwx/ directory. You can get an API KEY at https://bureau.works/#/my/account once you log in the system.

$ ./cli.js config

You should see a message confirming the file creation now test the API with the CLI!

$ ./cli.js services

$ ./cli.js languages

You can use npm link to allow us to locally ‘symlink a package folder’. If you do so, you can call the CLI anywhere in your system with the bwx shorthand:

$ bwx timezones

$ bwx languages

For the help, use:

$ bwx --help

Or for specific commands, for example, the project creation command:

$ bwx create --help

You can’t perform that action at this time.