2016-08-17 14:56:06 +00:00
## Realize
2016-08-21 12:23:28 +00:00
2017-11-05 21:39:30 +00:00
[](https://godoc.org/github.com/tockins/realize)
[](https://travis-ci.org/tockins/realize)
[](https://raw.githubusercontent.com/tockins/realize/v1/LICENSE)
[](https://github.com/tockins/realize-examples)
[](https://gitter.im/tockins/realize?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
[](https://goreportcard.com/report/github.com/tockins/realize)
[](#backers)
[](#sponsors)
2016-08-23 19:54:39 +00:00
2017-08-08 15:19:24 +00:00
< p align = "center" >
2017-08-08 15:17:52 +00:00
< img src = "http://i.imgur.com/pkMDtrl.png" width = "350px" >
2017-08-08 15:19:24 +00:00
< / p >
2016-08-18 08:10:59 +00:00
2017-08-08 22:24:56 +00:00
#### Realize is the Go tool that is focused to speed up and improve developers workflow.
2016-08-18 08:10:59 +00:00
2017-08-11 19:00:56 +00:00
Automate the most recurring operations needed for development, define what you need only one time, integrate additional tools of third party, define custom cli commands and reload projects at each file change without stop to write code.
Various operations can be programmed for each project, which can be executed at startup, at stop, and at each file change.
2016-07-24 23:02:18 +00:00
2017-08-08 22:06:30 +00:00
< p align = "center" >
< img src = "http://i.imgur.com/KpMSLnE.png" >
< / p >
2016-08-17 23:08:10 +00:00
2017-11-05 21:39:30 +00:00
#### Content
2017-08-11 19:48:54 +00:00
2017-08-11 19:50:19 +00:00
- [Features list ](#features )
2017-11-05 21:39:30 +00:00
- [Get started ](#get-started )
2017-08-11 19:48:54 +00:00
- [Config sample ](#config-sample ) - Sample config file
- [Run cmd ](#run ) - Run a project
- [Add cmd ](#add ) - Add a new project
- [Init cmd ](#init ) - Make a custom config step by step
- [Remove cmd ](#remove ) - Remove a project
- [List cmd ](#list ) - List the projects
- [Support ](#support-us-and-suggest-an-improvement )
- [Backers and Sponsors ](#backers )
2016-08-17 19:34:20 +00:00
#### Features
2017-08-11 19:00:56 +00:00
- Two watcher types: file system and polling
- Logs and errors files
- Projects setup step by step
- After/Before custom commands
- Custom environment variables
- Multiple projects at the same time
- Custom arguments to pass at each project
- Docker support (only with polling watcher)
- Live reload on file change (extensions and paths customizable)
- Support for most go commands (install, build, run, vet, test, fmt and much more)
- Web panel for a smart control of the workflow
2017-03-13 00:04:58 +00:00
2017-10-08 21:09:45 +00:00
Next features and informations
2017-04-01 21:32:40 +00:00
2017-10-16 20:37:50 +00:00
- [ ] More use cases
- [ ] Complete tests
2017-08-08 15:13:35 +00:00
- [ ] Watch gopath dependencies
- [ ] Web panel, download logs
- [ ] Multiple configurations (dev, production)
- [ ] Support to ignore paths and files in gititnore
2017-10-16 20:37:50 +00:00
- [ ] Input redirection (wait for an input and redirect) useful for cli scripts
2017-04-01 21:32:40 +00:00
2017-11-05 21:39:30 +00:00
#### Get started
Run this to get and install:
2017-03-13 00:04:58 +00:00
```
$ go get github.com/tockins/realize
```
2017-08-11 19:00:56 +00:00
#### Commands available
2017-03-13 00:04:58 +00:00
2017-04-01 18:37:50 +00:00
- ##### Run
2017-04-01 18:42:33 +00:00
From project/projects root execute:
```
2017-10-16 20:37:50 +00:00
$ realize start
2017-04-01 18:42:33 +00:00
```
2017-10-16 20:37:50 +00:00
It will create a realize.yaml file if it doesn't exist already, add the working directory as project and run your workflow.
2017-04-01 18:42:33 +00:00
2017-10-16 20:37:50 +00:00
"Start" command supports the following custom parameters:
2017-04-01 18:42:33 +00:00
```
2017-06-19 11:29:47 +00:00
--name="name" -> Run by name on existing configuration
2017-04-01 18:42:33 +00:00
--path="realize/server" -> Custom Path, if not specified takes the working directory name
2017-10-08 21:09:45 +00:00
--generate -> Enable go generate
--fmt -> Enable go fmt
--test -> Enable go test
2017-10-16 20:37:50 +00:00
--vet -> Enable go vet
2017-10-08 21:09:45 +00:00
--install -> Enable go install
2017-04-01 18:42:33 +00:00
--build -> Enable go build
2017-10-08 21:09:45 +00:00
--run -> Enable go run
2017-04-01 18:42:33 +00:00
--server -> Enable the web server
2017-10-08 21:09:45 +00:00
--no-config -> Ignore an existing config / skip the creation of a new one
2017-04-01 18:42:33 +00:00
```
Examples:
```
2017-10-16 20:37:50 +00:00
$ realize start
$ realize start --path="mypath"
$ realize start --name="realize" --build
$ realize start --path="realize" --run --no-config
$ realize start --install --test --fmt --no-config
$ realize start --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"
2017-04-01 18:42:33 +00:00
```
If you want, you can specify additional arguments for your project.
**The additional arguments must go after the params**
2017-10-16 20:37:50 +00:00
**Start command can be used with a project from its working directory without make a config file (--no-config).**
2017-04-01 18:42:33 +00:00
```
2017-10-16 20:37:50 +00:00
$ realize start --path="/print/printer" --run yourParams --yourFlags // right
$ realize start yourParams --yourFlags --path="/print/printer" --run // wrong
2017-04-01 18:42:33 +00:00
```
2017-04-01 18:37:50 +00:00
- ##### Add
2017-10-16 20:37:50 +00:00
Add a project to an existing config file or create a new one.
2017-04-01 18:42:33 +00:00
2017-10-16 20:37:50 +00:00
"Add" supports the same parameters of "Start" command.
2017-04-01 18:42:33 +00:00
```
$ realize add
```
2017-03-13 00:04:58 +00:00
2017-04-01 18:37:50 +00:00
- ##### Init
2017-04-01 18:42:33 +00:00
Like add, but with this command you can create a configuration step by step and customize each option.
2017-10-16 20:37:50 +00:00
**Init is the only command that supports a complete customization of all supported options**
2017-04-01 18:42:33 +00:00
```
$ realize init
```
2017-03-13 00:11:05 +00:00
2017-04-01 18:37:50 +00:00
- ##### Remove
2017-04-01 18:42:33 +00:00
Remove a project by its name
```
$ realize remove --name="myname"
```
2017-03-13 00:04:58 +00:00
2017-04-01 18:37:50 +00:00
- #### Color reference
2017-04-01 18:42:33 +00:00
- Blue: outputs of the project
- Red: errors
- Magenta: times or changed files
- Green: successfully completed action
2016-08-24 15:50:52 +00:00
2017-04-01 18:37:50 +00:00
- #### Config sample
2017-04-01 18:42:33 +00:00
For more examples check [Realize Examples ](https://github.com/tockins/realize-examples )
2017-08-08 21:05:27 +00:00
```
settings:
2017-10-16 20:37:50 +00:00
legacy:
force: true // force polling watcher instead fsnotifiy
interval: 100ms // polling interval
resources: // files names
outputs: outputs.log
logs: logs.log
errors: errors.log
server:
status: false // server status
open: false // open browser at start
host: localhost // server host
port: 5001 // server port
schema:
2017-08-08 21:05:27 +00:00
- name: coin
path: coin // project path
2017-08-11 19:00:56 +00:00
environment: // env variables available at startup
2017-10-16 20:37:50 +00:00
test: test
myvar: value
2017-08-11 19:00:56 +00:00
commands: // go commands supported
2017-10-16 20:37:50 +00:00
vet:
status: true
fmt:
status: true
args:
- -s
- -w
test:
status: true
method: gb test // support differents build tool
generate:
status: true
install:
status: true
2017-08-08 21:05:27 +00:00
build:
2017-10-16 20:37:50 +00:00
status: false
method: gb build // support differents build tool
args: // additional params for the command
2017-08-08 21:05:27 +00:00
- -race
run: true
2017-10-16 20:37:50 +00:00
args: // arguments to pass at the project
- --myarg
2017-08-08 21:05:27 +00:00
watcher:
2017-10-16 20:37:50 +00:00
preview: false // watched files preview
paths: // watched paths
- /
ignore_paths: // ignored paths
- vendor
extensions: // watched extensions
- go
- html
scripts: // custom scripts
- type: before // type (after/before)
command: ./ls -l // command
changed: true // relaunch when a file change
startup: true // launch at start
- type: after
command: ./ls
changed: true
errorOutputPattern: mypattern //custom error pattern
```
2017-08-08 22:06:30 +00:00
2017-08-05 14:03:43 +00:00
#### Support us and suggest an improvement
2016-08-21 15:17:25 +00:00
- Chat with us [Gitter ](https://gitter.im/tockins/realize )
2017-04-01 18:42:33 +00:00
- Suggest a new [Feature ](https://github.com/tockins/realize/issues/new )
2017-08-10 12:02:50 +00:00
2017-08-10 12:11:59 +00:00
#### Backers
2017-08-10 12:02:50 +00:00
Support us with a monthly donation and help us continue our activities. [[Become a backer ](https://opencollective.com/realize#backer )]
< a href = "https://opencollective.com/realize/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/11/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/12/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/13/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/14/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/15/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/16/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/17/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/18/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/19/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/20/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/21/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/22/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/23/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/24/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/25/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/26/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/27/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/28/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/backer/29/website" target = "_blank" > < img src = "https://opencollective.com/realize/backer/29/avatar.svg" > < / a >
2017-08-10 12:11:59 +00:00
#### Sponsors
2017-08-10 12:02:50 +00:00
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor ](https://opencollective.com/realize#sponsor )]
< a href = "https://opencollective.com/realize/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/10/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/11/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/11/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/12/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/12/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/13/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/13/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/14/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/14/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/15/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/15/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/16/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/16/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/17/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/17/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/18/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/18/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/19/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/19/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/20/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/20/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/21/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/21/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/22/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/22/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/23/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/23/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/24/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/24/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/25/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/25/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/26/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/26/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/27/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/27/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/28/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/28/avatar.svg" > < / a >
< a href = "https://opencollective.com/realize/sponsor/29/website" target = "_blank" > < img src = "https://opencollective.com/realize/sponsor/29/avatar.svg" > < / a >
