{"id":19632959,"url":"https://github.com/sitewhere/swctl","last_synced_at":"2025-04-28T07:30:42.517Z","repository":{"id":51681252,"uuid":"271622662","full_name":"sitewhere/swctl","owner":"sitewhere","description":"SiteWhere Control CLI","archived":false,"fork":false,"pushed_at":"2021-03-29T12:21:55.000Z","size":3805,"stargazers_count":7,"open_issues_count":2,"forks_count":8,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-05T07:33:01.329Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sitewhere.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-11T18:44:58.000Z","updated_at":"2023-08-03T09:51:56.000Z","dependencies_parsed_at":"2022-08-22T21:20:53.531Z","dependency_job_id":null,"html_url":"https://github.com/sitewhere/swctl","commit_stats":null,"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fswctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fswctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fswctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sitewhere%2Fswctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sitewhere","download_url":"https://codeload.github.com/sitewhere/swctl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251271082,"owners_count":21562487,"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":[],"created_at":"2024-11-11T12:15:51.130Z","updated_at":"2025-04-28T07:30:40.211Z","avatar_url":"https://github.com/sitewhere.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/sitewhere/swctl.svg?branch=master)](https://travis-ci.org/sitewhere/swctl) [![Go Report Card](https://goreportcard.com/badge/github.com/sitewhere/swctl)](https://goreportcard.com/report/github.com/sitewhere/swctl) [![GoDoc](https://godoc.org/github.com/sitewhere/swctl?status.svg)](https://godoc.org/github.com/sitewhere/swctl) [![codecov](https://codecov.io/gh/sitewhere/swctl/branch/master/graph/badge.svg)](https://codecov.io/gh/sitewhere/swctl)\n\n![SiteWhere](https://s3.amazonaws.com/sitewhere-branding/SiteWhereLogo.svg)\n\n---\n\n# SiteWhere Control CLI\n\n## Build\n\nFor building it requires go 1.14+.\n\n```console\nmake build\n```\n\n## Install swctl\n\n### From source code\n\n```console\nmake install\n```\n\n### Install binary with curl on Linux\n\n```bash\ncurl -L https://github.com/sitewhere/swctl/releases/latest/download/swctl.linux.amd64 -o swctl \u0026\u0026 \\\nchmod +x ./swctl \u0026\u0026 sudo mv ./swctl /usr/local/bin/swctl\n```\n\n### Install binary with curl on macOS\n\n```bash\ncurl -L https://github.com/sitewhere/swctl/releases/latest/download/swctl.darwin.amd64 -o swctl \u0026\u0026 \\\nchmod +x ./swctl \u0026\u0026 sudo mv ./swctl /usr/local/bin/swctl\n```\n\n### Install binary with curl on Windows\n\n```bash\ncurl -L https://github.com/sitewhere/swctl/releases/latest/download/swctl.windows.amd64.exe -o swctl.exe\n```\n\n## Usage\n\n### Prerequistes\n\n- [Istio](https://istio.io) 1.8+ Installed in your cluster. Check Istio setup [documentation](https://istio.io/latest/docs/setup/).\n\nIf run into docker pull image request limit, use the following command\n\n```command\nistioctl install -y --set hub=gcr.io/istio-release\n```\n\n### Install SiteWhere\n\nTo install SiteWhere 3.0 on your Kubernetes cluster, run the following command.\n\n```console\nswctl install\n```\n\nThis comamnd will do the following for you:\n\n- Install SiteWhere Custom Resource Definitions.\n- Install SiteWhere Templates.\n- Install SiteWhere Operator.\n- Install SiteWhere Infrastructure.\n\n![](demo.gif)\n\n### Listing SiteWhere Instances\n\n```console\nswctl instances\n```\n\n### Showing the details of a Intance\n\nIf you'd like to show the details `sitewhere` instance, execute this command:\n\n```console\nswctl instances sitewhere\n```\n\nThe result should be something like this:\n\n```bash\nInstance Name                      : sitewhere\nInstance Namespace                 : sitewhere\nConfiguration Template             : default\nDataset Template                   : default\nTenant Management Status           : Bootstrapped\nUser Management Status             : Bootstrapped\nConfiguration:\n  Infrastructure:\n    Namespace                      : sitewhere-system\n    gRPC:\n      Backoff Multiplier           : 1.50\n      Initial Backoff (sec)        : 10\n      Max Backoff (sec)            : 600\n      Max Retry                    : 6\n      Resolve FQDN                 : false\n    Kafka:\n      Hostname                     : sitewhere-kafka-kafka-bootstrap\n      Port                         : 9092\n      Def Topic Partitions         : 8\n      Def Topic Replication Factor : 3\n    Metrics:\n      Enabled                      : true\n      HTTP Port                    : 9090\n    Redis:\n      Hostname                     : sitewhere-infrastructure-redis-ha-announce\n      Port                         : 26379\n      Node Count                   : 3\n      Master Group Name            : sitewhere\n  Persistence:\n    Cassandra:\n    InfluxDB:\n    RDB:\n  Microservices:\n      asset-management             : Ready\n      batch-operations             : Ready\n      command-delivery             : Ready\n      device-management            : Ready\n      device-registration          : Ready\n      device-state                 : Ready\n      event-management             : Ready\n      event-sources                : Ready\n      inbound-processing           : Ready\n      instance-management          : Ready\n      label-generation             : Ready\n      outbound-connectors          : Ready\n      schedule-management          : Ready\n```\n\n### Creating a SiteWhere Instance\n\n```console\nswctl create instance sitewhere\n```\n\n### Deleting a SiteWhere Instance\n\n```console\nswctl delete instance sitewhere\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitewhere%2Fswctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsitewhere%2Fswctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsitewhere%2Fswctl/lists"}