Binstubs

General

The Hummingbird meta repository brings you a complete tooling and setup bundle. We don't want to bother ourselves, much less you, with setting up a development environment for too long. The most notable part of said tooling consists of binstubs located in /bin to execute common tasks without the hassle.

For easier access, you can add ./bin or/and ../bin to your $PATH, in order to use those binstubs directly from the hummingbird repository root or the client/server folder.

Binstubs

bin/address

Usage: bin/address
Will return the ip address of your local docker machine. If you are running docker natively on your machine, it will return localhost.

bin/attach

Usage: bin/attach [client, server, router, redis, sidekiq, postgres, elasticsearch]
Will attach a bash shell to the specified container.

bin/bower

Usage: bin/bower [...]
Will proxy the command you pass it to bower running in the hummingbird client container.

bin/build

Usage: bin/build []
Will build all docker containers, set up the development database and set the server environment to development.

bin/bundle

Usage: bin/bundle [...]
Will proxy the command you pass it to bundler running in the hummingbird server container.

bin/ember

Usage: bin/ember [...]
Will proxy the command you pass it to ember-cli running in the hummingbird client container.

bin/guard

tba

bin/logs

Usage: bin/logs [client, server, router, redis, sidekiq, postgres, elasticsearch] [-f]
Will output the last lines of the log from the specified container. If no argument is given, log output from all containers will be returned. You may add the -f flag, in order to follow the log for a longer time.

bin/npm

Usage: bin/npm [...]
Will proxy the command you pass it to npm running in the hummingbird client container.

bin/open-browser

Usage: bin/open-browser
Will attempt to open your browser with the host Hummingbird is currently running on. If no command is successfully executed on your system, it will return the host name.

bin/pg_dump

Usage: bin/pg_dump [...]
tba

bin/port

Usage: bin/port []
Will output the port of the router container that is currently exposed for the internal port 80.

bin/psql

Usage: bin/psql [...]
Will proxy the command you pass it to postgres running in the hummingbird server container.

bin/rails

Usage: bin/rails [...]
Will proxy the command you pass it to rails running in the hummingbird server container.

bin/rake

Usage: bin/rake [...]
Will proxy the command you pass it to rake running in the hummingbird server container.

bin/rebuild

Usage: bin/rebuild [client, server, router, redis, sidekiq, postgres, elasticsearch]
Will stop, rebuild and then start the given container. If no container is specified, all containers will be rebuilt.

bin/restart

Usage: bin/restart [client, server, router, redis, sidekiq, postgres, elasticsearch]
Will stop and restart the given container. If no container is specified, all containers will be restarted.

bin/rspec

Usage: bin/rspec [...]
Will proxy the command you pass it to rspec running in the hummingbird server container.

bin/seed

Usage: bin/seed [download, reset, import [db, posters, covers] (amount), clean]
A collection of useful tools for seeding the local development database. For more information about the usage of seed, check this wiki article.

bin/setup

Usage: bin/setup
Will run the interactive setup. This should be done right after the meta repository is cloned, as it will set up everything else.

bin/start

Usage: bin/start [client, server, router, redis, sidekiq, postgres, elasticsearch]
Will start the given container. If no container is specified, all containers will be started.

bin/status

Usage: bin/status
Will list the status of all docker container in our environment.

bin/stop

Usage: bin/stop [client, server, router, redis, sidekiq, postgres, elasticsearch]
Will stop the given container. If no container is specified, all containers will be stopped.