PIGEONSH by PIGEONPOSSE™
⚠️ Beta version. It can be installed and used but things may change in the future.
🗒 Description
Centralize your server scripts in a single folder and run them using the psh or pigeonsh command.
Can be used with .sh, .zsh, .js, and .py files.
Index
🔑 Installation
⚡️ Using NPM
npm install -g @pigeon-posse/pigeonsh☢️ With a executable
View details
⚠️ Not recommended. If you install it this way, the executable will be heavier.
Supported on Linux, MacOs and Windows.
Fast mode
macos:
git clone https://github.com/pigeon-posse/pigeonsh.git pigeonsh && cp pigeonsh/dist/pigeonsh-macos /usr/local/bin/psh && psh hello
linux:
git clone https://github.com/pigeon-posse/pigeonsh.git pigeonsh && cp pigeonsh/dist/pigeonsh-linux /usr/local/bin/psh && psh hello
Windows (no tested):
git clone https://github.com/pigeon-posse/pigeonsh.git pigeonsh && copy pigeonsh/dist/pigeonsh-win.exe C: \Program Files (x86)\Git \us\ local bin\psh && psh hello✅ Success installation
If the installation has been executed correctly you should see at the end of your line a:
Hello Pigeon 🐦🌈
Manual mode
- Clone the repository and go to the dist folder.
- Copy the executable corresponding to your operating system in your
binfolder.
⚙️ Usage
Write scripts
You can write your scripts in your ~/.scriptsrc folder. The structure for the script to work must be:
- ~/.scriptsrc
- 📂 [script-name]
- 📄 main.[sh, zsh, js, py]
- 📜 info.[yml, yaml, json] # not requiredView details.
[script-name]:The name of the folder will be the name that you execute from the
psh command.
Folder name must not contain spaces.
main.[sh, js, py]:The main file is the file that will be executed, here you will write your code. It could be
.sh, .js, .py. main.sh example:#!/bin/sh
echo "Hello Pigeon 🐦🌈"info.[yml, yaml, json]:Not required. In this file you will add the information of your scripts. info.yml example:
description: Print hello message.
version: 1.0.0Execute scripts
🚀 psh list
Running this command lists all the scripts saved in your ~/.scriptsrc folder.
Example
Run:
psh listReturns list of scripts like:
hello
aliasrc
hosts 🚀 psh [script-name] or psh exec [script-name]
Running this command will run the scripts with the same name if they exist.
Example
Run:
psh helloor
psh exec helloReturns hello script:
Hello Pigeon 🐦🌈🚀 psh info [script-name]
Running this command will display info of script.
Example
Run:
psh info helloReturns hello script info:
{
"description": "Print hello message",
"version": "1.0.0"
}👨💻 Development
You can contribute via Github.
☕ Donate
Help us to develop more interesting things.
📜 License
This software is licensed with GPLv3 (GNU GENERAL PUBLIC LICENSE Version 3).
🐦 About us
PigeonPosse is a
Collaborators
| Name | Role | GitHub | |
|---|---|---|---|
 |
AngelEspejo | Author | @AngelEspejo |
 |
Irfaelo | Windows compatibility | @irfaelo |
 |
PigeonPosse | Collective | @PigeonPosse |