Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

@pigeon-posse/pigeonsh

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@pigeon-posse/pigeonsh

Centralize your server scripts in a single folder and run them using a command


Version published
Weekly downloads
0
decreased by-100%
Maintainers
2
Weekly downloads
 
Created

PIGEONSH by PIGEONPOSSE™

License Version Web About us Donate

:warning: 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
  1. Installation
  2. Usage
  3. Development
  4. Donate
  5. License
  6. About us

🔑 Installation

⚡️ Using NPM

npm install -g @pigeon-posse/pigeonsh

☢️ With a executable

View details

:warning: 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
✅ Success installation

If the installation has been executed correctly you should see at the end of your line a:

Hello Pigeon 🐦🌈

Manual mode
  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, zsh, js, py]
		- 📜 info.[yml, yaml, json] # not required
View 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.0
    

  • Execute scripts

    🚀 psh list

    Running this command lists all the scripts saved in your ${user}/.scriptsrc folder.

    Example

    Run:

    psh list
    

    Returns 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 hello
    

    or

    psh exec hello
    

    Returns hello script:

    Hello Pigeon 🐦🌈
    
    🚀 psh info [script-name]

    Running this command will display info of script.

    Example

    Run:

    psh info hello
    

    Returns hello script info:

    {
    	"description": "Print hello message",
    	"version": "1.0.0"
    }
    

    👨‍💻 Development

    You can contribute via Github.

    Issues Pull requests

    ☕ Donate

    Help us to develop more interesting things.

    Donate

    📜 License

    This sofware is licensed with GPLv3 (GNU GENERAL PUBLIC LICENSE Version 3).

    Read more

    🐦 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.

    More

    Collaborators

    NameRoleGitHub
    AngelEspejoAuthor@AngelEspejo
    PigeonPosseCollective@PigeonPosse

    FAQs

    Package last updated on 11 Jan 2023

    Did you know?

    Socket

    Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

    Install

    Related posts