https://github.com/s-a/discord-shell-slave

:globe_with_meridians: A discord shell client which posts piped shell data to specified guild and channel
https://github.com/s-a/discord-shell-slave

Last synced: about 5 hours ago
JSON representation

:globe_with_meridians: A discord shell client which posts piped shell data to specified guild and channel

• Host: GitHub
• URL: https://github.com/s-a/discord-shell-slave
• Owner: s-a
• License: other
• Created: 2016-12-14T17:46:40.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2016-12-15T20:53:31.000Z (almost 8 years ago)
• Last Synced: 2024-10-31T17:35:22.596Z (17 days ago)
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# discord-shell-slave

![alt tag](ericlemerdy-Callout-chat-300px.png)

**Why?**  

*I' d like to allow a shell process to send Discord chat  messages.*

**How?**  

*You just need to pipe text input into ```discord-shell-slave```.*

**discord-shell-slave... Isn' t it a little bit long?**  

*Yes it is. There exists an alias called ```dss```.*

**I' d like to know more. What is it good for?**  

*In fact any shell script can send a Discord chat message now. So you do not need any coder skills to use it. If you have coding skills [QWMI](https://github.com/s-a/qwmi) is an excelent usecase and a good example which supports the enhanced JSON structure.*

**JSON structure?**  

*```dss``` will parse piped string data into a  JSON object if it is a valid JSON string. If not it will take the string and send a simple text message. If it is JSON ```dss``` expects the following structure.*

```javascript

{

  color : "0x3498db",

  title : "test",

  author : {name : "discord-shell-slave"},

  fields : [{name:"Message", value: "Hello"}]

}

```

**How to install it on my machine?**

```bash

npm i -g discord-shell-slave

```

**No configuration?**  

*For shure you need one. You need to create a file called ```.discord-shell-slave-rc``` in the current working directory of your shell or in one of its parent directories.*

```javascript

{

    "my-connection-name" : {

        "channel" : "General",

        "token" : "M*U4N*MwO****4NDg0M*I0.CzMGvA****iGcZW******"

    }

}

```

**How to use it?**

```bash

echo hello world | discord-shell-slave --connect my-connection-name

```

*If you want to pass the the configuration file as parameter you can use ```--config``` with an absolute or relative path to the current working directory.*

```bash

echo hello world | discord-shell-slave --connect my-connection-name --config /path/to/my/.discord-shell-slave-rc

```

[for more details see  COMMANDLINE-ARGUMENTS.md](/COMMANDLINE-ARGUMENTS.md)

**How is this software licensed?**

*[MIT](/LICENSE)*