Geordi is a collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.
gem install geordi
geordi binary holds most of the utility commands. For the few other
binaries, see the bottom of this file.
You may abbreviate commands by typing only their first letters, e.g.
geordi con will boot a development console,
geordi set -t will setup a project and
run tests afterwards.
For details on commands, e.g. supported options, you may always run
geordi help <command>.
geordi apache-site VIRTUAL_HOST
Enable the given virtual host, disabling all others.
geordi capistrano COMMAND
Run a capistrano command on all deploy targets.
geordi capistrano deploy
Remove unneeded files from the current directory.
Commit using a story title from Pivotal Tracker.
geordi console [TARGET]
Open a Rails console locally or on a Capistrano deploy target.
Open a local Rails console:
Open a Rails console on
geordi console staging
geordi cucumber [FILES and OPTIONS]
Run Cucumber features.
geordi cucumber features/authentication_feature:3
Runs Cucumber as you want: with
bundle exec, using parallel tests, with
a VNC session holding Selenium test browsers, support for using a dedicated
testing firefox and beta support for rerunning failed scenarios.
@solo: Generally, features are run in parallel. However, scenarios tagged with @solo are excluded and will be run sequentially, after the parallel run.
Debugging: Sometimes, the dot-printing Cucumber formatter does not show errors. In case a feature fails without a message, try running it with
Options: Any unknown option will be passed through to Cucumber, but you need to use an
=instead of a space to separate parameter name and value, e.g.
geordi delete_dumps [DIRECTORY]
Delete database dump files (
geordi delete_dumps or
geordy delete_dumps ~/tmp/dumps
Recursively search for files ending in
*.dump and offer to delete those. When
no argument is given, two default directories are searched for dump files: the
current working directory and
~/dumps (for dumps created with geordi).
Geordi will ask for confirmation before actually deleting files.
geordi deploy [STAGE]
Guided deployment across branches.
geordi deploy or
geordi deploy p[roduction]
Merge, push and deploy with a single command! There are several scenarios where this command comes in handy:
Production deploy: From the master branch, run
geordi deploy production. This will merge
production, push and deploy to production.
Feature branch deploy: From a feature branch, run
geordi deploy staging. This will merge the feature branch to
master, push and deploy to staging.
Simple deploy: If the source branch matches the target branch, merging will be skipped.
Calling the command without arguments will infer the target stage from the current branch and fall back to master/staging.
Finds available Capistrano stages by their prefix, e.g.
geordi deploy p will
geordi deploy mak will deploy a
makandra stage if there
is a file config/deploy/makandra.rb.
When your project is running Capistrano 3, deployment will use
cap deploy:migrations. You can force using
deploy by passing the
geordi deploy -M staging.
Delete local MySQL/MariaDB and Postgres databases that are not whitelisted.
Check both MySQL/MariaDB and Postgres on the machine running geordi for databases and offer to delete them. Excluded are databases that are whitelisted. This comes in handy when you're keeping your currently active projects in the whitelist files and perform regular housekeeping with Geordi.
When called with
-M options, only handles Postgres resp. MySQL/MariaDB.
When called with
--postgres <port or local socket> or
--mysql <port or local socket>,
will instruct the underlying management commands to use those connection methods
instead of the defaults. This is useful when running multiple installations.
Geordi will ask for confirmation before actually dropping databases and will offer to edit the whitelist instead.
geordi dump [TARGET]
Handle dumps (see
geordi help dump for details).
When called without arguments, dumps the development database with
When called with the
--load option, sources the specified dump into the
geordi dump -l tmp/staging.dump
When called with a capistrano deploy target (e.g.
staging), remotely dumps
the specified target's database and downloads it to
geordi dump staging
When called with a capistrano deploy target and the
--load option, sources the
dump into the development database after downloading it.
geordi dump staging -l
geordi firefox COMMAND
Run a command with VNC and test browser set up (alias: chrome).
geordi firefox b cucumber or
geordi firefox --setup 24.0
Useful when you need Firefox for Selenium or the VNC set up, but can't use the
geordi cucumber command.
Install a special Firefox by calling with
This command is aliased
chrome for users running Selenium in Chrome.
geordi help [COMMAND]
Describe available commands or one specific command.
Migrate all databases.
If you are using
parallel_tests, this runs migrations in your development
rake parallel:prepare afterwards. Otherwise, invokes
geordi png-optimize PATH
Optimize .png files.
geordi png-optimize some/directory
- Removes color profiles: cHRM, sRGB, gAMA, ICC, etc.
- Eliminates unused colors and reduces bit-depth (if possible)
- May reduce PNG file size lossless
geordi rake TASK
Run a rake task in several Rails environments.
geordi rake db:migrate
TASK is run in the following Rails environments (if present):
Remove executable-flags from files that should not be executable.
geordi rspec [FILES]
geordi rspec spec/models/user_spec.rb:13
Runs RSpec as you want: with RSpec 1/2 detection,
bundle exec, rspec_spinner
geordi security-update [STEP]
Support for performing security updates.
Preparation for security update:
After performing the update:
geordi security-update finish
Switches branches, pulls, pushes and deploys as required by our workflow. Tells what it will do before it does it.
geordi server [PORT]
Start a development server.
Setup a project for the first time.
Check out a repository, cd into its directory. Now let
setup do the tiring
bundle install, create
database.yml, create databases, migrate
(all if applicable).
After setting up, loads a dump into the development db when called with the
geordi setup -d staging
After setting up, runs all tests when called with the
geordi setup -t
geordi help setup for details.
geordi shell TARGET
Open a shell on a Capistrano deploy target.
geordi shell production
Lets you select the server to connect to when called with
geordi shell production -s
Run all employed tests.
Bring a project up to date.
bundle install (if necessary) and migrates (if applicable).
After updating, loads a dump into the development db when called with the
geordi update -d staging
After updating, runs all tests when called with the
geordi update -t
geordi help update for details.
Print the current version of geordi.
Show the hidden VNC window.
geordi vnc or
geordi vnc --setup
Launch a VNC session to the hidden screen where
geordi cucumber runs Selenium
When called with
--setup, will guide through the setup of VNC.
Runs the given command under
bundle exec if a
Gemfile is present in your
working directory. If no
Gemfile is present just runs the given command:
b spec spec/models
More information at http://makandracards.com/makandra/684-automatically-run-bundle-exec-if-required
Stores a timestamped database dump for the given Rails environment in
More information at http://makandracards.com/makandra/1008-dump-your-database-with-dumple
Used by the
geordi cucumber command. Makes launchy open pages in the user's
browser, as opposed to opening it within the VNC window.
edit it to do what you need it to do. Usually, it is hard to automatedly test
Geordi commands, so make sure you've manually tested it. You can do so by
calling your local geordi like so (adjust paths to your needs):
# @option -I: add directory to load path ruby -I ../geordi/lib ../geordi/bin/geordi <command>
Don't forget to update this README. The whole
geordi section is auto-generated
Geordi is (partially) tested with Cucumber and Aruba. Run all tests with
Of course you're free to use
geordi tests ;)
Note that Geordi still needs to support Ruby 1.8.7, so make sure you only use syntax that was valid back then (e.g. the :old => hash syntax). Unfortunately, it is really hard to get Geordi's tests running on 1.8.7, so you need to make sure it runs on 1.8.7 manually.