Git Product home page Git Product logo

dishook's Introduction

Dishook

Build

Dishook is an efficient CLI Discord webhook executor written in Golang.

It helps save the user time - instead of downloading a programming language, installing the correct libraries, copying and pasting code, then trying to fix it, you could run this one simple trick command instead!

Automatic Installation

Windows

1. Open PowerShell with administrator privilages.

2. Run Get-ExecutionPolicy. If it returns Restricted, run Set-ExecutionPolicy AllSigned.

3.

iwr -useb https://raw.githubusercontent.com/juanpisuribe13/dishook/master/bin/install.ps1 | iex

macOS & Linux

curl -L -O https://raw.githubusercontent.com/juanpisuribe13/dishook/master/bin/install.sh; sudo chmod +x install.sh; sudo ./install.sh

Manual Installation

1. Go to the repository's latest release.

2. Download the executable. If you have a hard time telling which one is for your operating system, .exe is for Windows and the one without a file type is Linux.

3. Move the executable to your operating system's PATH.

Windows: Run set PATH and pick whichever folder you're comfortable putting it on.

Linux: /usr/bin

4. Done!

FAQ

Dishook is an invalid command, what do I do?

Check if dishook is already in your system's path. If it is, start a new terminal session and try again.

How do I use this?

Open your terminal of choice and type in dishook -h to get started.

There's a lot of names out there and you picked Dishook; there's a lot of projects with that name. Why?

Memory Muscle, and something like discord-webhook would look weird in terminal.

Contributing

If you see that the code's messy, something doesn't work, or I left something dumb there accidentally then feel free to send a pull request and I'll review it!

License

Apache License 2.0

dishook's People

Contributors

shmugoh avatar

Stargazers

avatar

Watchers

avatar

dishook's Issues

Implement execute code

Mirror of the root code, or maybe make it viceversa
Goal is to avoid confusion in the help section to improve UX.

Dishook v0.2.0

Known issues

  • Typo with -m flag in edit command
  • Dishook returns an error when no argument is detected; should return the commands list instead. (as said on #6)
  • #7
  • #8
  • #9

TODO

  • just clean up the garbage code lo.
  • Change versioning scheme.
  • Fix known issues.
  • Implement execute code (which is a mirror of the root code, or maybe make it viceversa), just to avoid confusion in the help section to improve UX. (#6)

Work on CLI flags

(Universal?) Flags:

  • --username | -u
  • --avatar-url | -pfp
  • --tts | -t
    --file | -f

Flags for command get:

  • - attachments
  • - author
  • - avatar-url
  • - bot
  • - id
  • - username
  • - channel-id
  • - content
  • - embeds
  • - id
  • - mention_everyone
  • - mention_roles
  • - mentions
  • - pinned
  • - tts
  • - webhook_id

Syntax Rewrite and GitHub Actions

  • Cleanup code
  • Test and see if there's any issues
  • Improve grammar on documentation
  • Compile it via GitHub Actions
  • Merge it with main branch

i love this program, but it's horribly documented, and its
codebase is so messy that it just makes me not want to work in it.
i've been already making some progress on the branch #syntax-rewrite,
and there might be a lot to come

i've been messing around with github actions lately and i think it might be a
perfect way to ship dishook, since i can easily compile dishook without having
to use any other external hypervisor

CLI Install Guide

Windows

Most painful one for the end-user to set up manually, but with a one line
command given in PowerShell, it could be installed in no-time (as long
as Windows Security doesn't mess this up).

The user could type in iwr -useb [SCRIPT_URL] | iex, which downloads
a raw PowerShell script from this repository where it then downloads
the latest dishook win32 binary, and adds a new folder to PATH with
the dishook binary on it.

Linux

Linux is the most easiest one so far, but there's a lot of package managers out there.
Of course, the user could do curl [LATEST_RELEASE_URL]| cp dishook /usr/bin/
but it would be preferrable to host it on repositories like the AUR.

macOS

I don't have macOS and will never install it, but I'll wait for someone to
test it out and document me on it.

(if I even manage to compile a binary of it via GitHub Actions anyway)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.