baruwactl

command module
v0.0.0-...-9543e55 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2020 License: MPL-2.0 Imports: 2 Imported by: 0

README

baruwactl

A command line tool for the Baruwa REST API

Build Status Ci codecov Go Report Card GoDoc MPLv2 License

This tool provides commandline access to manage a Baruwa server via the REST API.

It is built using the Baruwa Golang bindings.

Usage: baruwactl -k -s COMMAND [arg...]

A cmdline client for the Baruwa REST API.
                     
Options:             
  -k, --api-token    Baruwa API OAUTH Token (env $BARUWA_API_TOKEN)
  -s, --server-url   Baruwa server url (env $BARUWA_API_SERVER)
                     
Commands:            
  user               manage user accounts
  users              list user accounts
  domain             manage domains
  domains            list domains
  organization       manage organizations
  organizations      list organizations
  systemstatus       show system status
                     
Run 'baruwactl COMMAND --help' for more information on a command.

Installation

Binary

Precompiled binaries are available for download on the releases page

Source

To install from source

$ go get github.com/baruwa-enterprise/baruwactl

Requirements

  • Golang 1.10.x or higher

Testing

make test

Contributing

  1. Fork it (https://github.com/baruwa-enterprise/baruwactl/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

All code is licensed under the MPLv2 License.

Documentation

Overview

Package main cmdline client for the Baruwa REST API

Directories

Path Synopsis
Package cmd cmdline client for the Baruwa REST API
Package cmd cmdline client for the Baruwa REST API

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL