{"id":13506103,"url":"https://github.com/lets-fiware/ngsi-go","last_synced_at":"2026-01-20T17:56:02.917Z","repository":{"id":39668790,"uuid":"312743711","full_name":"lets-fiware/ngsi-go","owner":"lets-fiware","description":"The NGSI Go is a command-line interface supporting FIWARE Open APIs for FIWARE developers.","archived":false,"fork":false,"pushed_at":"2024-01-01T08:12:45.000Z","size":4836,"stargazers_count":15,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-02-15T13:31:44.728Z","etag":null,"topics":["fiware","fiware-ngsi","fiware-orion","ngsi","ngsi-ld"],"latest_commit_sha":null,"homepage":"https://ngsi-go.letsfiware.jp/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lets-fiware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"roadmap.md","authors":null}},"created_at":"2020-11-14T04:18:18.000Z","updated_at":"2023-09-12T06:32:50.000Z","dependencies_parsed_at":"2024-01-01T09:37:13.799Z","dependency_job_id":"75820996-bd76-4aaf-acaf-6b9b7e81154f","html_url":"https://github.com/lets-fiware/ngsi-go","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lets-fiware%2Fngsi-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lets-fiware%2Fngsi-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lets-fiware%2Fngsi-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lets-fiware%2Fngsi-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lets-fiware","download_url":"https://codeload.github.com/lets-fiware/ngsi-go/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273533,"owners_count":20750904,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fiware","fiware-ngsi","fiware-orion","ngsi","ngsi-ld"],"created_at":"2024-08-01T01:00:34.644Z","updated_at":"2026-01-20T17:56:02.684Z","avatar_url":"https://github.com/lets-fiware.png","language":"Go","funding_links":[],"categories":["ツール、ライブラリ等","Open-Source FIWARE from third parties"],"sub_categories":["Processing"],"readme":"[![Let's FIWARE Banner](https://raw.githubusercontent.com/lets-fiware/ngsi-go/gh-pages/img/ngsi-go-logo-non-free.png)](https://www.letsfiware.jp/)\n[![NGSI v2](https://img.shields.io/badge/NGSI-v2-5dc0cf.svg)](https://fiware-ges.github.io/orion/api/v2/stable/)\n[![NGSI LD](https://img.shields.io/badge/NGSI-LD-d6604d.svg)](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.05.01_60/gs_CIM009v010501p.pdf)\n\n![FIWARE: Tools](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/deployment-tools.svg)\n[![License: MIT](https://img.shields.io/github/license/lets-fiware/ngsi-go.svg)](https://opensource.org/licenses/MIT)\n![GitHub all releases](https://img.shields.io/github/downloads/lets-fiware/ngsi-go/total)\n[![Support badge](https://img.shields.io/badge/tag-fiware-orange.svg?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/fiware+ngsi-go)\n\u003cbr/\u003e\n![GitHub top language](https://img.shields.io/github/languages/top/lets-fiware/ngsi-go)\n![Lines of code](https://img.shields.io/tokei/lines/github/lets-fiware/ngsi-go)\n[![Lint](https://github.com/lets-fiware/ngsi-go/actions/workflows/lint.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/lint.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/lets-fiware/ngsi-go)](https://goreportcard.com/report/github.com/lets-fiware/ngsi-go)\n\u003cbr/\u003e\n[![Build](https://github.com/lets-fiware/ngsi-go/actions/workflows/build.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/build.yml)\n[![Unit Tests](https://github.com/lets-fiware/ngsi-go/actions/workflows/unit-test.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/unit-test.yml)\n[![Coverage Status](https://coveralls.io/repos/github/lets-fiware/ngsi-go/badge.svg?branch=main)](https://coveralls.io/github/lets-fiware/ngsi-go?branch=main)\n[![E2E tests](https://github.com/lets-fiware/ngsi-go/actions/workflows/e2e-test.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/e2e-test.yml)\n\u003cbr/\u003e\n[![Docs](https://github.com/lets-fiware/ngsi-go/actions/workflows/docs.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/docs.yml)\n[![Dockerfile](https://github.com/lets-fiware/ngsi-go/actions/workflows/dockerfile.yml/badge.svg)](https://github.com/lets-fiware/ngsi-go/actions/workflows/dockerfile.yml)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4973/badge)](https://bestpractices.coreinfrastructure.org/projects/4973)\n\nThe NGSI Go is a command-line interface supporting FIWARE Open APIs for FIWARE developers.\n\n| :books: [Documentation](https://ngsi-go.letsfiware.jp/) | :dart: [Roadmap](./roadmap.md) |\n|---------------------------------------------------------|--------------------------------|\n\n## Contents\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDetails\u003c/strong\u003e\u003c/summary\u003e\n\n-   [Getting Started with NGSI Go](#getting-started-with-ngsi-go)\n-   [Usage](#usage)\n-   [Tutorial](#tutorial)\n-   [Install](#install)\n-   [Third party packages](#third-party-packages)\n-   [Copyright and License](#copyright-and-license)\n\n\u003c/details\u003e\n\n# What is NGSI Go?\n\n\u003e \"Brave (hero), bearer of the blood of Erdrick, hero of legend! Know that your weapon will not\n\u003e serve to vanquish the Dragonload.\"\n\u003e\n\u003e — DRAGON WARRIOR (DRAGON QUEST)\n\nThe NGSI Go is a command-line interface supporting FIWARE Open APIs, which simplifies syntax.\nIt's a powerful tool and easy to use. It has various features as shown:\n\n-   Supported FIWARE Open APIs\n    -   FIWARE [NGSI v2](https://fiware-ges.github.io/orion/api/v2/stable/) API\n    -   [NGSI-LD](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.05.01_60/gs_CIM009v010501p.pdf) API\n    -   [STH-Comet](https://github.com/telefonicaid/fiware-sth-comet) API\n    -   [QuantumLeap](https://github.com/orchestracities/ngsi-timeseries-api) API\n    -   [Cygnus](https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-common/installation_and_administration_guide/management_interface_v1.md) API\n    -   [IoT Agent](https://github.com/telefonicaid/iotagent-node-lib/blob/master/doc/apiary/iotagent.apib) Provision API\n    -   [Perseo](https://github.com/telefonicaid/perseo-fe/blob/master/documentation/api.md) API\n    -   [Keyrock](https://github.com/ging/fiware-idm/blob/master/apiary.apib) API\n    -   [WireCloud](https://github.com/Wirecloud/wirecloud/blob/develop/docs/restapi/applicationmashup.apib) API\n-   Various convenience commands\n    -   NGSI commands to manage NGSI Entity, subscription, registration and so on\n    -   Time series commands to manage historical data\n    -   IoT Agent commands to manage IoT Agent Provision API\n    -   Rules commands to manage Context-Aware CEP\n    -   WireCloud command to manage Application Mashup RESTful API\n    -   Convenience commands\n        -   Print version, health-check status and API lists of FIWARE GEs\n        -   Admin command for FIWARE Orion\n        -   Copy and remove entities at once\n        -   Create template of subscription or registration\n        -   Notification receiver\n        -   Registration proxy\n    -   Management commands\n        -   Broker alias or server alias with API endpoint URL, FIWARE Service and FIWARE ServicePath\n        -   Manage @context\n        -   Integrated oauth token management\n-   Compatible with a number of traditional UNIX commands for filtering text\n-   A single binary program written in Golang\n\n## Getting Started with NGSI Go\n\nYou register an alias to access the broker.\n\n```console\nngsi broker add --host letsfiware --brokerHost http://localhost:1026 --ngsiType v2\n```\n\nYou can get the version by using the alias `letsfiware`.\n\n```console\nngsi version -h letsfiware\n```\n\n```json\n{\n\"orion\" : {\n  \"version\" : \"3.7.0\",\n  \"uptime\" : \"0 d, 0 h, 0 m, 1 s\",\n  \"git_hash\" : \"8b19705a8ec645ba1452cb97847a5615f0b2d3ca\",\n  \"compile_time\" : \"Thu May 26 11:45:49 UTC 2022\",\n  \"compiled_by\" : \"root\",\n  \"compiled_in\" : \"025d96e1419a\",\n  \"release_date\" : \"Thu May 26 11:45:49 UTC 2022\",\n  \"machine\" : \"x86_64\",\n  \"doc\" : \"https://fiware-orion.rtfd.io/en/3.7.0/\",\n  \"libversions\": {\n     \"boost\": \"1_74\",\n     \"libcurl\": \"libcurl/7.74.0 OpenSSL/1.1.1n zlib/1.2.11 brotli/1.0.9 libidn2/2.3.0 libpsl/0.21.0 (+libidn2/2.3.0) libssh2/1.9.0 nghttp2/1.43.0 librtmp/2.3\",\n     \"libmosquitto\": \"2.0.12\",\n     \"libmicrohttpd\": \"0.9.70\",\n     \"openssl\": \"1.1\",\n     \"rapidjson\": \"1.1.0\",\n     \"mongoc\": \"1.17.4\",\n     \"bson\": \"1.17.4\"\n  }\n}\n}\n```\n\nOnce you access the broker, you can omit to specify the broker.\n\n```console\nngsi version\n```\n\nIf you want to check the current settings, you can run the following command.\n\n```console\nngsi settings list\n```\n\n## Usage\n\n```text\nNAME:\n   ngsi - command-line tool for FIWARE Open APIs\n\nUSAGE:\n   ngsi [global options] command [options] [arguments...]\n\nVERSION:\n   ngsi version 0.13.0 (git_hash:8aeaca431eb3c46f160be043ab865f8c58b26389)\n\nCOMMANDS:\n   help, h  Shows a list of commands or help for one command\n   APPLICATION MASHUP:\n     preferences  manage preferences for WireCloud\n     macs         manage mashable application components for WireCloud\n     workspaces   manage workspaces for WireCloud\n     tabs         manage tabs for WireCloud\n   Context-Aware CEP:\n     rules  rules command for PERSEO\n   CONVENIENCE:\n     admin       admin command for FIWARE Orion, Cygnus, Perseo, Scorpio\n     apis        print endpoints of API\n     cp          copy entities\n     wc          print number of entities, subscriptions, registrations or types\n     man         print urls of document\n     health      print health status\n     ls          list entities\n     queryproxy  query proxy\n     rm          remove entities\n     receiver    notification receiver\n     regproxy    registration proxy\n     template    create template of subscription or registration\n     tokenproxy  token proxy\n     version     print the version\n   IoT Agent:\n     devices   manage devices for IoT Agent\n     services  manage services for IoT Agent\n   Keyrock:\n     applications   manage applications for Keyrock\n     users          manage users for Keyrock\n     organizations  manage organizations for Keyrock\n     providers      print service providers for Keyrock\n   NGSI:\n     append   append attributes\n     create   create entity(ies), subscription, registration or ldContext\n     delete   delete entity(ies), attribute, subscription, registration or ldContext\n     get      get entity(ies), attribute(s), subscription, registration type or ldContext\n     list     list types, attributes, entities, tentities, subscriptions or registrations\n     replace  replace entities or attributes\n     update   update entities, attribute(s) or subscription\n     upsert   upsert entity or entities\n   PERSISTING CONTEXT DATA:\n     namemappings   manage namemappings for Cygnus\n     groupingrules  manage groupingrules for Cygnus\n   TIME SERIES:\n     hdelete  delete historical raw and aggregated time series context information\n     hget     get historical raw and aggregated time series context information\n   MANAGEMENT:\n     broker    manage config for broker\n     context   manage @context\n     settings  manage settings\n     server    manage config for server\n     token     manage token\n     license   print OSS license information\n\nGLOBAL OPTIONS:\n   --syslog LEVEL        syslog logging LEVEL (off, err, info, debug)\n   --stderr LEVEL        stderr logging LEVEL (err, info, debug)\n   --configDir DIR       configuration DIR name\n   --config FILE         configuration FILE name\n   --cache FILE          cache FILE name\n   --batch, -B           don't use previous args (batch) (default: false)\n   --insecureSkipVerify  TLS/SSL skip certificate verification (default: false)\n   --help                show help (default: false)\n   --version, -v         print the version (default: false)\n\nPREVIOUS ARGS:\n   None\n```\n\n## Tutorial\n\nYou can try [the tutorial](docs/tutorial/index.md) to understand how to use the NGSI Go.\nYou need a environment running Docker engine and docker-compose.\n\n## Install\n\n### Install NGSI Go binary\n\nThe NGSI Go binary is installed in `/usr/local/bin`.\n\n#### Installation on Linux\n\n```console\ncurl -OL https://github.com/lets-fiware/ngsi-go/releases/download/v0.13.0/ngsi-v0.13.0-linux-amd64.tar.gz\nsudo tar zxvf ngsi-v0.13.0-linux-amd64.tar.gz -C /usr/local/bin\n```\n\n`ngsi-v0.13.0-linux-arm.tar.gz` and `ngsi-v0.13.0-linux-arm64.tar.gz` binaries are also available.\n\n#### Installation on Mac\n\n```console\ncurl -OL https://github.com/lets-fiware/ngsi-go/releases/download/v0.13.0/ngsi-v0.13.0-darwin-amd64.tar.gz\nsudo tar zxvf ngsi-v0.13.0-darwin-amd64.tar.gz -C /usr/local/bin\n```\n\n`ngsi-v0.13.0-darwin-arm64.tar.gz` binary is also available.\n\n### Install bash autocomplete file for NGSI Go\n\nInstall ngsi_bash_autocomplete file in `/etc/bash_completion.d`.\n\n```console\ncurl -OL https://raw.githubusercontent.com/lets-fiware/ngsi-go/main/autocomplete/ngsi_bash_autocomplete\nsudo mv ngsi_bash_autocomplete /etc/bash_completion.d/\nsource /etc/bash_completion.d/ngsi_bash_autocomplete\necho \"source /etc/bash_completion.d/ngsi_bash_autocomplete\" \u003e\u003e ~/.bashrc\n```\n\n## Third party packages\n\nThe NGSI Go makes no use of third-party packages.\n\n-   [Open Source Insights](https://deps.dev/go/github.com%2Flets-fiware%2Fngsi-go)\n\n## Copyright and License\n\nCopyright (c) 2020-2024 Kazuhito Suda\u003cbr\u003e\nLicensed under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flets-fiware%2Fngsi-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flets-fiware%2Fngsi-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flets-fiware%2Fngsi-go/lists"}