{"id":23469903,"url":"https://github.com/vapor-ware/synse-cli","last_synced_at":"2025-04-14T16:33:58.606Z","repository":{"id":26535169,"uuid":"55101688","full_name":"vapor-ware/synse-cli","owner":"vapor-ware","description":"Unified CLI for the Synse platform","archived":false,"fork":false,"pushed_at":"2023-10-04T04:55:08.000Z","size":2693,"stargazers_count":1,"open_issues_count":5,"forks_count":4,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-21T22:03:07.825Z","etag":null,"topics":["cli","command-line","synse","synse-cli","synse-server"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vapor-ware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-30T22:18:41.000Z","updated_at":"2021-12-13T17:40:33.000Z","dependencies_parsed_at":"2024-06-20T16:33:34.043Z","dependency_job_id":"21a5bd63-2588-4707-a99f-edfad06412e0","html_url":"https://github.com/vapor-ware/synse-cli","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vapor-ware%2Fsynse-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vapor-ware","download_url":"https://codeload.github.com/vapor-ware/synse-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248916711,"owners_count":21182852,"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":["cli","command-line","synse","synse-cli","synse-server"],"created_at":"2024-12-24T15:36:48.842Z","updated_at":"2025-04-14T16:33:58.582Z","avatar_url":"https://github.com/vapor-ware.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Synse CLI\n\n[![Build Status](https://github.com/vapor-ware/synse-cli/workflows/build/badge.svg)](https://github.com/vapor-ware/synse-cli/actions)\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-cli.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-cli?ref=badge_shield)\n[![Go ReportCard](https://goreportcard.com/badge/github.com/vapor-ware/synse-cli)](https://goreportcard.com/report/github.com/vapor-ware/synse-cli)\n\nA command-line interface for Vapor IO's [Synse platform](https://github.com/vapor-ware/synse).\n\n## Overview\n\nThe `synse` CLI provides a simple but comprehensive tool to interact with [Synse Server](https://github.com/vapor-ware/synse-server)\n(via its HTTP API) and Synse plugins (via the internal [gRPC API](https://github.com/vapor-ware/synse-server-grpc)).\nIt allows for real-time queries and interaction with devices exposed by Synse. This makes getting started\nwith Synse easy, and enabled rapid debugging and development against various Synse components.\n\n## Installing\n\n### Homebrew\n\nThe Synse CLI may be install via [Homebrew](https://brew.sh/). First, add the vapor-ware tap\n\n```\nbrew tap vapor-ware/formula\n```\n\nThen, you can install the CLI\n\n```\nbrew install vapor-ware/formula/synse\n```\n\n### Precompiled Binaries\n\nPrecompiled binaries are available as artifacts on GitHub [releases](https://github.com/vapor-ware/synse-cli/releases).\nTo download the binary and place it on your $PATH:\n\n```shell\n# Set variables for download\nexport CLI_VERSION=\"3.0.0\"\nexport CLI_OS=\"darwin\"\nexport CLI_ARCH=\"amd64\"\n\n# Download and install the CLI\nwget \\\n  https://github.com/vapor-ware/synse-cli/releases/download/${CLI_VERSION}/synse-cli_${CLI_VERSION}_${CLI_OS}_${CLI_ARCH}.tar.gz \\\n  -O /usr/local/bin/synse\n\n# Make the binary executable\nchmod +x /usr/local/bin/synse\n```\n\n### From Source\n\nIf you wish to build from source, you will first need to fork and clone the repo. From within the\nproject directory, you can build using the Makefile target:\n\n```\nmake build\n```\n\nWhich will create the `synse` binary in the project directory. If you wish, you can add it to\nyour PATH.\n\n## Getting Started\n\nWith the CLI installed, you can run `synse --help` to get usage info. You can get additional\ninfo on all commands and sub-commands by running the command with the `--help` flag.\n\nThere are three primary commands to be aware of:\n\n- `context`: Configuration management for server/plugin instances.\n- `server`: Interact with a Synse Server instance via HTTP.\n- `plugin`: Interact with a plugin instance via gRPC.\n\n### Contexts\n\nPrior to interacting with a server or plugin instance, a new context for it needs to be created.\nIf running the [example deployment](docker-compose.yaml) found in this repo (which runs Synse Server at\nlocalhost:5000 and the emulator plugin at localhost:5001), this can be done with:\n\n```bash\n# Add a server context and set it as the current server.\nsynse context add server local localhost:5000 --set\n\n# Add a plugin context and set it as the current plugin.\nsynse context add plugin emulator localhost:5001 --set\n```\n\nYou can then list the contexts and see that those are both present and marked as active.\nNow when you run a `synse server ...` or `synse plugin ...` command, it knows which instance\nto communicate with.\n\n```console\n$ synse context list\nCURRENT   NAME       TYPE     ADDRESS\n*         emulator   plugin   localhost:5001\n*         local      server   localhost:5000\n```\n\n## Compatibility\n\nBelow is a table describing the compatibility of Synse CLI versions with Synse platform versions.\n\n|          | Synse v2 | Synse v3 |\n| -------- | -------- | -------- |\n| CLI v1.x | ✗        | ✗        |\n| CLI v2.x | ✓        | ✗        |\n| CLI v3.x | ✗        | ✓        |\n\n## License\n\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-cli.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvapor-ware%2Fsynse-cli?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvapor-ware%2Fsynse-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvapor-ware%2Fsynse-cli/lists"}