guild

Crates.ioguild
lib.rsguild
version0.2.1
sourcesrc
created_at2021-01-03 02:03:34.717027
updated_at2021-03-02 16:11:55.789869
descriptionGuild is a Command Line Interface build with Rust that posts code snippets to a Discord channel using Webhooks.
homepagehttps://github.com/jakecorrenti/guild
repositoryhttps://github.com/jakecorrenti/guild
max_upload_size
id330828
size49,062
Jake Correnti (jakecorrenti)

documentation

README

guild

Guild is a Command Line Utility that allows you to post code snippets from a file to a Discord channel.

How does it work?

By utilizing Serentiy to access the Discord API, guild communicates with your Discord server using Webhooks. This allows guild to post a message to Discord on its own without having to type anything into Discord itself.

Download

Install Rust

In order to download guild, you need to have Rust downloaded on your computer if you don't already. To install Rust, go to the Rust website and follow the instructions.

Install guild

Once Rust is installed on your machine, you must install guild through Cargo:

cargo install guild

Usage

  1. Create a Discord Webhook in the desired server
  2. Copy the Discord Webhook URL and execute the following command in your terminal
    guild set <webhook url>
    
  3. Post your desired code snippet to the Discord server:
    guild post <file path> <starting line> <ending line>
    
    • If you would like the code snippet to have syntax highlighting, add the following flag at the end of your command:
      guild post <file path> <starting line> <ending line> -H
      
      or
      guild post <file path> <starting line> <ending line> --highlight
      
    • Example:
      guild post main.c 1 5 -H
      

Commands

  • set: Set the Discord Webhook URL
  • post: Post a code snippet to the set Discord channel

Flags

  • help: See the possible commands and flags that are supported by guild
  • highlight: Enable syntax highlighting for the code snippet
Commit count: 65

cargo fmt