项目作者: jeremieca

项目描述 :
Pulsion centralize all commands of your project in one unique place with no pain.
高级语言: Shell
项目地址: git://github.com/jeremieca/pulsion.git
创建时间: 2016-06-21T21:22:37Z
项目社区:https://github.com/jeremieca/pulsion

开源协议:

下载


Pulsion project

Codeship Status for jeremieca/pulsion

Description

Pulsion centralize all commands of your project in one unique place with no pain.

You can easily create aliases for all your terminal commands and create your own command line tool in few minutes.
Just use our high level bash tool to manage your commands.

When your project is configured, you can from a unique place :

  • Start your database
  • Install dependencies
  • Compile your code
  • Deploy your project
  • And all other things you want to do

Pulsion is initially a tool for developper or sysadmin in a development environment.

Why to use it ?

  • Reduce barriers to entry on project : To manage all the project, developpers have just one command to use regardless of your stack : pulsion (instead of grunt, gulp, mongod, mvn, npm, bower…)
  • Write complex bash cli easily and very fast : bash is one of the most universal and documented language. Howhever it is not always easy to use. It’s why Pulsion provides functions and conventions in top of bash that transform it in a smart language.
  • Gather all your projects in one place : Front, back, database, deployment in one place. You can build a project hierarchy. Pulsion project can import another Pulsion project. So, you can have a unique place where all commands on a very very large project are centralized (ex: backend, frontend, database, deployment…).
  • Light and easy to export : Pulsion have no external dependencies, we just need bash (available by default on linux, osx (and windows soon)) to launch it. So, if you move your project on a new machine, import your project folder is enough to use pulsion. Install is optionnal to launch pulsion.

Install

  1. Download /bin/pulsion
  2. Move it in /usr/local/bin with execute right.
  3. Go to your project folder and execute pulsion init

Your first pulsion project is now created.

Usage

After install, you can run at the root of project :

  1. pulsion

This command list all commands availables in your current Pulsion project.

Create your own commands

You can create your own commands in pulsion/config_pulsion file and run it with pulsion command.

A Pulsion command looks like that :

  1. function command_hello { # create a hello command
  2. function help { # user can add --help or -h argument to display help
  3. echo "Example of pulsion command"
  4. }
  5. function process { # your bash script
  6. if has_param --introduce-me "$@"; then # helpers functions help you to develop faster
  7. print 1 "Hello world !"
  8. print 1 "My name is Pulsion"
  9. else
  10. print 1 "Hello world !"
  11. fi
  12. }
  13. }
  1. pulsion hello --introduce-me
  2. # Hello world !
  3. # My name is Pulsion

Create your own command with Pulsion

Pulsion for very large projects

You can import a pulsion project in another.

Imagine you have multiple pulsion projects for backend, frontend and deployment. But you need a unique place to manage all your project. So, you can just create a new pulsion project and import the three others.

Know more about Import

Helpers

Helpers are predefined functions that help you to develop your bash scripts faster and safer.

  • Generic helpers : Small easy to user functions (print, require_root, get_platform…)
  • (Alpha version) Stream helpers : Easly manage stdin and stdout feeds with filter, duplicators, actions…

Status of project

Pulsion continuous integration run on Linux but Pulsion also works on OSX (we use it everyday) and on Windows (with bash emulator).

Currently, Pulsion require Git to be updated easily. But soon, we’ll remove this dependency between Pulsion and Git. Then, the only dependency to use Pulsion will be bash (>= 3).

Note that Pulsion is under heavy development. Your issues and pull request are welcome.

Have fun !