@pigeon-posse/pigeonsh

PIGEONSH by PIGEONPOSSE™

:warning: This package is still in 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, .js, and .py files

🔑 Installation

⚡️ Using NPM

npm install -g @pigeon-posse/pigeonsh

☢️ With the executable (not recommended)

1. Clone the repository and go to the dist folder.
2. Copy the executable corresponding to your operating system in your bin folder

⚙️ Usage

Write scripts

You can write your scripts in your ${USER}/.scriptsrc folder. The structure for the script to work must be:

- ${USER}/.scriptsrc
	- 📂 [script-name] 
		- 📝 main.[sh, js, py]
		- 📜 info.[yml, yaml, json] # not required

ℹ️ Explanation

[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:

```bash
#!/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:

```yaml
description: Print hello message.
version: 1.0.0
```

Execute scripts

psh list

Running this command lists all the scripts saved in your ${user}/.scriptsrc folder. For example in a clean installation, show the default scripts:

$ psh list

# return the default scripts
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. For example, if we want to execute the default script hello:

$ psh hello
# or
$ psh exec hello

# return the hello script
Hello Pigeon 🐦🌈

psh info [script-name]

Running this command will display info of script.

$ psh info hello

# return the 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 sofware is licensed with GPLv3 (GNU GENERAL PUBLIC LICENSE Version 3)

🐦 About us

PigeonPosse is a ✨ code development collective ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

Collaborators

	Name	Role	GitHub
	AngelEspejo	Author	@AngelEspejo
	PigeonPosse	Collective	@PigeonPosse