Skip to content

panvourtsis/gaucho

 
 

Repository files navigation

Gaucho

by @angrykoala
Build Status

Minimalistic task launcher

Gaucho Screenshot
Gaucho 0.2.0

Download

Gaucho can be downloaded here. Available versions for Linux, Mac and Windows (64 bits).

To use, unzip in the desired location and execute gaucho (execute file depends on you OS).

If you need a different version, please, follow the development instructions to make your own build from the source code

Usage

Gaucho allows you to configure tasks as part of different suites or groups you can access the different suites by clicking on its name in the navbar menu.

Executing tasks

On each suite, you will find the list of possible tasks to launch. By clicking on Run you will start that task. Clicking the same button again (now the Stop button) you can stop the tasks.

You can easily see the name, execution time and status of each task. The status (shown with the status icon) can be idle (black), running (blue), successful (green) or failed (red).

Clicking in the task name the log will be displayed, allowing you to check the task output in real time.

Creating and Editing tasks

By clicking the Edit button (on the top right corner) you'll be able to edit the suites and tasks.

You can add new tasks to the current suite by clicking "Add New Task" at the bottom of the list. By clicking on a task name you'll be able to edit that task.

While editing/creating a new tasks, you should add a name to the task and a command. The command can be any shell/terminal accepted command or an executable file. Optionally a path can be added as well, if no path is added, the gaucho execution path will be used.

The tasks can be deleted by clicking the Delete button.

Keep in mind that you won't be able to run new tasks in edit mode

While in edit mode, suites names can also be changed by clicking on it. To close edit mode simply click again on the edit button.

Menu

Next to the edit button, is the menu button. When clicking the menu, several options will be shown, those options may change if the edit mode is active:

Normal mode

  • Run Suite: Runs all tasks in the current suite (except those already running)
  • Stop Suite: Stops all running tasks in suite

Edit mode

  • Add new Suite: Created a new suite
  • Delete Suite: Deletes current suite

Other menus

  • Configuration: Will show the configuration menu
  • About: Some information about Gaucho such as the version you are running

User and Tasks Configuration

All tasks and user changes are saved automatically when closing gaucho. This includes all the tasks/suites information as well as the window size.

Development

If you want to contribute to Gaucho, create a new different version of Gaucho, or compile it from source code, follow these instructions.

Clone/download source code from the github repo. Make sure you have node and npm already installed in your system:

  1. npm install to install electron and all the dependencies.
  2. npm start to start gaucho.
    • npm run start-dev to run gaucho with chrome dev tools enabled.
  3. npm run build-electron to build gaucho for your system (build will be placed in builds folder).
    • npm run build-electron-all to make builds for windows, linux and mac.
  4. npm test to run the automated tests.
    • Please, ensure the tests are passing before creating a pull requests. Add tests for your changes.

Acknowledgments

License

Gaucho is being developed and maintained as Open-Source software by @angrykoala (https://github.com/angrykoala) licensed under GNU GENERAL PUBLIC LICENSE version 3

The original source code can be found at: https://github.com/angrykoala/gaucho

Packages

No packages published

Languages

  • JavaScript 87.0%
  • CSS 9.9%
  • HTML 3.1%