https://github.com/thin-edge/c8y-command-plugin
Community thin-edge.io plugin for the Cumulocity IoT command/shell operation 💻
https://github.com/thin-edge/c8y-command-plugin
c8y command community plugin thin-edge
Last synced: 2 months ago
JSON representation
Community thin-edge.io plugin for the Cumulocity IoT command/shell operation 💻
- Host: GitHub
- URL: https://github.com/thin-edge/c8y-command-plugin
- Owner: thin-edge
- License: mit
- Created: 2023-02-20T16:11:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T08:52:24.000Z (10 months ago)
- Last Synced: 2025-10-12T06:15:28.652Z (3 months ago)
- Topics: c8y, command, community, plugin, thin-edge
- Language: Shell
- Homepage:
- Size: 37.1 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# c8y-command-plugin
thin-edge.io Cumulocity IoT shell plugin to process the `c8y_Command` operation.
## Plugin summary
### What will be deployed to the device?
* Cumulocity IoT command handler that allows users to execute a command in a shell
**Technical summary**
The following details the technical aspects of the plugin to get an idea what systems it supports.
|||
|--|--|
|**Languages**|`shell` (posix compatible)|
|**CPU Architectures**|`all/noarch`. Not CPU specific|
|**Supported init systems**|`N/A`|
|**Required Dependencies**|-|
|**Optional Dependencies (feature specific)**|-|
### How to do I get it?
The following linux package formats are provided on the releases page and also in the [tedge-community](https://cloudsmith.io/~thinedge/repos/community/packages/) repository:
**c8y-command-plugin**
**Warning:** This version is compatible with thin-edge.io > 1.0.0, but is now deprecated. Please upgrade to thin-edge.io >= 1.4.0 and use the new tedge-command-plugin instead.
|Operating System|Repository link|
|--|--|
|Debian/Raspian (deb)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/deb/c8y-command-plugin/latest/a=all;d=any-distro%252Fany-version;t=binary/)|
|Alpine Linux (apk)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/alpine/c8y-command-plugin/latest/a=noarch;d=alpine%252Fany-version/)|
|RHEL/CentOS/Fedora (rpm)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/rpm/c8y-command-plugin/latest/a=noarch;d=any-distro%252Fany-version;t=binary/)|
**tedge-command-plugin**
**Warning:** This version is only compatible with thin-edge.io >= 1.4.0.
|Operating System|Repository link|
|--|--|
|Debian/Raspian (deb)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/deb/tedge-command-plugin/latest/a=all;d=any-distro%252Fany-version;t=binary/)|
|Alpine Linux (apk)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/alpine/tedge-command-plugin/latest/a=noarch;d=alpine%252Fany-version/)|
|RHEL/CentOS/Fedora (rpm)|[](https://cloudsmith.io/~thinedge/repos/community/packages/detail/rpm/tedge-command-plugin/latest/a=noarch;d=any-distro%252Fany-version;t=binary/)|
#### Configuration
The Cumulocity IoT shell plugin can be configured with the following properties.
|Property|Value|Description|
|--|--|--|
|`SHELL_BIN`|`string`|Default shell to be used to execute the received command. If left blank, then the shell will be auto-detected. If a non-empty value is used. If the shell does not exist, then an error will be raised. The shell will be used using ` -c ""`.|
|`SHELL_OPTIONS`|Whitespace separated list|List of shells to check if they exist. The plugin will use the first detected shell|
The configuration is managed from the following file, and an example of the contents are shown below.
**File**
```sh
/etc/tedge-command-plugin/env
```
**Contents**
```sh
SHELL_BIN=""
SHELL_OPTIONS="bash zsh ash dash sh /my/custom/shell/interpreter"
```