go-c8y-cli

README

go-c8y-cli

Unofficial Cumulocity REST Command Line Interface for both PowerShell and *nix (standalone binary).

Compatible with

• Linux (amd64)
• MacOS (amd64)
• Windows (amd64)

Installation

PowerShell Module (PSc8y)

Install-Module PSc8y -AllowClobber -Scope CurrentUser
Import-Module PSc8y

Note

Please consult the docs if you are having trouble installing it.

• bash
• PowerShell

Documentation

See the documenation website for instructions on how to install and use it.

Contributing

1. Fork the project, then clone it

   git clone https://github.com/reubenmiller/go-c8y-cli.git
   

2. Open the project in Microsoft VS Code (using Dev Containers - this requires Docker!)

3. Edit a .yml specification in api/spec/yaml/

4. Build the project using

   make build
   

5. Try out the newly built module

   PowerShell

   Import-Module ./tools/PSc8y/dist/PSc8y -Force
   

   Bash

   chmod +x ./output/c8y.*
   
   ./output/c8y.linux
   

Building documentation

1. Build the go and powershell code

   make build
   

2. Build the powershell markdown documentation

   make docs-powershell
   

3. Start a webserver to preview the documentation locally

   make gh_pages
   

4. View the documentation in the brower