ngsi-go

README

The NGSI Go is a Unix command-line tool for FIWARE NGSI v2 and NGSI-LD.

Contents

Details

• Getting Started with NGSI Go
• Usage
• Install
• Documentation
• Third party packages
• Copyright and License

What is NGSI Go?

The NGSI Go is a UNIX command-line tool FIWARE supporting both NGSI v2 and NGSI-LD, which simplifies syntax.

"Brave (hero), bearer of the blood of Erdrick, hero of legend! Know that your weapon will not serve to vanquish the Dragonload."

— DRAGON WARRIOR (DRAGON QUEST)

Getting Started with NGSI Go

You can get the version of your context broker instance as shown:

ngsi version -h localhost:1026

{
 "orion" : {
   "version" : "2.5.0",
   "uptime" : "0 d, 5 h, 7 m, 50 s",
   "git_hash" : "63cc107657ae10aa03f1c83bdea0be869d8e26a1",
   "compile_time" : "Fri Oct 30 09:02:37 UTC 2020",
   "compiled_by" : "root",
   "compiled_in" : "320890801dd4",
   "release_date" : "Fri Oct 30 09:02:37 UTC 2020",
   "doc" : "https://fiware-orion.rtfd.io/en/2.5.0/",
   "libversions": {
      "boost": "1_53",
      "libcurl": "libcurl/7.29.0 NSS/3.44 zlib/1.2.7 libidn/1.28 libssh2/1.8.0",
      "libmicrohttpd": "0.9.70",
      "openssl": "1.0.2k",
      "rapidjson": "1.1.0",
      "mongodriver": "legacy-1.1.2"
   }
 }
}

You can register an alias to access the broker.

ngsi broker add --host letsfiware --brokerHost http://localhost:1026 --ngsiType v2

You can get the version by using the alias letsfiware.

ngsi version -h letsfiware

{
 "orion" : {
   "version" : "2.5.0",
   "uptime" : "0 d, 5 h, 7 m, 50 s",
   "git_hash" : "63cc107657ae10aa03f1c83bdea0be869d8e26a1",
   "compile_time" : "Fri Oct 30 09:02:37 UTC 2020",
   "compiled_by" : "root",
   "compiled_in" : "320890801dd4",
   "release_date" : "Fri Oct 30 09:02:37 UTC 2020",
   "doc" : "https://fiware-orion.rtfd.io/en/2.5.0/",
   "libversions": {
      "boost": "1_53",
      "libcurl": "libcurl/7.29.0 NSS/3.44 zlib/1.2.7 libidn/1.28 libssh2/1.8.0",
      "libmicrohttpd": "0.9.70",
      "openssl": "1.0.2k",
      "rapidjson": "1.1.0",
      "mongodriver": "legacy-1.1.2"
   }
 }
}

Once you access the broker, you can omit to specify the broker.

ngsi version

If you want to check the current settings, you can run the following command.

ngsi settings list

Usage

NAME:
   ngsi - unix-like command-line tool for FIWARE NGSI and NGSI-LD

USAGE:
   ngsi [global options] command [command options] [arguments...]

VERSION:
   0.1.0 (git_hash:8d4efe4c08597ff65706dfa0f03acee2a3c8b1d2)

COMMANDS:
   help, h  Shows a list of commands or help for one command
   CONVENIENCE:
     cp        copy entities
     wc        print number of entities, subscriptions, registrations, or types
     man       print urls of document
     ls        list entities
     rm        remove entities
     template  create template of subscription or registration
     version   print the version of Context Broker
   MANAGEMENT:
     broker    manage config for broker
     context   manage @context
     settings  manage settings
     token     manage token
   NGSI:
     append   append attributes
     create   create entity(ies), subscription or registration
     delete   delete entity(ies), attribute, subscription, or registration
     get      get entity(ies), attribute(s), subscription, registration, or type
     list     list types, entities, subscriptions, or registrations
     replace  replace entities or attributes
     update   update entities, attribute(s), or subscription
     upsert   upsert entities

GLOBAL OPTIONS:
   --syslog LEVEL  specify logging LEVEL (off, err, info, debug)
   --stderr LEVEL  specify logging LEVEL (off, err, info, debug)
   --config FILE   specify configuration FILE
   --cache FILE    specify cache FILE
   --batch, -B     don't use previous args (batch) (default: false)
   --help          show help (default: false)
   --version, -v   print the version (default: false)

COPYRIGHT:
   (c) 2020 Kazuhito Suda

Install

Install NGSI Go binary

The NGSI Go binary is installed in /usr/local/bin.

Installation on UNIX

curl -OL https://github.com/lets-fiware/ngsi-go/releases/download/v0.1.0/ngsi-v0.1.0-linux-amd64.tar.gz
sudo tar zxvf ngsi-v0.1.0-linux-amd64.tar.gz -C /usr/local/bin

ngsi-v0.1.0-linux-arm.tar.gz and ngsi-v0.1.0-linux-arm64.tar.gz binaries are also available.

Installation on Mac

curl -OL https://github.com/lets-fiware/ngsi-go/releases/download/v0.1.0/ngsi-v0.1.0-darwin-amd64.tar.gz
sudo tar zxvf ngsi-v0.1.0-darwin-amd64.tar.gz -C /usr/local/bin

Install bash autocomplete file for NGSI Go

Install ngsi_bash_autocomplete file in /etc/bash_completion.d.

curl -OL https://raw.githubusercontent.com/lets-fiware/ngsi-go/main/autocomplete/ngsi_bash_autocomplete
sudo mv ngsi_bash_autocomplete /etc/bash_completion.d/
source /etc/bash_completion.d/ngsi_bash_autocomplete
echo "source /etc/bash_completion.d/ngsi_bash_autocomplete" >> ~/.bashrc

Documentation

• NGSI Go documentation

Third party packages

The NGSI Go makes use of the following package:

Package	OSS License
urfave/cli	MIT License

The dependencies of dependencies have been omitted from the list.

Copyright and License

Copyright (c) 2020 Kazuhito Suda
Licensed under the MIT license.